docs: add README.md, version, help

2026-05-18 01:39:04 +00:00 · 2025-09-19 14:28:24 +03:00
parent e2e98e4b09
commit 96be3af03d
6 changed files with 300 additions and 2 deletions
--- a/.prettierrc
+++ b/.prettierrc
@@ -0,0 +1,15 @@
+{
+  "printWidth": 100,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 100,
+        "proseWrap": "always"
+      }
+    }
+  ]
+}
--- a/121
+++ b/121
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
--- a/README.md
+++ b/README.md
@@ -0,0 +1,127 @@
+# vstask
+
+**`vstask`** is a tiny, cross-platform runner for **VS Code `tasks.json`** written in **Go**. It
+discovers your project’s `.vscode/tasks.json`, resolves VS Code variables, respects platform
+overrides, and executes tasks—**including dependencies in sequence or in parallel**—with proper
+signal handling and process-tree cleanup.
+
+![Release](https://img.shields.io/github/v/release/chenasraf/vstask)
+![Downloads](https://img.shields.io/github/downloads/chenasraf/vstask/total)
+![License](https://img.shields.io/github/license/chenasraf/vstask)
+
+---
+
+## 🚀 Features
+
+- **Zero-config**: auto-discovers `.vscode/tasks.json` from your project tree.
+- **VS Code semantics**:
+  - Platform overrides (`windows`/`osx`/`linux`)
+  - `type: shell` / `type: process`
+  - `dependsOn` with **sequence** or **parallel** execution
+  - Built-in **variable substitutions** (e.g., `${workspaceFolder}`, `${userHome}`, `${cwd}`, etc.).
+
+- **Robust execution**:
+  - Correct shell invocation (`/bin/sh -c` or `cmd.exe /C` by default)
+  - Well-formed quoting for args while leaving command strings verbatim (so `$(...)`, pipes, etc.
+    work)
+  - **Signal trapping** (CTRL-C) and **process-group kill** on Unix; `taskkill /T /F` on Windows
+  - Proper working-directory resolution with relative paths
+
+---
+
+## 🎯 Installation
+
+### Download Precompiled Binaries
+
+Grab the latest release for **Linux**, **macOS**, or **Windows**:
+
+- [Releases →](https://github.com/chenasraf/vstask/releases/latest)
+
+### Homebrew (macOS/Linux)
+
+Install from your tap:
+
+```bash
+brew install chenasraf/tap/vstask
+```
+
+> If you already use your tap for other tools, `brew update` first.
+
+### From Source
+
+```bash
+git clone https://github.com/chenasraf/vstask
+cd vstask
+go build ./...
+```
+
+---
+
+## ✨ Getting Started
+
+Place a `tasks.json` under `.vscode/` in your repo. Example:
+
+```jsonc
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "my-command",
+      "type": "shell",
+      "command": "echo \"it works!\"",
+      "dependsOn": ["dep-a", "dep-b"],
+      "dependsOrder": "parallel",
+      "problemMatcher": []
+    },
+    {
+      "label": "dep-a",
+      "type": "shell",
+      "command": "echo \"running dep-a\"",
+      "problemMatcher": []
+    },
+    {
+      "label": "dep-b",
+      "type": "shell",
+      "command": "echo \"running dep-b\"",
+      "problemMatcher": []
+    }
+  ]
+}
+```
+
+### Run a task (CLI)
+
+> If your CLI exposes `run` and `list` commands; adjust if your binary uses a different interface.
+
+```bash
+# list tasks and select from the list
+vstask
+
+# run one by label
+vstask my-command
+```
+
+---
+
+## 🛠️ Contributing
+
+I am developing this package on my free time, so any support, whether code, issues, or just stars is
+very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate
+just a small amount to help sustain this project, I would be very very thankful!
+
+<a href='https://ko-fi.com/casraf' target='_blank'>
+<img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3' alt='Buy Me a Coffee at ko-fi.com' />
+</a>
+
+I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
+don't hesitate to open an appropriate issue and I will do my best to reply promptly.
+
+---
+
+## 📜 License
+
+`vstask` is licensed under the [CC0-1.0 License](/LICENSE).
+
+---
+
+Happy tasking! 🧰✨
--- a/main.go
+++ b/main.go
@@ -1,19 +1,30 @@
 package main

 import (
+	_ "embed"
 	"fmt"
 	"os"
+	"strings"

 	"github.com/chenasraf/vstask/runner"
 	"github.com/chenasraf/vstask/tasks"
+	"github.com/chenasraf/vstask/utils"
 	"github.com/samber/lo"
 )

+//go:embed version.txt
+var appVersion []byte // appVersion is embedded from version.txt and contains the application version.
+
 func main() {
+	utils.SetVersion(strings.TrimSpace(string(appVersion)))
 	args := os.Args[1:]
 	if len(args) > 0 {
-		if args[0] == "--help" || args[0] == "-h" {
-			// PrintHelp()
+		switch args[0] {
+		case "--help", "-h":
+			utils.PrintHelp()
+			os.Exit(0)
+		case "-v", "--version":
+			utils.PrintVersion()
 			os.Exit(0)
 		}
 		taskList, err := tasks.GetTasks()
--- a/utils/help.go
+++ b/utils/help.go
@@ -0,0 +1,23 @@
+package utils
+
+import (
+	"fmt"
+)
+
+func PrintHelp() {
+	fmt.Println("Usage: vstask [task-name]")
+	fmt.Println("Options:")
+	fmt.Println("  -h, --help         Show this help message")
+}
+
+func PrintVersion() {
+	fmt.Println(AppVersion)
+}
+
+// AppVersion is the current version of the application.
+var AppVersion string
+
+// SetVersion sets the application version.
+func SetVersion(v string) {
+	AppVersion = v
+}
--- a/version.txt
+++ b/version.txt
@@ -0,0 +1 @@
+0.0.0