@travetto/scaffold 7.0.0-rc.1 → 7.0.0-rc.3

package/README.md

@@ -111,10 +111,10 @@ export class TodoController {
    */
   @Get('/:id')
   async getOne(id: string): Promise<Todo> {
-    const q: ModelQuery<Todo> = { where: { id } };
-    if (typeof q.where !== 'string') {
+    const query: ModelQuery<Todo> = { where: { id } };
+    if (typeof query.where !== 'string') {
     }
-    return this.source.queryOne(Todo, q);
+    return this.source.queryOne(Todo, query);
   }
 
   /**
@@ -138,10 +138,10 @@ export class TodoController {
    */
   @Delete('/:id')
   async remove(id: string): Promise<void> {
-    const q: ModelQuery<Todo> = { where: { id } };
-    if (typeof q.where !== 'string') {
+    const query: ModelQuery<Todo> = { where: { id } };
+    if (typeof query.where !== 'string') {
     }
-    if (await this.source.deleteByQuery(Todo, q) !== 1) {
+    if (await this.source.deleteByQuery(Todo, query) !== 1) {
       throw new NotFoundError(Todo, id);
     }
   }

package/bin/trv-scaffold.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
 // @ts-check
 
-async function getScaffoldCwd() {
+async function getModuleDirectory() {
   if (process.env.npm_lifecycle_script?.includes('trv-scaffold')) { // Is npx  run
     const { delimiter } = await import('node:path');
     const parts = process.env.PATH?.split(delimiter) ?? [];
-    const loc = parts.find(p => p.includes('npx') && p.includes('.bin'));
+    const loc = parts.find(part => part.includes('npx') && part.includes('.bin'));
     if (loc) {
       return loc.split('/node_modules')[0];
     }
@@ -14,22 +14,22 @@ async function getScaffoldCwd() {
 }
 
 /**
- * @param {string} cwd
+ * @param {string} workingDirectory
  */
-async function getVersion(cwd) {
+async function getVersion(workingDirectory) {
   const fs = await import('node:fs/promises');
-  const pkg = JSON.parse(await fs.readFile(`${cwd}/package.json`, 'utf8'));
+  const pkg = JSON.parse(await fs.readFile(`${workingDirectory}/package.json`, 'utf8'));
   const version = `${pkg.dependencies['@travetto/scaffold']}`.replace(/\d+$/, '0');
   return version;
 }
 
 (async function () {
-  const scaffoldCwd = await getScaffoldCwd();
-  const version = await getVersion(scaffoldCwd);
+  const workingDirectory = await getModuleDirectory();
+  const version = await getVersion(workingDirectory);
 
   const { spawn, execSync } = await import('node:child_process');
   // Ensure we install the compiler first
-  execSync(`npm i @travetto/compiler@${version}`, { stdio: 'pipe', cwd: scaffoldCwd });
+  execSync(`npm i @travetto/compiler@${version}`, { stdio: 'pipe', cwd: workingDirectory });
 
   spawn('npx', [
     'trvc', 'exec',
@@ -39,7 +39,7 @@ async function getVersion(cwd) {
     ...process.argv.slice(2)
   ], {
     stdio: 'inherit',
-    cwd: scaffoldCwd,
+    cwd: workingDirectory,
     env: {
       ...process.env,
       TRV_QUIET: '1',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/scaffold",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
   "description": "App Scaffold for the Travetto framework",
   "keywords": [
     "generator",
@@ -27,13 +27,13 @@
     "trv-scaffold": "bin/trv-scaffold.js"
   },
   "dependencies": {
-    "@travetto/cli": "^7.0.0-rc.1",
-    "@travetto/runtime": "^7.0.0-rc.1",
+    "@travetto/cli": "^7.0.0-rc.3",
+    "@travetto/runtime": "^7.0.0-rc.3",
     "enquirer": "^2.4.1",
     "mustache": "^4.2.0"
   },
   "devDependencies": {
-    "@travetto/model": "^7.0.0-rc.1",
+    "@travetto/model": "^7.0.0-rc.3",
     "@types/mustache": "^4.2.6"
   },
   "travetto": {

package/resources/templates/todo/src/web/auth.config.ts

@@ -11,22 +11,22 @@ type User = { username: string, password: string };
 class AuthConfig {
   @InjectableFactory()
   static getAuthorizer(): Authorizer { // Simply mirrors the identity back as the principal
-    return { authorize: p => p };
+    return { authorize: principal => principal };
   }
 
   @InjectableFactory(SessionModelSymbol)
-  static getStore(svc: MemoryModelService): ModelExpirySupport {
-    return svc;
+  static getStore(service: MemoryModelService): ModelExpirySupport {
+    return service;
   }
 
   @InjectableFactory(BasicAuthSymbol)
   static getAuthenticator(): Authenticator<User> {
     return {
-      authenticate(u) {
-        if (u.username && u.password === 'password') {
+      authenticate(user) {
+        if (user.username && user.password === 'password') {
           return {
             issuer: 'self',
-            id: u.username,
+            id: user.username,
             permissions: [],
             details: {},
             source: 'insecure'

package/resources/templates/todo/src/web/todo.ts

@@ -57,13 +57,13 @@ export class TodoController {
    */
   @Get('/:id')
   async getOne(id: string): Promise<Todo> {
-    const q: ModelQuery<Todo> = { where: { id } };
+    const query: ModelQuery<Todo> = { where: { id } };
     // {{#modules.auth_web}}
-    if (typeof q.where !== 'string') {
-      q.where!.userId = this.authContext.principal?.id;
+    if (typeof query.where !== 'string') {
+      query.where!.userId = this.authContext.principal?.id;
     }
     // {{/modules.auth_web}}
-    return this.source.queryOne(Todo, q);
+    return this.source.queryOne(Todo, query);
   }
 
   /**
@@ -93,13 +93,13 @@ export class TodoController {
    */
   @Delete('/:id')
   async remove(id: string): Promise<void> {
-    const q: ModelQuery<Todo> = { where: { id } };
+    const query: ModelQuery<Todo> = { where: { id } };
     // {{#modules.auth_web}}
-    if (typeof q.where !== 'string') {
-      q.where!.userId = this.authContext.principal?.id;
+    if (typeof query.where !== 'string') {
+      query.where!.userId = this.authContext.principal?.id;
     }
     // {{/modules.auth_web}}
-    if (await this.source.deleteByQuery(Todo, q) !== 1) {
+    if (await this.source.deleteByQuery(Todo, query) !== 1) {
       throw new NotFoundError(Todo, id);
     }
   }

package/resources/templates/todo/test/model/todo.ts

@@ -15,9 +15,9 @@ class TestCRUD extends BaseModelSuite<ModelCrudSupport> {
 
   @Test('save it')
   async save(): Promise<void> {
-    const svc = await this.service;
+    const service = await this.service;
 
-    const saved = await svc.create(Todo, Todo.from({
+    const saved = await service.create(Todo, Todo.from({
       text: 'A saved todo',
       completed: false
     }));

package/support/bin/context.ts

@@ -4,7 +4,7 @@ import path from 'node:path';
 
 import mustache from 'mustache';
 
-import { castKey, castTo, ExecUtil, RuntimeIndex } from '@travetto/runtime';
+import { castKey, castTo, ExecUtil, JSONUtil, RuntimeIndex } from '@travetto/runtime';
 import { cliTpl } from '@travetto/cli';
 import { NodePackageManager, PackageUtil } from '@travetto/manifest';
 import { Terminal } from '@travetto/terminal';
@@ -14,7 +14,7 @@ import { Feature } from './features.ts';
 type ListingEntry = { requires?: string[], rename?: string };
 type Listing = Record<string, ListingEntry>;
 
-const DEV_DEPS = new Set([
+const DEV_DEPENDENCIES = new Set([
   '@travetto/test',
   '@travetto/pack',
   '@travetto/compiler',
@@ -36,7 +36,7 @@ export class Context {
   }
 
   #template: string;
-  #targetDir: string;
+  #targetDirectory: string;
   #dependencies: string[] = [];
   #devDependencies: string[] = [];
   #peerDependencies: string[] = [];
@@ -46,26 +46,26 @@ export class Context {
 
   readonly name: string;
 
-  constructor(name: string, template: string, targetDir: string) {
+  constructor(name: string, template: string, targetDirectory: string) {
     this.name = name.replace(/[^a-zA-Z0-9]+/, '-').replace(/-+$/, '');
     this.#template = template;
-    this.#targetDir = path.resolve(targetDir);
+    this.#targetDirectory = path.resolve(targetDirectory);
   }
 
   #exec(cmd: string, args: string[]): Promise<void> {
-    const term = new Terminal();
-    const proc = spawn(cmd, args, {
+    const terminal = new Terminal();
+    const subProcess = spawn(cmd, args, {
       cwd: this.destination(),
       stdio: [0, 'pipe', 'pipe'],
       env: { PATH: process.env.PATH },
     });
 
-    if (proc.stderr) {
-      ExecUtil.readLines(proc.stderr,
-        line => term.writer.writeLine(cliTpl`    ${{ identifier: [cmd, ...args].join(' ') }}: ${line.trimEnd()}`).commit());
+    if (subProcess.stderr) {
+      ExecUtil.readLines(subProcess.stderr,
+        line => terminal.writer.writeLine(cliTpl`    ${{ identifier: [cmd, ...args].join(' ') }}: ${line.trimEnd()}`).commit());
     }
 
-    return ExecUtil.getResult(proc).then(() => { });
+    return ExecUtil.getResult(subProcess).then(() => { });
   }
 
   get selfPath(): string {
@@ -77,19 +77,19 @@ export class Context {
   }
 
   destination(file?: string): string {
-    return path.resolve(this.#targetDir, ...file ? [file] : []);
+    return path.resolve(this.#targetDirectory, ...file ? [file] : []);
   }
 
   get sourceListing(): Promise<Listing> {
-    return fs.readFile(this.source('listing.json'), 'utf8').then(val => JSON.parse(val));
+    return JSONUtil.readFile<Listing>(this.source('listing.json'));
   }
 
   async resolvedSourceListing(): Promise<[string, ListingEntry][]> {
-    const res = Object.entries(await this.sourceListing)
-      .filter(([, conf]) => !conf.requires ||
-        Context.#meetsRequirement([...this.#dependencies, ...this.#devDependencies], conf.requires));
+    const listing = Object.entries(await this.sourceListing)
+      .filter(([, entry]) => !entry.requires ||
+        Context.#meetsRequirement([...this.#dependencies, ...this.#devDependencies], entry.requires));
 
-    return res;
+    return listing;
   }
 
   async initialize(): Promise<void> {
@@ -108,7 +108,8 @@ export class Context {
 
   templateContext(): Record<string, unknown> {
     const modules = [...this.#dependencies, ...this.#devDependencies]
-      .map(x => path.basename(x)).reduce((acc, v) => ({ ...acc, [v.replace(/[-]/g, '_')]: true }), {});
+      .map(mod => path.basename(mod))
+      .reduce((ctx, value) => ({ ...ctx, [value.replace(/[-]/g, '_')]: true }), {});
     const moduleNames = [...Object.keys(modules)];
 
     /** Get framework version at runtime */
@@ -126,7 +127,7 @@ export class Context {
         devDependencies: [...new Set(this.#devDependencies)].toSorted((a, b) => a.localeCompare(b)),
       },
       ...this.#featureContexts,
-      ...moduleNames.map(x => ({ [`module_${x}`]: true }))
+      ...moduleNames.map(mod => ({ [`module_${mod}`]: true }))
     );
 
     return context;
@@ -160,7 +161,7 @@ export class Context {
       const pkgs = Array.isArray(feat.package) ? feat.package : [feat.package];
       for (const pkg of pkgs) {
         if (pkg.startsWith('@travetto')) {
-          if (DEV_DEPS.has(pkg)) {
+          if (DEV_DEPENDENCIES.has(pkg)) {
             this.#devDependencies.push(pkg);
           } else {
             this.#dependencies.push(pkg);
@@ -210,6 +211,6 @@ export class Context {
       await this.#exec('npx', ['trv', 'eslint:register']);
     }
 
-    yield cliTpl`${{ success: 'Successfully created' }} at ${{ path: this.#targetDir }} `;
+    yield cliTpl`${{ success: 'Successfully created' }} at ${{ path: this.#targetDirectory }} `;
   }
 }

package/support/cli.scaffold.ts

@@ -2,7 +2,7 @@ import path from 'node:path';
 
 import { prompt } from 'enquirer';
 
-import { CliCommandShape, CliCommand, cliTpl } from '@travetto/cli';
+import { CliCommandShape, CliCommand, cliTpl, CliFlag } from '@travetto/cli';
 import { Terminal } from '@travetto/terminal';
 
 import { Context } from './bin/context.ts';
@@ -16,9 +16,11 @@ export class ScaffoldCommand implements CliCommandShape {
   /** Template */
   template = 'todo';
   /** Current Working Directory override */
-  cwd: string = path.resolve();
+  @CliFlag({ short: 'c', full: 'cwd' })
+  workingDirectory: string = path.resolve();
   /** Target Directory */
-  dir?: string;
+  @CliFlag({ short: 'd', full: 'dir' })
+  targetDirectory?: string;
   /** Force writing into an existing directory */
   force = false;
 
@@ -42,24 +44,26 @@ export class ScaffoldCommand implements CliCommandShape {
       name: 'choice',
       message: 'Please select one',
       initial: feature.default,
-      choices: feature.choices!.map(x => x.title).filter((x?: string): x is string => !!x),
+      choices: feature.choices!
+        .map(subFeature => subFeature.title)
+        .filter((name?: string): name is string => !!name),
     };
 
     const response = await prompt<{ choice: string }>(choice);
-    return feature.choices?.find(x => x.title === response.choice);
+    return feature.choices?.find(subFeature => subFeature.title === response.choice);
   }
 
   async * #resolveFeatures(features: Feature[], chosen = false, depth = 0): AsyncGenerator<Feature> {
     for (const feat of features) {
       if (!chosen && !feat.required) {
-        const ans = await prompt<{ choice: boolean | string }>([{
+        const answer = await prompt<{ choice: boolean | string }>([{
           type: 'confirm',
           name: 'choice',
           message: `${'='.repeat(depth * 2)}${depth > 0 ? '| ' : ''}Include ${feat.title} support?`,
           initial: true
         }]);
 
-        if (ans.choice === 'No' || ans.choice === false) {
+        if (answer.choice === 'No' || answer.choice === false) {
           continue;
         }
       }
@@ -82,15 +86,15 @@ export class ScaffoldCommand implements CliCommandShape {
   async main(name?: string): Promise<void> {
     name = await this.#getName(name);
 
-    if (!name && this.dir) {
-      name = path.basename(this.dir);
-    } else if (name && !this.dir) {
-      this.dir = path.resolve(this.cwd, name);
-    } else if (!name && !this.dir) {
+    if (!name && this.targetDirectory) {
+      name = path.basename(this.targetDirectory);
+    } else if (name && !this.targetDirectory) {
+      this.targetDirectory = path.resolve(this.workingDirectory, name);
+    } else if (!name && !this.targetDirectory) {
       throw new Error('Either a name or a target directory are required');
     }
 
-    const ctx = new Context(name, this.template, path.resolve(this.cwd, this.dir!));
+    const ctx = new Context(name, this.template, path.resolve(this.workingDirectory, this.targetDirectory!));
 
     if (!this.force) {
       await ctx.initialize();