@asterflow/cli 0.1.0

package/dist/types/generators/packageJson.d.ts

@@ -0,0 +1,8 @@
+import type { AdapterDefinition } from '../registry/adapters';
+import type { PluginDefinition } from '../registry/plugins';
+export interface PackageJsonOptions {
+    name: string;
+    adapter: AdapterDefinition;
+    plugins: PluginDefinition[];
+}
+export declare function generatePackage({ name, adapter, plugins }: PackageJsonOptions): string;

package/dist/types/generators/routes.d.ts

@@ -0,0 +1,9 @@
+export interface RoutesOptions {
+    pluginIds: string[];
+    templateIds: string[];
+}
+export interface RouteFile {
+    fileName: string;
+    content: string;
+}
+export declare function generateRoutes({ pluginIds, templateIds }: RoutesOptions): Promise<RouteFile[]>;

package/dist/types/helpers/copyTemplate.d.ts

@@ -0,0 +1,4 @@
+/** Reads a static file from `packages/cli/templates/<name>`, verbatim. */
+export declare function readTemplate(name: string): Promise<string>;
+/** Copies a static file from `packages/cli/templates/<name>` to `destPath`, verbatim. */
+export declare function copyTemplate(name: string, destPath: string): Promise<void>;

package/dist/types/helpers/git.d.ts

@@ -0,0 +1,2 @@
+/** Initializes a git repo at `root` with an initial commit. No-op (returns false) if git is missing or `root` is already inside a repo. */
+export declare function tryGitInit(root: string): boolean;

package/dist/types/helpers/isFolderEmpty.d.ts

@@ -0,0 +1,2 @@
+/** Reports (and prints) whether `root` is safe to scaffold into - empty, or containing only files from `ALLOWED_ENTRIES`. */
+export declare function isFolderEmpty(root: string, name: string): boolean;

package/dist/types/helpers/isWriteable.d.ts

@@ -0,0 +1 @@
+export declare function isWriteable(directory: string): Promise<boolean>;

package/dist/types/helpers/validateProjectName.d.ts

@@ -0,0 +1,7 @@
+export type ValidateProjectNameResult = {
+    valid: true;
+} | {
+    valid: false;
+    problems: string[];
+};
+export declare function validateProjectName(name: string): ValidateProjectNameResult;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/types/registry/adapters.d.ts

@@ -0,0 +1,16 @@
+export interface AdapterDefinition {
+    id: string;
+    label: string;
+    /** npm package name, or `null` when the adapter needs no extra dependency (bun/node are built in). */
+    dependency: string | null;
+    /** Import lines needed at the top of the generated entry file, beyond `adapters` itself. */
+    imports: string[];
+    /** Expression passed as `driver` to `new AsterFlow({ driver: ... })`. */
+    driverExpression: string;
+    /** Statement placed before the exported chain, e.g. `const server = express()`. `null` when nothing is needed. */
+    preamble: string | null;
+    /** Everything after `.listen` - arguments and callback - appended to the exported chain. */
+    listenCall: string;
+}
+export declare const ADAPTER_REGISTRY: Record<string, AdapterDefinition>;
+export declare const ADAPTER_IDS: string[];

package/dist/types/registry/plugins.d.ts

@@ -0,0 +1,14 @@
+export interface PluginDefinition {
+    id: string;
+    packageName: string;
+    version: string;
+    description: string;
+    /** Binding name imported from the plugin's package, e.g. `multipartPlugin`. */
+    importName: string;
+    /** Appended as a `.use(...)` call in the generated `app` chain. */
+    useSnippet: string;
+    /** Printed by `add`/`init` after wiring - anything the user still has to do by hand. */
+    usageNote: string;
+}
+export declare const PLUGIN_REGISTRY: Record<string, PluginDefinition>;
+export declare const PLUGIN_IDS: string[];

package/dist/types/registry/templates.d.ts

@@ -0,0 +1,11 @@
+export interface RouteTemplate {
+    id: string;
+    path: string;
+    source: string;
+    plugin?: string;
+    summary: string;
+}
+export declare const TEMPLATE_REGISTRY: Record<string, RouteTemplate>;
+export declare const TEMPLATE_IDS: string[];
+export declare function availableTemplates(pluginIds: string[]): RouteTemplate[];
+export declare function templateTarget(template: RouteTemplate): string;

