docs: add examples

examples/README.md

@@ -0,0 +1,5 @@
+# citty examples
+
+In this directory you can find some examples of how to use citty.
+
+To learn more, you can read the [citty first hand tutorial on unjs.io](https://unjs.io/resources/learn/citty-101-first-hand).

examples/cleanup-commands.ts

@@ -0,0 +1,31 @@
+import { run } from "node:test";
+import { defineCommand, runMain } from "citty";
+
+const log = defineCommand({
+  meta: {
+    name: "log",
+    description: "Log a message",
+  },
+  run() {
+    console.log("Log");
+  }
+});
+
+const main = defineCommand({
+  meta: {
+    name: "cleanup",
+    description: "Cleanup your command after running it",
+  },
+  // Run after main or sub commands
+  cleanup(ctx) {
+    console.log("Cleanup", ctx); // Access to args, meta, etc.
+  },
+  // subCommands: {
+  //   log,
+  // },
+  run() {
+    console.log("Main");
+  }
+})
+
+runMain(main);

examples/hello-world.ts

@@ -0,0 +1,14 @@
+import { defineCommand, runMain } from 'citty'
+
+const main = defineCommand({
+  meta: {
+    name: 'hello-world',
+    version: '1.0.0',
+    description: 'The most basic command ever',
+  },
+  run() {
+    console.log('Hello World!')
+  }
+})
+
+runMain(main)

examples/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "examples",
+  "dependencies": {
+    "citty": "workspace:../src"
+  },
+  "devDependencies": {
+    "jiti": "^1.19.3"
+  }
+}

examples/setup-command.ts

@@ -0,0 +1,27 @@
+import { defineCommand, runMain } from "citty";
+
+const log = defineCommand({
+  meta: {
+    name: "log",
+    description: "Log a message",
+  },
+  run() {
+    console.log("Log");
+  }
+});
+
+const main = defineCommand({
+  meta: {
+    name: "setup",
+    description: "Setup your command before running it",
+  },
+  // Run before main or sub commands
+  setup(ctx) {
+    console.log("Setup", ctx); // Access to args, meta, etc.
+  },
+  subCommands: {
+    log,
+  }
+})
+
+runMain(main);

examples/sub-commands.ts

@@ -0,0 +1,23 @@
+import { defineCommand, runMain } from "citty";
+
+const log = defineCommand({
+  meta: {
+    name: "log",
+    description: "Log a message",
+  },
+  run() {
+    console.log("Log");
+  }
+});
+
+const main = defineCommand({
+  meta: {
+    name: "sub-commands",
+    description: "Example of sub-commands",
+  },
+  subCommands: {
+    log,
+  }
+});
+
+runMain(main);

package.json

@@ -22,8 +22,8 @@
   "scripts": {
     "build": "unbuild",
     "dev": "vitest dev",
-    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test",
-    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test -w",
+    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test playground examples",
+    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test playground examples -w",
     "prepack": "pnpm run build",
     "play": "jiti ./playground/cli.ts",
     "release": "pnpm test && changelogen --release --push && npm publish",
@@ -46,4 +46,4 @@
     "vitest": "^0.34.3"
   },
   "packageManager": "[email protected]"
-}
+}

playground/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "playground",
+  "dependencies": {
+    "citty": "workspace:../src"
+  }
+}

pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+packages:
+  - 'playground'
+  - 'src'
+  - 'examples'