@nage-api/cli 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,196 @@
+# @nage-api/cli
+
+The `nage` command (PLAN.md §10): scaffolding that produces a **production-shaped**
+workspace, and workspace management that keeps it coherent as it grows.
+
+The legacy generator wrote a project and then let it drift: `--noSpec` was the
+habit, wiring a new module was a manual edit in three files, and nothing checked
+that the result still made sense. Here every command is a transaction over the
+whole workspace, every generator that produces behaviour also produces its test,
+and `nage doctor` reports through the same audit that blocks an insecure
+production boot.
+
+## Commands
+
+| Command                     | What it does                                                                |
+| --------------------------- | --------------------------------------------------------------------------- |
+| `nage create <name>`        | Scaffold a workspace seeded with one app                                    |
+| `nage new app <name>`       | Add an app — its own preset, port and features                              |
+| `nage new package <name>`   | Add a shared local package and wire its alias                               |
+| `nage g resource <name>`    | Entity, DTOs, service, controller, module, tests and a migration            |
+| `nage g <schematic> <name>` | `module`, `service`, `controller`, `entity`, `dto`, `migration`, `seed`     |
+| `nage add <feature>`        | Enable `auth`/`cache`/`queue`/`storage`/`realtime`/`notify`/`observability` |
+| `nage remove <feature>`     | Disable one, dependency and all                                             |
+| `nage remove app <name>`    | Unregister and archive the directory as `<name>.removed`                    |
+| `nage remove package <n>`   | Unregister and drop the alias; the directory is left where it is            |
+| `nage list` / `nage info`   | What exists; what versions a bug report needs                               |
+| `nage doctor`               | Workspace integrity + the secret audit, exit 1 when blocking                |
+
+Flags: `--app <name>`, `--all`, `--dry-run`, `--db`, `--first-app`, `--preset`,
+`--port`, `--fields`, `--route`, `--package`, `--no-migration`, `--no-spec`,
+`--legacy`, `-h`, `-v`. `parseArgs` needs the whole option set declared up front,
+so every flag parses on every command and a command ignores the ones it does not
+read. `--app` is usually unnecessary for `g` — the current directory says which
+app is meant — and `doctor` accepts it but does not act on it.
+
+`g entity`, `g dto`, `g migration` and `g seed` emit no spec of their own: they
+produce a declaration, and the tests belong to the service and controller that
+use it, which `g resource`, `g service` and `g controller` do emit.
+
+Every command, every flag with its type and default, every file each one writes,
+and each `doctor` check individually: [docs/cli-reference.md](../../docs/cli-reference.md).
+
+## Four ideas
+
+**Every command is a plan.** A command builds a `FileTree` and returns it; the
+caller commits it. That is what makes `--dry-run` exact rather than a
+best-effort preview, and what lets the whole surface be tested without spawning
+a process:
+
+<!-- docs-example: fragment -->
+
+```ts
+import { commitFileTree, loadWorkspace, planGenerate } from '@nage-api/cli';
+
+const { root, manifest } = await loadWorkspace(process.cwd());
+
+const plan = await planGenerate({
+  root,
+  manifest,
+  schematic: 'resource',
+  name: 'product',
+  appName: 'api',
+});
+
+const willBeWritten: readonly string[] = plan.tree.paths; // exactly what lands
+await commitFileTree(plan.tree, { root, dryRun: false });
+```
+
+**Writes are atomic.** `commitFileTree` refuses the whole batch before writing
+anything, backs up what it replaces, and rolls back on any failure. Adding a
+shared package touches four files at once — `nage.workspace.json`, the alias in
+`tsconfig.base.json`, the `packages/*` glob in `pnpm-workspace.yaml` and the
+project reference in the root `tsconfig.json` — and a workspace where three of
+the four landed is worse than a command that failed cleanly: the alias resolves
+in the editor but not in `pnpm install`, and nothing says why.
+
+The rollback covers a failed write, not a killed process: there is no signal
+handler, so `Ctrl-C` mid-write leaves what had landed. And `remove app` archives
+the directory after the commit rather than inside it, so an archive that fails
+leaves the app unregistered.
+
+**Generators are idempotent.** Re-running one writes only the files that are
+missing (`onConflict: 'skip'`); edited code is reported as `left alone`, never
+clobbered. The module-wiring edit to `app.module.ts` is deliberately
+conservative: when the file no longer matches the shape the CLI emits, it prints
+an instruction rather than mangling it.
+
+The one exception is the migration. Its filename carries a fresh timestamp, so it
+can never collide with the previous one, and re-running `g resource product`
+leaves two migrations that both create the `products` table. Pass
+`--no-migration` when re-running a generator over a resource that already exists.
+
+**Sub-generators cannot drift.** `g service` is a filter over the file set
+`g resource` would produce, so the two are byte-identical by construction — a
+property the suite asserts rather than a convention to remember.
+
+## `nage.workspace.json`
+
+The manifest is the source of truth, serialised deterministically so a rewrite
+produces an empty diff:
+
+```json
+{
+  "version": 1,
+  "name": "shop",
+  "engine": "postgres",
+  "frameworkVersion": "^0.1.0",
+  "apps": [{ "name": "api", "preset": "api", "port": 3000, "features": ["cache"] }],
+  "packages": [{ "name": "domain", "alias": "@app/domain" }]
+}
+```
+
+One engine per workspace (§10.2): apps share `packages/domain` entities and
+`database/migrations`, which only stays coherent with a single engine. The
+driver package is chosen at scaffold time — a Postgres workspace never installs
+the Mongo driver.
+
+## What the generated workspace looks like
+
+`nage create shop` writes a monorepo that is ready to deploy, not ready to
+configure: strict TypeScript with project references, Turborepo, ESLint,
+Prettier, a CI workflow, a multi-stage non-root `Dockerfile`, a `.env.example`,
+and an app whose `main.ts` validates its environment before binding a port. The
+`.env.example` covers `NODE_ENV`, `CORS_ORIGINS`, `DATABASE_URL` and a
+`<APP>_PORT` line per app; it does not cover `PORT`, which is the variable the
+generated env schema actually reads.
+
+Presets: `minimal`, `api`, `api-realtime`, `worker`. A worker has no HTTP
+surface — no port, no CORS, no health controller — because a preset that stays
+half-applicable is how insecure defaults spread. `minimal`, `api` and
+`api-realtime` currently emit identical output; the preset is recorded in the
+manifest so a later version can act on it.
+
+## `nage doctor`
+
+Two kinds of check, one report and one exit code:
+
+- **workspace integrity** — duplicate app names or ports, aliases that collide,
+  apps registered but missing from disk (and the reverse), shared packages
+  nothing imports;
+- **secrets** — delegated to `auditSecurity` in `@nage-api/core`, so the rule that
+  fails a weak secret here is the same code that refuses a production boot,
+  rather than two lists that drift.
+
+Anything `critical` or `high` exits 1, which is what makes it usable as a CI
+gate. `--legacy` additionally scans sources for the insecure patterns of §23.3.
+
+Secret strength is judged from the workspace's own `.env`, deliberately **not**
+from `process.env`: the shell a developer or a runner invokes `doctor` in is
+full of tokens whose names match any secret heuristic, and a report about the
+machine rather than the project is a report nobody reads.
+
+What `doctor` does **not** yet see is the app's own `nage.config.ts`. It calls
+`auditSecurity` with a minimal production config, so the config-shaped findings
+that audit can produce — a wildcard CORS list, `ssl: 'no-verify'`, throttling
+switched off — are not reported by the CLI today. Reaching them means executing
+the app's TypeScript config, which the CLI does not do. Until it does,
+`assertSecureConfig` at boot is where those are caught (§12).
+
+## Not yet implemented
+
+- `nage upgrade` — codemods across framework versions (§10.1).
+- `nage db migrate|seed|rollback` — needs a driver resolved at runtime inside a
+  generated workspace. The generated `package.json` ships `db:migrate` and
+  `db:seed` scripts that invoke it anyway, so `pnpm db:migrate` fails with
+  `"db" is not a nage command`, as do the two generated notes that recommend it.
+- `--standalone` and `nage workspace init` (§9.3). The flag parses and is
+  accepted; `planCreate` ignores it, so you get a workspace either way.
+- `--force`. It parses, but no command reads it — a conflicting file still fails
+  the whole batch, whatever the hint in that error says.
+- `doctor --app <name>`. It parses and reaches `runDoctor`, which never reads it:
+  the report always covers the whole workspace, and an app name that does not
+  exist is not even reported.
+- Validation of `--db`, `--preset` and `--port`. All three are cast rather than
+  checked, so `--db cassandra` writes that engine into the manifest and
+  `--port abc` records `"port": null`.
+- `--package <name>` beyond placing the entity file. The service is pointed at
+  `@app/<name>`, but the controller, the service spec and the query DTO still
+  import `./entities/<name>.entity.js`, and the package's `index.ts` is not
+  updated to export the entity — so a resource generated this way does not
+  typecheck until three imports and one export are fixed by hand. The same
+  applies to `g module`, `g controller` and `g dto` used on their own: each emits
+  files that import siblings it does not emit.
+- Dropping the root project reference in `remove package`. The manifest entry and
+  the alias go; `{ "path": "packages/<name>" }` stays in `tsconfig.json` and
+  breaks `tsc -b` once you delete the directory. `remove app` does remove its
+  reference.
+- The security half of `doctor` reading the app's config, as above.
+- Interactive prompts; every command is flag-driven for now.
+- The "generated workspace installs from a registry and passes its own CI"
+  acceptance test (§24 Phase 6). The suite does build, lint, typecheck and run
+  the generated workspace's own tests, but against symlinked local packages: it
+  cannot tell you whether the version ranges in the generated `package.json`
+  resolve, because `@nage-api/*` is not published yet.
+
+The deeper guide is [docs/packages/cli.md](../../docs/packages/cli.md).

package/dist/cli.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The `nage` command layer (PLAN.md §10).
+ *
+ * Argument parsing uses Node's own `util.parseArgs` rather than a framework:
+ * the command surface is small and regular, and a CLI that scaffolds
+ * dependency-light projects should be dependency-light itself.
+ *
+ * `run()` returns an exit code and writes through an injected output object, so
+ * every command is testable without spawning a process.
+ */
+export interface CliIo {
+    out(message: string): void;
+    err(message: string): void;
+}
+export interface RunOptions {
+    readonly argv: readonly string[];
+    readonly cwd: string;
+    readonly io: CliIo;
+    readonly version?: string;
+}
+export declare const CLI_VERSION = "0.0.0";
+/** Run one command. Returns the process exit code. */
+export declare function run(options: RunOptions): Promise<number>;
+export declare function usage(): string;
+//# sourceMappingURL=cli.d.ts.map