@gutenye/script.js 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2024 Guten Ye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,35 +1,95 @@
-# 🌟 Script.js 🌟
+# 🧩 Script.js 🧩
 
-[![Stars](https://img.shields.io/github/stars/gutenye/script.js?style=social)](https://github.com/gutenye/script.js) [![NPM Version](https://img.shields.io/npm/v/@gutenye/script.js)](https://www.npmjs.com/package/@gutenye/script.js) [![License](https://img.shields.io/github/license/gutenye/script.js?color=blue)](https://github.com/gutenye/script.js/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue)](https://github.com/gutenye/script.js#-contribute)
-
-Write shell scripts in JavaScript
+**Write shell scripts in JavaScript** and leverage the power of JavaScript’s simplicity and flexibility to make your shell scripting easier and faster. Why struggle with the complexity of Bash or other shell scripting languages when you already know JavaScript? Script.js allows you to write and run complex shell scripts using JavaScript, saving you time and reducing errors.
 
 **Show your ❤️ and support by starring this project and following the author, [Guten Ye](https://github.com/gutenye)!**
 
+[![Stars](https://img.shields.io/github/stars/gutenye/script.js?style=social)](https://github.com/gutenye/script.js) [![NPM Version](https://img.shields.io/npm/v/@gutenye/script.js)](https://www.npmjs.com/package/@gutenye/script.js) [![License](https://img.shields.io/github/license/gutenye/script.js?color=blue)](https://github.com/gutenye/script.js/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue)](https://github.com/gutenye/script.js#-contribute)
+
 ## 🌟 Features
 
-- **Javascript**: ..
-- **Autocomplete**: .. 
-- **Fast**: ..
+- **Fast to write**: The most important factor in script writing is **speed**. With Script.js, you can quickly open the editor, write a few lines of code, and run it instantly. Thanks to global commands, you don’t need to worry about import statements, and more. Writing a script is enjoyable and efficient.
+- **Fun to run**: A major benefit of using a script is **autocompletion**. Script.js includes built-in autocompletion support. Running a script is fun and seamless.
+- **JavaScript Power**: Writing complex scripts in JavaScript and access the entire JavaScript ecosystem.
+- **Familiar Syntax**: Write your shell commands just like you would in Bash, with full support for redirection, pipes, environment variables, and more.
+- **Subcommands**: Create and organize subcommands effortlessly.
+- **Help Documentation**: Auto-generate command help documentation for better user experience.
+- **Fast Execution**: Fast to execute your scripts.
+
+## 🚀 Getting Started
+
+### 1️⃣ Install
+
+First, make sure [Bun](https://bun.sh) and [Carapace](https://github.com/carapace-sh/carapace-bin) are installed.
+
+To install Script.js, run:
+
+```sh
+npm install -g @gutenye/script.js
+```
+
+### 2️⃣ Write Your First Script
+
+Create a file named `hello.js` and add the following code:
+
+```ts
+#!/usr/bin/env script.js
+
+app
+  .name('hello.js')
+  .enableCompletion()
+
+app.command('greetings [files...]')
+  .completion({
+    positionalany: ['$files'],
+  })
+  .action((files, options) => {
+    $`
+      ls -l ${files}
+      echo ${files} | wc -l
+    `
+  })
+```
+
+### 3️⃣ Run the script
+
+You can use `<Tab>` to autocomplete arguments or options while using the script.
+
+```sh
+chmod +x hello.js   # Make the script executable
+./hello.js          # First run to create completion file
+./hello.js <Tab>    # Use Tab key for autocompletion
+```
 
 ## 📖 Documentation
 
-- [Getting Started](./docs/Getting%20Started.md)
-- [Completion](./docs/Completion.md)
+- [Create Commands](./docs/Create%20Commands.md): Create commands and subcommands
+- [Completion](./docs/Completion.md): Customize the autocompletion
+- [Global Commands](./docs/Global%20Commands.md): List of global variables and commands
+
+## 🙇 Thanks
+
+- [Bun](https://github.com/oven-sh/bun): Incredibly fast JavaScript runtime, bundler, test runner, and package manager – all in one
+- [Carapace](https://github.com/carapace-sh/carapace-bin): A multi-shell completion binary
+- [Zurk](https://github.com/webpod/zurk): A generic process spawner
+- [Zx](https://github.com/google/zx): A tool for writing better scripts
+- [Commander.js](https://github.com/tj/commander.js): node.js command-line interfaces made easy
 
 ## 🤝 Contribute
 
-We welcome contributions from the community! Whether it’s reporting bugs, suggesting features, or submitting pull requests, your help is appreciated.
+We love contributions! Whether you’re fixing bugs, adding features, or improving documentation, your involvement makes this project better.
+
+**How to Contribute:**
 
 1. Fork the Repository
 2. Open a Pull Request on Github
 
 ---
 
-Thank you for using Script.js! 🔐 ✨ If you found it helpful, please ⭐️ star the project ️️⭐ on GitHub. If you have any questions or encounter issues, please refer to the documentation or report an issue on GitHub.
+Thank you for using Script.js! If you found it helpful, please ⭐️ star the project ️️⭐ on GitHub. If you have any questions, encounter issues, please refer to the documentation or report an issue on GitHub.
 
-**Thanks to all the people who contribute:**
+**Special Thanks to All Contributors:**
 
 [![](https://contrib.rocks/image?repo=gutenye/script.js)](https://github.com/gutenye/script.js/graphs/contributors)
 
-[⬆ Back to top ⬆](#readme)
+[⬆ Back to top ⬆](#readme)

package/package.json

@@ -1,19 +1,12 @@
 {
   "name": "@gutenye/script.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Write shell scripts in JavaScript",
   "keywords": [
     "shell",
     "script",
     "bash",
-    "bin",
-    "binary",
-    "child",
-    "process",
     "exec",
-    "execute",
-    "invoke",
-    "call",
     "spawn",
     "zx",
     "bunshell"
@@ -28,19 +21,18 @@
     "!**/__tests__"
   ],
   "bin": {
-    "gutenye-script.js": "src/script.ts"
+    "script.js": "src/script.ts"
   },
   "scripts": {
     "test": "bun test",
     "lint": "biome check --fix",
-    "lint:ci": "biome ci --reporter=github",
-    "build": "rm -rf build; tsc --project tsconfig.build.json; tsc-alias --project tsconfig.build.json"
+    "lint:ci": "biome ci --reporter=github"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@gutenye/commander-completion-carapace": "^1.0.3",
+    "@gutenye/commander-completion-carapace": "^1.0.9",
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
     "csv-parse": "^5.5.6",
@@ -54,7 +46,7 @@
     "typescript": "^5.7.2"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.4",
+    "@biomejs/biome": "^1.9.4",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/bun": "latest",

package/src/app.ts

@@ -9,7 +9,7 @@ app.Option = Option
 
 export async function start() {
   if (!scriptPath) {
-    echo('Error: missing script path, usage: gutenye-script.js <script>')
+    echo('Error: missing script path, usage: script.js <script>')
     process.exit(1)
   }
 

package/src/command.ts

@@ -16,7 +16,7 @@ export class Command extends BaseCommand {
     }
   }
 
-  actionLinux(fn) {
+  actionLin(fn) {
     this._actionLinux = fn
     this._actionOS()
     return this

package/src/fileSystem.ts

@@ -1,6 +1,6 @@
-import { fs } from '#/utils'
+import { fs, path } from '#/utils'
 
-export { fs }
+export { fs, path }
 
 export const cp = fs.copy
 

package/src/script.ts

@@ -4,7 +4,7 @@ import 'zx/globals'
 
 // Variables
 globalThis.HOME = os.homedir()
-globalThis.PWD = process.cwd()
+globalThis.CWD = process.cwd()
 globalThis.ENV = process.env
 
 // App
@@ -25,11 +25,10 @@ globalThis.$l = $l
 import { exitWithError } from './exit'
 globalThis.exitWithError = exitWithError
 
-globalThis.mixins = mixins
-
 // Filesystem
-import { fs, cp, ls, mkdir, mv, rm } from './fileSystem'
+import { fs, path, cp, ls, mkdir, mv, rm } from './fileSystem'
 globalThis.fs = fs
+globalThis.path = path
 globalThis.cp = cp
 globalThis.mv = mv
 globalThis.rm = rm
@@ -50,4 +49,7 @@ globalThis.colors = colors
 import * as csv from './csv'
 globalThis.csv = csv
 
+import * as yaml from './yaml'
+globalThis.yaml = yaml
+
 start()

package/src/utils/index.ts

@@ -1 +1,2 @@
 export { default as fs } from './fs'
+export { default as path } from './path'

package/src/utils/path.ts

@@ -0,0 +1,54 @@
+import nodePath from 'node:path'
+import fs from './fs'
+
+// suffix name
+// a.js -> a-suffix.js
+function nameAddSuffix(path: string, suffix: string) {
+  const { dir, name, ext } = nodePath.parse(path)
+  return nodePath.join(dir, `${name}${suffix}${ext}`)
+}
+
+// replace name
+// a.js -> name.js
+function replaceName(path: string, name: string) {
+  const { dir, ext } = nodePath.parse(path)
+  return nodePath.join(dir, `${name}${ext}`)
+}
+
+// replace ext
+// a.js -> a.py
+function replaceExt(path: string, newExt: string) {
+  const { dir, name } = nodePath.parse(path)
+  return nodePath.join(dir, `${name}.${newExt}`)
+}
+
+/**
+ * If path exists, return a new path with a number appended to it.
+ */
+async function genUniquePath(path: string): Promise<string> {
+  const { dir, name, ext } = nodePath.parse(path)
+  let newPath = path
+  let index = 1
+  while (await fs.pathExists(newPath)) {
+    newPath = nodePath.join(dir, `${name} (${index})${ext}`)
+    index++
+  }
+  return newPath
+}
+
+/*
+ * Check path has ext
+ */
+function hasExt(path: string, exts: string[]) {
+  const ext = nodePath.extname(path).slice(1)
+  return exts.includes(ext)
+}
+
+export default {
+  ...nodePath,
+  nameAddSuffix,
+  replaceName,
+  replaceExt,
+  genUniquePath,
+  hasExt,
+}

package/src/yaml.ts

@@ -0,0 +1,34 @@
+import { merge as mergeObject } from 'lodash-es'
+import Yaml from 'yaml'
+import { fs } from '#/utils'
+
+export const parse = Yaml.parse
+
+export const stringify = Yaml.stringify
+
+export async function readFile(path: string) {
+  const text = (await fs.inputFile(path, 'utf8')) as string
+  if (!text) {
+    throw new Error(`input file not found: ${path}`)
+  }
+  return Yaml.parse(text)
+}
+
+export async function writeFile(path: string, data: any) {
+  const text = Yaml.stringify(data)
+  await fs.outputFile(path, text)
+}
+
+export async function mergeFiles(inputPaths: string[], outputPath: string) {
+  const outputObject = {}
+  for (const inputPath of inputPaths) {
+    const text = (await fs.inputFile(inputPath, 'utf8')) as string
+    if (!text) {
+      throw new Error(`input file not found: ${inputPath}`)
+    }
+    const object = Yaml.parse(text)
+    mergeObject(outputObject, object)
+  }
+  const outputText = Yaml.stringify(outputObject)
+  await fs.outputFile(outputPath, outputText)
+}