chore(watch): setup yarn watch for dev (#35)

* chore(watch): setup `yarn watch` for dev

* docs: update readme example path

* ci(test): fix artifacts path

Author: fu050409

.github/workflows/test.yml

@@ -209,7 +209,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-${{ matrix.settings.target }}
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -239,7 +239,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-unknown-linux-gnu
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -271,7 +271,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-unknown-linux-musl
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -294,7 +294,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-aarch64-unknown-linux-gnu
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -328,7 +328,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-aarch64-unknown-linux-musl
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash
@@ -367,7 +367,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-armv7-unknown-linux-gnueabihf
-          path: .
+          path: ./@noctisynth/
       - name: List packages
         run: ls -R .
         shell: bash

README.md

@@ -1,15 +1,15 @@
 # archons
 
-Fast and elegant CLI build tool based on clap-rs
+Fast, powerful and elegant CLI build tool based on clap-rs
 
 ## Installation
 
 ```bash
-npm install -g clap-js
+npm install -g archons
 ```
 
 ## Usage
 
-Look at [simple.js](./simple.js) for an example.
+Look at [Examples](./examples) for an example.
 
 See [clap-rs](https://github.com/clap-rs/clap) for more information.

benchmark/bench.ts

@@ -1,19 +1,13 @@
 import { Bench } from 'tinybench'
 
-import { plus100 } from '../index.js'
-
-function add(a: number) {
-  return a + 100
-}
-
 const b = new Bench()
 
 b.add('Native a + 100', () => {
-  plus100(10)
+
 })
 
 b.add('JavaScript a + 100', () => {
-  add(10)
+
 })
 
 await b.run()

cspell.json

@@ -10,6 +10,7 @@
         "napi",
         "noctisynth",
         "oxlint",
+        "parens",
         "prebuild",
         "taplo",
         "tinybench"

examples/.gitignore

@@ -0,0 +1 @@
+*.cjs

simple.js renamed to examples/simple.cts

@@ -1,4 +1,4 @@
-const { defineCommand, run } = require('./index.js')
+import { defineCommand, run, type Context } from '../index';
 
 const dev = defineCommand({
   meta: {
@@ -12,7 +12,7 @@ const dev = defineCommand({
       default: '3000',
     },
   },
-  callback: (ctx) => {
+  callback: (ctx: Context) => {
     console.log(ctx);
   }
 })
@@ -22,7 +22,7 @@ const main = defineCommand({
     name: 'simple',
     version: '0.0.1',
     about: 'A simple command line tool',
-    alias: ['dev']
+    styled: true,
   },
   options: {
     verbose: {

examples/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+      "moduleResolution": "NodeNext",
+      "module": "NodeNext",
+      "outDir": "."
+    },
+    "include": ["."],
+    "exclude": ["index.cjs"]
+  }
+  

index.d.ts

@@ -26,7 +26,8 @@ export interface CommandMeta {
    * This is optional and can be used to display the version of the CLI
    * when the command is called with the `--version` flag or `-V` option.
    *
-   * This option will be ignored if the command is subcommand.
+   * If not provided, the CLI will not display the version and you can't
+   * call the command with the `--version` flag or `-V` option.
    */
   version?: string
   /**
@@ -35,6 +36,12 @@ export interface CommandMeta {
    * Command description will be displayed in the help output.
    */
   about?: string
+  /**
+   * Enable styled mode
+   *
+   * Determines whether the CLI output should be displayed in the styled format.
+   */
+  styled?: boolean
 }
 export interface CommandOption {
   type?: 'positional' | 'flag' | 'option'