@danceroutine/tango-cli 0.1.0

package/README.md

@@ -0,0 +1,90 @@
+# @danceroutine/tango-cli
+
+`@danceroutine/tango-cli` provides the `tango` command-line executable.
+
+This package gives Tango one unified command surface for project setup and maintenance workflows. It exists so that application developers can learn one CLI instead of having to remember which package owns which command. Today that means migrations and project scaffolding. Over time it also gives Tango a stable place to compose future command modules.
+
+## Install
+
+```bash
+pnpm add -D @danceroutine/tango-cli
+```
+
+The CLI is typically a development dependency because it supports setup, generation, and migration workflows rather than application runtime behavior.
+
+## What the CLI is for
+
+Use the `tango` binary when you want to:
+
+- scaffold a new Tango project
+- generate migrations from model metadata
+- apply migrations to a database
+- inspect a migration plan or status
+
+The CLI package owns the executable itself. The feature packages still own their underlying behavior. For example, `@danceroutine/tango-migrations` owns migration generation and execution, while `@danceroutine/tango-cli` is the package that exposes those workflows through the `tango` binary.
+
+## Common commands
+
+```bash
+tango new my-app --framework express --package-manager pnpm --dialect sqlite
+tango make:migrations --dialect sqlite --models ./src/models.ts --dir ./migrations --name add_posts
+tango migrate --dialect sqlite --dir ./migrations --db ./app.sqlite
+tango plan --dialect sqlite --dir ./migrations --db ./app.sqlite
+tango status --dialect sqlite --dir ./migrations --db ./app.sqlite
+```
+
+The top-level `new` command is also available as `codegen new`. Both paths exist so that the first-run project bootstrap workflow feels straightforward while still fitting into the broader command-module structure.
+
+## Using the package programmatically
+
+The root export is intentionally small. If you need to embed Tango's CLI into a custom binary or test harness, start with `runCli()` and `createDefaultCommandModules()`:
+
+```ts
+import type { Argv } from 'yargs';
+import {
+  createDefaultCommandModules,
+  runCli,
+  type TangoCliCommandModule,
+} from '@danceroutine/tango-cli';
+
+class AppCommandModule implements TangoCliCommandModule {
+  readonly id = 'app';
+
+  register(parser: Argv): Argv {
+    return parser.command(
+      'seed-demo-data',
+      'Load demo data into the local database',
+      () => {},
+      async () => {},
+    );
+  }
+}
+
+await runCli({
+  modules: [...createDefaultCommandModules(), new AppCommandModule()],
+});
+```
+
+This approach keeps command composition modular. Tango's built-in modules remain intact, and your application can add its own command tree alongside them.
+
+## Documentation
+
+- Official documentation: https://danceroutine.github.io
+- CLI reference: https://danceroutine.github.io/reference/cli-api
+- Migrations topic: https://danceroutine.github.io/topics/migrations
+
+## Development
+
+```bash
+pnpm --filter @danceroutine/tango-cli build
+pnpm --filter @danceroutine/tango-cli typecheck
+pnpm --filter @danceroutine/tango-cli test
+```
+
+For the wider contributor workflow, use:
+
+- https://danceroutine.github.io/contributing
+
+## License
+
+MIT

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { runCli } from "./runCli-Btn_GxD3.js";
+
+//#region src/cli.ts
+void runCli();
+
+//#endregion
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","names":[],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { runCli } from './runCli';\n\nvoid runCli();\n"],"mappings":";;;;AAGA,KAAK,QAAQ"}

package/dist/commands/CodegenCommandModule.d.ts

@@ -0,0 +1,12 @@
+import type { Argv } from 'yargs';
+import type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';
+/**
+ * CLI module that mounts Tango's code-generation commands.
+ */
+export declare class CodegenCommandModule implements TangoCliCommandModule {
+    readonly id = "codegen";
+    /**
+     * Register the code-generation command tree on the shared parser.
+     */
+    register(parser: Argv): Argv;
+}

package/dist/commands/MigrationsCommandModule.d.ts

@@ -0,0 +1,12 @@
+import type { Argv } from 'yargs';
+import type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';
+/**
+ * CLI module that mounts Tango's migration commands.
+ */
+export declare class MigrationsCommandModule implements TangoCliCommandModule {
+    readonly id = "migrations";
+    /**
+     * Register the migration command tree on the shared parser.
+     */
+    register(parser: Argv): Argv;
+}

package/dist/commands/createDefaultCommandModules.d.ts

@@ -0,0 +1,5 @@
+import type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';
+/**
+ * Create the standard command modules shipped with Tango's CLI.
+ */
+export declare function createDefaultCommandModules(): readonly TangoCliCommandModule[];

package/dist/commands/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export { CodegenCommandModule } from './CodegenCommandModule';
+export { MigrationsCommandModule } from './MigrationsCommandModule';
+export { createDefaultCommandModules } from './createDefaultCommandModules';

package/dist/domain/TangoCliCommandModule.d.ts

