create-avi 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Christopher Robin Chase
+
+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,3 +1,23 @@
-# Temporary Holding Version
+# create-avi
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Creates an [Avi.js](https://github.com/chrischase011/avi-js) project.
+
+```sh
+npm create avi@latest my-app
+npm create avi@latest my-app -- --template minimal
+```
+
+Without a name, it asks for the name and the template. It runs `avi new` from
+[`@avijs/cli`](https://www.npmjs.com/package/@avijs/cli), so the options are the same: `--template
+modular|minimal` and `--dir`.
+
+Then:
+
+```sh
+cd my-app
+npm install
+npm run dev
+```
+
+See the [tutorial](https://github.com/chrischase011/avi-js/blob/main/docs/tutorial/README.md) to
+get started. Requires Node.js 22.12 or newer. MIT licensed.

package/dist/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}

package/dist/bin.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { create } from './index.js';
+process.exitCode = await create(process.argv.slice(2));
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,OAAO,CAAC,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/** Asks a question and returns the answer, or `fallback` for an empty one. */
+export type Ask = (question: string, fallback: string) => Promise<string>;
+/**
+ * `avi new` for `npm create avi`. Asks for the project name and template when they are missing
+ * and `ask` is given; by default it asks only in an interactive terminal.
+ */
+export declare function create(argv: readonly string[], ask?: Ask | undefined): Promise<number>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,8EAA8E;AAC9E,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAE1E;;;GAGG;AACH,wBAAsB,MAAM,CAC1B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,GAAG,GAAE,GAAG,GAAG,SAA4C,GACtD,OAAO,CAAC,MAAM,CAAC,CAqBjB"}

package/dist/index.js

@@ -0,0 +1,40 @@
+import { main } from '@avijs/cli';
+import { stdin, stdout } from 'node:process';
+import { createInterface } from 'node:readline/promises';
+import { parseArgs } from 'node:util';
+/**
+ * `avi new` for `npm create avi`. Asks for the project name and template when they are missing
+ * and `ask` is given; by default it asks only in an interactive terminal.
+ */
+export async function create(argv, ask = stdin.isTTY ? prompt : undefined) {
+    const args = [...argv];
+    const { values, positionals } = parseArgs({
+        args,
+        allowPositionals: true,
+        strict: false,
+        options: {
+            template: { type: 'string' },
+            dir: { type: 'string' },
+            'avi-version': { type: 'string' },
+            from: { type: 'string' },
+        },
+    });
+    if (positionals.length === 0 && ask) {
+        args.unshift(await ask('Project name', 'my-avi-app'));
+        if (values.template === undefined) {
+            args.push('--template', await ask('Template, modular or minimal', 'modular'));
+        }
+    }
+    return main(['new', ...args]);
+}
+async function prompt(question, fallback) {
+    const rl = createInterface({ input: stdin, output: stdout });
+    try {
+        const answer = await rl.question(`${question} (${fallback}): `);
+        return answer.trim() || fallback;
+    }
+    finally {
+        rl.close();
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAKtC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,IAAuB,EACvB,MAAuB,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;IAEvD,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;QACxC,IAAI;QACJ,gBAAgB,EAAE,IAAI;QACtB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC5B,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACvB,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACjC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SACzB;KACF,CAAC,CAAC;IAEH,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;QACpC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;QACtD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,CAAC,8BAA8B,EAAE,SAAS,CAAC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,QAAgB,EAAE,QAAgB;IACtD,MAAM,EAAE,GAAG,eAAe,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,QAAQ,KAAK,QAAQ,KAAK,CAAC,CAAC;QAChE,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,QAAQ,CAAC;IACnC,CAAC;YAAS,CAAC;QACT,EAAE,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,56 @@
 {
   "name": "create-avi",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Create an Avi.js project: npm create avi@latest my-app",
+  "keywords": [
+    "avi",
+    "avi.js",
+    "create",
+    "scaffolding",
+    "template"
+  ],
+  "license": "MIT",
+  "author": "Christopher Robin Chase",
+  "homepage": "https://github.com/chrischase011/avi-js#readme",
+  "bugs": {
+    "url": "https://github.com/chrischase011/avi-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chrischase011/avi-js.git",
+    "directory": "packages/create-avi"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=22.12"
+  },
+  "sideEffects": false,
+  "bin": {
+    "create-avi": "./dist/bin.js"
+  },
+  "exports": {
+    ".": {
+      "@avijs/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@avijs/cli": "0.1.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.8"
+  },
+  "scripts": {
+    "typecheck": "tsc -p tsconfig.json"
+  }
 }

package/src/bin.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { create } from './index.js';
+
+process.exitCode = await create(process.argv.slice(2));

package/src/index.ts

@@ -0,0 +1,47 @@
+import { main } from '@avijs/cli';
+import { stdin, stdout } from 'node:process';
+import { createInterface } from 'node:readline/promises';
+import { parseArgs } from 'node:util';
+
+/** Asks a question and returns the answer, or `fallback` for an empty one. */
+export type Ask = (question: string, fallback: string) => Promise<string>;
+
+/**
+ * `avi new` for `npm create avi`. Asks for the project name and template when they are missing
+ * and `ask` is given; by default it asks only in an interactive terminal.
+ */
+export async function create(
+  argv: readonly string[],
+  ask: Ask | undefined = stdin.isTTY ? prompt : undefined,
+): Promise<number> {
+  const args = [...argv];
+  const { values, positionals } = parseArgs({
+    args,
+    allowPositionals: true,
+    strict: false,
+    options: {
+      template: { type: 'string' },
+      dir: { type: 'string' },
+      'avi-version': { type: 'string' },
+      from: { type: 'string' },
+    },
+  });
+
+  if (positionals.length === 0 && ask) {
+    args.unshift(await ask('Project name', 'my-avi-app'));
+    if (values.template === undefined) {
+      args.push('--template', await ask('Template, modular or minimal', 'modular'));
+    }
+  }
+  return main(['new', ...args]);
+}
+
+async function prompt(question: string, fallback: string): Promise<string> {
+  const rl = createInterface({ input: stdin, output: stdout });
+  try {
+    const answer = await rl.question(`${question} (${fallback}): `);
+    return answer.trim() || fallback;
+  } finally {
+    rl.close();
+  }
+}