package/dist/types/utils/log.d.ts

@@ -0,0 +1,7 @@
+export declare const log: {
+    info: (message: string) => void;
+    success: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+    step: (message: string) => void;
+};

package/dist/types/utils/packageManager.d.ts

@@ -0,0 +1,7 @@
+export type PackageManager = 'bun' | 'pnpm' | 'yarn' | 'npm';
+/** Detects the package manager in use for `cwd`, based on lockfiles present, defaulting to `bun`. */
+export declare function detectPackageManager(cwd: string): PackageManager;
+/** `explicit` (e.g. from `--use-npm`/`--use-pnpm`/`--use-yarn`/`--use-bun`) wins over lockfile detection. */
+export declare function resolvePackageManager(explicit: PackageManager | undefined, cwd: string): PackageManager;
+export declare function installCommand(manager: PackageManager): string;
+export declare function addCommand(manager: PackageManager, packages: string[]): string;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@asterflow/cli",
+  "version": "0.1.0",
+  "description": "CLI for scaffolding AsterFlow projects, adding plugins, and generating the static fs-routing manifest.",
+  "keywords": [
+    "asterflow",
+    "cli",
+    "scaffolding",
+    "generator"
+  ],
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/mjs/index.js",
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts",
+  "type": "module",
+  "license": "MIT",
+  "author": "Ashu11-A",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AsterFlow/AsterFlow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AsterFlow/AsterFlow/issues"
+  },
+  "homepage": "https://github.com/AsterFlow/AsterFlow",
+  "bin": {
+    "asterflow": "dist/cjs/index.cjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "dev": "bun run src/index.ts"
+  },
+  "dependencies": {
+    "@asterflow/fs": "^2.0.0",
+    "@clack/prompts": "^0.9.1",
+    "chalk": "^4.1.2",
+    "ci-info": "^4.1.0",
+    "validate-npm-package-name": "^6.0.0",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {
+    "@types/validate-npm-package-name": "^4.0.2",
+    "@types/yargs": "^17.0.33"
+  },
+  "peerDependencies": {
+    "typescript": "^5.8.3"
+  }
+}

package/templates/gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.env

package/templates/routes/global.d.ts

@@ -0,0 +1,7 @@
+// Maintainer-only - not one of the example routes (`generators/routes.ts`
+// never reads this file, so it's never shipped to a scaffolded project). Pulls in
+// @asterflow/multipart's module augmentation (adds `.multipart(...)` to
+// `Method`) so `upload.ts` typechecks standalone here, the same way it does
+// in a real scaffolded project once that project's `src/index.ts` imports
+// the plugin.
+import '@asterflow/multipart'

package/templates/routes/index.ts

@@ -0,0 +1,7 @@
+import { Method } from '@asterflow/router'
+
+export default new Method(Method.GET, {
+  handler({ response }) {
+    return response.success({ message: 'Hello from AsterFlow!' })
+  }
+})

package/templates/routes/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "paths": {
+      "asterflow": ["../core/src/index.ts"],
+      "@asterflow/multipart": ["../plugins/multipart/src/index.ts"],
+      "@asterflow/*": ["./*/src/index.ts"]
+    }
+  }
+}

package/templates/routes/upload.ts

@@ -0,0 +1,15 @@
+import { Method } from '@asterflow/router'
+
+export default Method.create(Method.POST)
+  .multipart({
+    avatar: { mimeTypes: ['image/png', 'image/jpeg'], maxSize: 5 * 1024 * 1024, required: true }
+  })
+  .handler(({ request, response }) => {
+    const avatar = request.getFile('avatar')
+
+    return response.success({
+      filename: avatar.filename,
+      mimeType: avatar.mimeType,
+      size: avatar.size
+    })
+  })

package/templates/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "allowJs": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "types": [
+      "bun-types"
+    ]
+  },
+  "exclude": [
+    "templates"
+  ],
+  "include": [
+    "dist"
+  ]
+}