@@ -0,0 +1,5 @@
+import type { Argv } from 'yargs';
+export interface TangoCliCommandModule {
+    readonly id: string;
+    register(parser: Argv): Argv;
+}

package/dist/domain/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Domain boundary barrel: centralizes this subdomain's public contract.
+ */
+export type { TangoCliCommandModule } from './TangoCliCommandModule';

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Bundled exports for Django-style domain drill-down imports, plus curated
+ * top-level symbols for TS-native ergonomic imports.
+ */
+export * as commands from './commands/index';
+export * as domain from './domain/index';
+export { createDefaultCommandModules } from './commands/index';
+export type { TangoCliCommandModule } from './domain/index';
+export { runCli, type RunCliOptions } from './runCli';

package/dist/index.js

@@ -0,0 +1,27 @@
+import { CodegenCommandModule, MigrationsCommandModule, createDefaultCommandModules, runCli } from "./runCli-Btn_GxD3.js";
+
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+};
+
+//#endregion
+//#region src/commands/index.ts
+var commands_exports = {};
+__export(commands_exports, {
+	CodegenCommandModule: () => CodegenCommandModule,
+	MigrationsCommandModule: () => MigrationsCommandModule,
+	createDefaultCommandModules: () => createDefaultCommandModules
+});
+
+//#endregion
+//#region src/domain/index.ts
+var domain_exports = {};
+
+//#endregion
+export { commands_exports as commands, createDefaultCommandModules, domain_exports as domain, runCli };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/commands/index.ts","../src/domain/index.ts"],"sourcesContent":["/**\n * Domain boundary barrel: centralizes this subdomain's public contract.\n */\n\nexport { CodegenCommandModule } from './CodegenCommandModule';\nexport { MigrationsCommandModule } from './MigrationsCommandModule';\nexport { createDefaultCommandModules } from './createDefaultCommandModules';\n","/**\n * Domain boundary barrel: centralizes this subdomain's public contract.\n */\n\nexport type { TangoCliCommandModule } from './TangoCliCommandModule';\n"],"mappings":""}

package/dist/runCli-Btn_GxD3.js

@@ -0,0 +1,48 @@
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { registerCodegenCommands } from "@danceroutine/tango-codegen";
+import { registerMigrationsCommands } from "@danceroutine/tango-migrations";
+
+//#region src/commands/CodegenCommandModule.ts
+var CodegenCommandModule = class {
+	id = "codegen";
+	/**
+	* Register the code-generation command tree on the shared parser.
+	*/
+	register(parser) {
+		return registerCodegenCommands(parser);
+	}
+};
+
+//#endregion
+//#region src/commands/MigrationsCommandModule.ts
+var MigrationsCommandModule = class {
+	id = "migrations";
+	/**
+	* Register the migration command tree on the shared parser.
+	*/
+	register(parser) {
+		return registerMigrationsCommands(parser);
+	}
+};
+
+//#endregion
+//#region src/commands/createDefaultCommandModules.ts
+function createDefaultCommandModules() {
+	return [new MigrationsCommandModule(), new CodegenCommandModule()];
+}
+
+//#endregion
+//#region src/runCli.ts
+async function runCli(options = {}) {
+	const modules = options.modules ?? createDefaultCommandModules();
+	const argvInput = options.argv ?? hideBin(process.argv);
+	let parser = yargs([...argvInput]);
+	parser = parser.scriptName("tango");
+	for (const module of modules) parser = module.register(parser);
+	await parser.demandCommand(1, "You must specify a command").strict().exitProcess(false).help().alias("help", "h").alias("version", "v").parseAsync();
+}
+
+//#endregion
+export { CodegenCommandModule, MigrationsCommandModule, createDefaultCommandModules, runCli };
+//# sourceMappingURL=runCli-Btn_GxD3.js.map

