@travetto/scaffold 2.1.2 → 2.2.1

package/bin/cli-scaffold.ts

@@ -1,18 +1,24 @@
 import * as enquirer from 'enquirer';
 
 import { PathUtil, EnvUtil } from '@travetto/boot';
-import { BasePlugin } from '@travetto/cli/src/plugin-base';
+import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
 
 import { Context } from './lib/context';
 import { Feature, FEATURES } from './lib/features';
 
+type Options = {
+  template: OptionConfig<string>;
+  dir: OptionConfig<string>;
+  force: OptionConfig<boolean>;
+};
+
 /**
  * Plugin to run scaffolding
  */
-export class ScaffoldPlugin extends BasePlugin {
+export class ScaffoldPlugin extends BasePlugin<Options> {
   name = 'scaffold';
 
-  getOptions() {
+  getOptions(): Options {
     return {
       template: this.option({ def: 'todo', desc: 'Template' }),
       dir: this.option({ desc: 'Target Directory' }),
@@ -20,11 +26,11 @@ export class ScaffoldPlugin extends BasePlugin {
     };
   }
 
-  getArgs() {
+  getArgs(): string {
     return '[name]';
   }
 
-  async #getName(name?: string) {
+  async #getName(name?: string): Promise<string> {
     if (!name) {
       const res = await enquirer.prompt<{ name: string }>([
         {
@@ -39,14 +45,15 @@ export class ScaffoldPlugin extends BasePlugin {
   }
 
   async #chooseFeature(feature: Feature): Promise<Feature | undefined> {
-    const res = await enquirer.prompt<{ choice: string }>({
+    const choice: (Parameters<typeof enquirer['prompt']>[0] & { type: 'select' }) = {
       type: 'select' as const,
       name: 'choice',
       message: 'Please select one',
       initial: feature.default,
-      choices: feature.choices!.map(x => x.title),
-    } as Parameters<typeof enquirer['prompt']>[0]);
+      choices: feature.choices!.map(x => x.title).filter((x?: string): x is string => !!x),
+    };
 
+    const res = await enquirer.prompt<{ choice: string }>(choice);
     return feature.choices?.find(x => x.title === res.choice);
   }
 
@@ -79,11 +86,13 @@ export class ScaffoldPlugin extends BasePlugin {
     }
   }
 
-  async action(name?: string) {
+  async action(name?: string): Promise<void> {
     try {
       name = await this.#getName(name);
     } catch (err) {
-      console.error('Failed to provide correct input', err.message);
+      if (err instanceof Error) {
+        console.error('Failed to provide correct input', err.message);
+      }
       process.exit(1);
     }
 
@@ -100,7 +109,9 @@ export class ScaffoldPlugin extends BasePlugin {
         await ctx.addDependency(dep);
       }
     } catch (err) {
-      console.error('Failed to provide correct input', err.message);
+      if (err instanceof Error) {
+        console.error('Failed to provide correct input', err.message);
+      }
       process.exit(1);
     }
 

package/bin/lib/context.ts

@@ -2,7 +2,7 @@ import * as path from 'path';
 import * as fs from 'fs/promises';
 import * as mustache from 'mustache';
 
-import { EnvUtil, ExecUtil, FsUtil, PathUtil } from '@travetto/boot';
+import { EnvUtil, ExecUtil, ExecutionResult, FsUtil, PathUtil } from '@travetto/boot';
 import { version } from '@travetto/boot/package.json';
 
 import { Feature } from './features';
@@ -12,7 +12,7 @@ type Listing = Record<string, ListingEntry>;
 
 export class Context {
 
-  static #meetsRequirement(modules: string[], desired: string[]) {
+  static #meetsRequirement(modules: string[], desired: string[]): boolean {
     let valid = true;
     for (const mod of desired) {
       if (mod.endsWith('-')) {
@@ -46,43 +46,44 @@ export class Context {
     this.#targetDir = PathUtil.resolveUnix(targetDir);
   }
 
-  get modules() {
+  get modules(): Record<string, boolean> {
     if (!this.#modules) {
       this.#modules = this.#frameworkDependencies.map(x => x.split('/')).reduce((acc, [, v]) => ({ ...acc, [v]: true }), {});
     }
     return this.#modules;
   }
 
-  get frameworkDependencies() {
+  get frameworkDependencies(): string[] {
     return this.#frameworkDependencies;
   }
 
-  get peerDependencies() {
+  get peerDependencies(): string[] {
     return this.#peerDependencies;
   }
 
-  get moduleNames() {
+  get moduleNames(): string[] {
     return [...Object.keys(this.modules)].filter(x => !x.includes('-'));
   }
 
-  source(file?: string) {
+  source(file?: string): string {
     return PathUtil.resolveUnix(__dirname, '..', '..', 'templates', this.#template, ...file ? [file] : []);
   }
 
-  destination(file?: string) {
+  destination(file?: string): string {
     return PathUtil.resolveUnix(this.#targetDir, ...file ? [file] : []);
   }
 
-  get sourceListing() {
+  get sourceListing(): Promise<Listing> {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return import(this.source('listing.json')) as Promise<Listing>;
   }
 
-  async resolvedSourceListing() {
+  async resolvedSourceListing(): Promise<[string, ListingEntry][]> {
     return Object.entries(await this.sourceListing)
       .filter(([, conf]) => !conf.requires || Context.#meetsRequirement(this.#frameworkDependencies, conf.requires));
   }
 
-  async initialize() {
+  async initialize(): Promise<void> {
     let base = this.destination();
     while (base) {
       if (await FsUtil.exists(`${base}/package.json`)) {
@@ -96,7 +97,7 @@ export class Context {
     }
   }
 
-  async template(file: string, { rename }: ListingEntry) {
+  async template(file: string, { rename }: ListingEntry): Promise<void> {
     const contents = await fs.readFile(this.source(file), 'utf-8');
     const out = this.destination(rename ?? file);
     const rendered = mustache.render(contents, this).replace(/^\s*(\/\/|#)\s*\n/gsm, '');
@@ -104,13 +105,13 @@ export class Context {
     await fs.writeFile(out, rendered, 'utf8');
   }
 
-  async templateResolvedFiles() {
+  async templateResolvedFiles(): Promise<void> {
     for (const [key, config] of await this.resolvedSourceListing()) {
       await this.template(key, config);
     }
   }
 
-  async addDependency(feat: Feature) {
+  async addDependency(feat: Feature): Promise<void> {
     if (feat.npm.startsWith('@travetto')) {
       this.#frameworkDependencies.push(feat.npm);
     } else {
@@ -122,7 +123,7 @@ export class Context {
     }
   }
 
-  exec(cmd: string, args: string[]) {
+  exec(cmd: string, args: string[]): Promise<ExecutionResult> {
     return ExecUtil.spawn(cmd, args, { cwd: this.destination(), stdio: [0, 1, 2], isolatedEnv: true }).result;
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/scaffold",
   "displayName": "App Scaffold",
-  "version": "2.1.2",
+  "version": "2.2.1",
   "description": "App Scaffold for the Travetto framework",
   "keywords": [
     "generator",
@@ -32,8 +32,8 @@
     "trv-scaffold": "./bin/trv-scaffold.js"
   },
   "dependencies": {
-    "@travetto/boot": "^2.1.2",
-    "@travetto/cli": "^2.1.2",
+    "@travetto/boot": "^2.2.1",
+    "@travetto/cli": "^2.2.1",
     "mustache": "^4.2.0",
     "enquirer": "^2.3.6"
   },

package/templates/todo/eslintrc.json

@@ -24,7 +24,9 @@
   ],
   "rules": {
     "@typescript-eslint/array-type": "error",
-    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-function-return-type": [
+      "off"
+    ],
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/no-explicit-any": "warn",
     "@typescript-eslint/explicit-member-accessibility": [
@@ -39,10 +41,14 @@
       2,
       {
         "ignoredNodes": [
+          "PropertyDefinition[decorators]",
+          "TSUnionType",
+          "TSTypeParameterInstantiation",
           "FunctionExpression > .params[decorators.length > 0]",
           "FunctionExpression > .params > :matches(Decorator, :not(:first-child))",
           "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
-        ]
+        ],
+        "SwitchCase": 1
       }
     ],
     "@typescript-eslint/member-delimiter-style": [
@@ -209,6 +215,28 @@
           "PascalCase",
           "camelCase"
         ]
+      },
+      {
+        "selector": "objectLiteralProperty",
+        "modifiers": [
+          "requiresQuotes"
+        ],
+        "format": null,
+        "custom": {
+          "regex": ".*",
+          "match": true
+        }
+      },
+      {
+        "selector": "objectLiteralMethod",
+        "modifiers": [
+          "requiresQuotes"
+        ],
+        "format": null,
+        "custom": {
+          "regex": ".*",
+          "match": true
+        }
       }
     ],
     "curly": "error",
@@ -297,6 +325,12 @@
           ]
         }
       }
+    ],
+    "@typescript-eslint/consistent-type-assertions": [
+      "warn",
+      {
+        "assertionStyle": "never"
+      }
     ]
   },
   "overrides": [