package/dist/runCli-Btn_GxD3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCli-Btn_GxD3.js","names":["parser: Argv","parser: Argv","options: RunCliOptions"],"sources":["../src/commands/CodegenCommandModule.ts","../src/commands/MigrationsCommandModule.ts","../src/commands/createDefaultCommandModules.ts","../src/runCli.ts"],"sourcesContent":["import type { Argv } from 'yargs';\nimport { registerCodegenCommands } from '@danceroutine/tango-codegen';\nimport type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';\n\n/**\n * CLI module that mounts Tango's code-generation commands.\n */\nexport class CodegenCommandModule implements TangoCliCommandModule {\n    readonly id = 'codegen';\n\n    /**\n     * Register the code-generation command tree on the shared parser.\n     */\n    register(parser: Argv): Argv {\n        return registerCodegenCommands(parser);\n    }\n}\n","import type { Argv } from 'yargs';\nimport { registerMigrationsCommands } from '@danceroutine/tango-migrations';\nimport type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';\n\n/**\n * CLI module that mounts Tango's migration commands.\n */\nexport class MigrationsCommandModule implements TangoCliCommandModule {\n    readonly id = 'migrations';\n\n    /**\n     * Register the migration command tree on the shared parser.\n     */\n    register(parser: Argv): Argv {\n        return registerMigrationsCommands(parser);\n    }\n}\n","import type { TangoCliCommandModule } from '../domain/TangoCliCommandModule';\nimport { CodegenCommandModule } from './CodegenCommandModule';\nimport { MigrationsCommandModule } from './MigrationsCommandModule';\n\n/**\n * Create the standard command modules shipped with Tango's CLI.\n */\nexport function createDefaultCommandModules(): readonly TangoCliCommandModule[] {\n    return [new MigrationsCommandModule(), new CodegenCommandModule()];\n}\n","import yargs from 'yargs';\nimport { hideBin } from 'yargs/helpers';\nimport type { TangoCliCommandModule } from './domain/TangoCliCommandModule';\nimport { createDefaultCommandModules } from './commands/createDefaultCommandModules';\n\nexport type RunCliOptions = {\n    argv?: readonly string[];\n    modules?: readonly TangoCliCommandModule[];\n};\n\n/**\n * Run Tango's CLI with a supplied argv list and command module set.\n *\n * This is the entry point used by the binary, and it is also useful in tests\n * or host applications that want to customize which commands are available.\n */\nexport async function runCli(options: RunCliOptions = {}): Promise<void> {\n    const modules = options.modules ?? createDefaultCommandModules();\n    const argvInput = options.argv ?? hideBin(process.argv);\n\n    let parser = yargs([...argvInput]);\n    parser = parser.scriptName('tango');\n\n    for (const module of modules) {\n        parser = module.register(parser);\n    }\n\n    await parser\n        .demandCommand(1, 'You must specify a command')\n        .strict()\n        .exitProcess(false)\n        .help()\n        .alias('help', 'h')\n        .alias('version', 'v')\n        .parseAsync();\n}\n"],"mappings":";;;;;;IAOa,uBAAN,MAA4D;CAC/D,KAAc;;;;CAKd,SAASA,QAAoB;AACzB,SAAO,wBAAwB,OAAO;CACzC;AACJ;;;;ICTY,0BAAN,MAA+D;CAClE,KAAc;;;;CAKd,SAASC,QAAoB;AACzB,SAAO,2BAA2B,OAAO;CAC5C;AACJ;;;;ACTM,SAAS,8BAAgE;AAC5E,QAAO,CAAC,IAAI,2BAA2B,IAAI,sBAAuB;AACrE;;;;ACOM,eAAe,OAAOC,UAAyB,CAAE,GAAiB;CACrE,MAAM,UAAU,QAAQ,WAAW,6BAA6B;CAChE,MAAM,YAAY,QAAQ,QAAQ,QAAQ,QAAQ,KAAK;CAEvD,IAAI,SAAS,MAAM,CAAC,GAAG,SAAU,EAAC;AAClC,UAAS,OAAO,WAAW,QAAQ;AAEnC,MAAK,MAAM,UAAU,QACjB,UAAS,OAAO,SAAS,OAAO;AAGpC,OAAM,OACD,cAAc,GAAG,6BAA6B,CAC9C,QAAQ,CACR,YAAY,MAAM,CAClB,MAAM,CACN,MAAM,QAAQ,IAAI,CAClB,MAAM,WAAW,IAAI,CACrB,YAAY;AACpB"}

package/dist/runCli.d.ts

@@ -0,0 +1,12 @@
+import type { TangoCliCommandModule } from './domain/TangoCliCommandModule';
+export type RunCliOptions = {
+    argv?: readonly string[];
+    modules?: readonly TangoCliCommandModule[];
+};
+/**
+ * Run Tango's CLI with a supplied argv list and command module set.
+ *
+ * This is the entry point used by the binary, and it is also useful in tests
+ * or host applications that want to customize which commands are available.
+ */
+export declare function runCli(options?: RunCliOptions): Promise<void>;

package/package.json

@@ -0,0 +1,51 @@
+{
+    "name": "@danceroutine/tango-cli",
+    "version": "0.1.0",
+    "description": "Unified Tango command line interface for migrations and code generation",
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "bin": {
+        "tango": "dist/cli.js"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsdown",
+        "test": "vitest run --coverage",
+        "test:watch": "vitest",
+        "typecheck": "tsc --noEmit"
+    },
+    "keywords": [
+        "tango",
+        "cli",
+        "migrations",
+        "codegen"
+    ],
+    "author": "Pedro Del Moral Lopez",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/danceroutine/tango.git",
+        "directory": "packages/cli"
+    },
+    "dependencies": {
+        "@danceroutine/tango-codegen": "workspace:*",
+        "@danceroutine/tango-migrations": "workspace:*",
+        "yargs": "^17.7.2"
+    },
+    "devDependencies": {
+        "@types/node": "^22.9.0",
+        "@types/yargs": "^17.0.33",
+        "tsdown": "^0.4.0",
+        "typescript": "^5.6.3",
+        "vitest": "^4.0.6"
+    }
+}