Lint Plugin Types (#1032)

* fix: add eslint config for types

* chore: lint all plugin types

* Temp: ts-ignores

* fix: tests

* fix: disable jsdoc rules for ts

Author: kbader-godaddy

package-lock.json

@@ -2,7 +2,7 @@
   "name": "@gasket/repository",
   "private": true,
   "version": "0.0.0",
-  "description": "Robust, pluggable, & render agnostic framework for rapid deliver modern web applications.",
+  "description": "Robust, pluggable, & render agnostic framework for rapid delivery of modern web applications.",
   "scripts": {
     "lint": "eslint scripts",
     "lint:fix": "npm run lint -- --fix",
@@ -53,7 +53,7 @@
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "eslint": "^8.56.0",
     "eslint-config-godaddy": "^7.1.1",
-    "eslint-plugin-json": "^3.1.0",
+    "eslint-config-godaddy-typescript": "^4.0.3",
     "eslint-plugin-unicorn": "^55.0.0",
     "jsdom": "^20.0.0",
     "lerna": "^8.1.8",

package.json

@@ -4,23 +4,21 @@ import { makeCreateContext } from '../scaffold/create-context.js';
 import { dumpErrorContext } from '../scaffold/dump-error-context.js';
 import { rm } from 'fs/promises';
 import { makeGasket } from '@gasket/core';
-import {
-  createHooks,
-  generateFiles,
-  globalPrompts,
-  installModules,
-  linkModules,
-  loadPreset,
-  mkDir,
-  postCreateHooks,
-  printReport,
-  presetPromptHooks,
-  presetConfigHooks,
-  promptHooks,
-  setupPkg,
-  writeGasketConfig,
-  writePkg
-} from '../scaffold/actions/index.js';
+import globalPrompts from '../scaffold/actions/global-prompts.js';
+import loadPreset from '../scaffold/actions/load-preset.js';
+import presetPromptHooks from '../scaffold/actions/preset-prompt-hooks.js';
+import presetConfigHooks from '../scaffold/actions/preset-config-hooks.js';
+import promptHooks from '../scaffold/actions/prompt-hooks.js';
+import mkDir from '../scaffold/actions/mkdir.js';
+import setupPkg from '../scaffold/actions/setup-pkg.js';
+import createHooks from '../scaffold/actions/create-hooks.js';
+import writePkg from '../scaffold/actions/write-pkg.js';
+import generateFiles from '../scaffold/actions/generate-files.js';
+import writeGasketConfig from '../scaffold/actions/write-gasket-config.js';
+import installModules from '../scaffold/actions/install-modules.js';
+import linkModules from '../scaffold/actions/link-modules.js';
+import postCreateHooks from '../scaffold/actions/post-create-hooks.js';
+import printReport from '../scaffold/actions/print-report.js';
 
 /**
  * Parses comma separated option input to array
@@ -94,9 +92,10 @@ const createCommand = {
 
 /**
  * createCommand action
- * @type {import('../index').createCommandAction}
+ * @type {import('create-gasket-app').createCommandAction}
  */
 createCommand.action = async function run(appname, options, command) {
+  // eslint-disable-next-line no-process-env
   process.env.GASKET_ENV = 'create';
   const context = makeCreateContext([appname], options);
   const { rawPresets, localPresets } = context;
@@ -105,7 +104,6 @@ createCommand.action = async function run(appname, options, command) {
     await globalPrompts({ context });
 
     if (rawPresets.length || localPresets.length) {
-
       await loadPreset({ context });
 
       const presetGasket = makeGasket({
@@ -134,6 +132,7 @@ createCommand.action = async function run(appname, options, command) {
     if (context.tmpDir) await rm(context.tmpDir, { recursive: true });
     printReport({ context });
   } catch (err) {
+    // eslint-disable-next-line no-console
     console.error(chalk.red('Exiting with errors.'));
     dumpErrorContext(context, err);
     throw err;

packages/create-gasket-app/lib/commands/create.js

@@ -1,7 +1,9 @@
-import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine } from '@gasket/core';
+/* eslint-disable no-use-before-define */
+import type { GasketConfigDefinition, MaybeAsync, Plugin, GasketEngine, CreateContext } from '@gasket/core';
 import type { PackageManager } from '@gasket/utils';
 import type { PromptModule } from 'inquirer';
 import type ora from 'ora';
+import type { Command } from 'commander';
 
 export interface Dependencies {
   dependencies?: Record<string, string>;
@@ -48,14 +50,14 @@ interface CommandOption {
 export function createCommandAction(
   appname: string,
   options: CreateCommandOptions,
-  command: Command 
+  command: Command
 ): Promise<void>;
 
 export interface CreateCommand {
   id: string;
   description: string;
   args: CommandArgument[];
-  action?: createGasketAction;
+  action?: typeof createCommandAction;
   options: CommandOption[];
   hidden?: boolean;
   default?: boolean;
@@ -100,7 +102,6 @@ export interface ConfigBuilder<Config> {
   /**
    * Performs an intelligent, domain-aware merge of the `value` for
    * the given `key` into the package.json fields associated with this instance.
-   *
    * @param key - Field in package.json to add or extend.
    * @param value - Target value to set for key provided.
    * @param source - Plugin to blame if conflicts arise from this operation.
@@ -214,9 +215,9 @@ interface Files {
   /**
    * Adds the specified `globby` compatible patterns, `globs`,
    * into the set of all sources for this set of files.
-   * @param {Object} params - Object containing `globs` and `source`.
+   * @param {object} params - Object containing `globs` and `source`.
    * @param {string[]} params.globs - `globby` compatible patterns.
-   * @param {Object} params.source - Plugin to blame if conflicts arise from this operation.
+   * @param {object} params.source - Plugin to blame if conflicts arise from this operation.
    */
   add(params: { globs: string[], source: object }): void;
   add(...globs: string[]): void;
@@ -275,7 +276,7 @@ interface Files {
     force?: boolean;
   }): void;
 
-    /**
+  /**
    * Normalizes a potential semver range into a semver string
    * and returns the newest version
    * @param  {string} r1 Semver string (potentially invalid).
@@ -287,7 +288,7 @@ interface Files {
    */
   tryGetNewerRange(r1: string, r2: string): string | undefined;
 
-    /**
+  /**
    * Performs a naive attempt to take a transform a semver range
    * into a concrete version that may be used for "newness"
    * comparison.
@@ -301,9 +302,9 @@ interface Files {
    * the `orderFields` options having their keys sorted.
    * @returns {object} Ready to be serialized JavaScript object.
    */
-    toJSON(): object;
+  toJSON(): object;
 
-    /**
+  /**
    * Orders the given object, `obj`, applying any (optional)
    * key order specified via `orderBy`. If no `orderBy` is provided
    * keys are ordered lexographically.
@@ -384,8 +385,10 @@ declare module 'create-gasket-app' {
     /** paths to the local presets packages */
     localPresets: Array<string>;
 
-    /** Raw preset desc from args. Can include version constraint. Added by
-     * load-preset if using localPresets. */
+    /**
+     * Raw preset desc from args. Can include version constraint. Added by
+     * load-preset if using localPresets.
+     */
     rawPresets: Array<string>;
 
     /** Local packages that should be linked */
@@ -461,8 +464,8 @@ declare module 'create-gasket-app' {
 
     /** Use to add content to the README.md */
     readme: Readme;
-    
-    constructor(initContext?: Partial<T>);
+
+    constructor(initContext?: Partial<CreateContext>);
     runWith(plugin: Plugin): Proxy<CreateContext>;
     typescript?: boolean;
   }

packages/create-gasket-app/lib/index.d.ts

@@ -1,14 +1,14 @@
-import { Gasket } from '@gasket/core';
 import type {
   CreateContext,
   CreatePrompt,
   ConfigBuilder,
   CreateCommand,
   CommandArgument,
-  CommandOption
-} from './index';
-import type { GasketEngine, Plugin } from '@gasket/core';
-import type ora from 'ora';
+  CommandOption,
+  CreateCommandOptions
+} from 'create-gasket-app';
+import type { GasketEngine, Plugin, Gasket } from '@gasket/core';
+import type { Ora } from 'ora';
 import type { Command, Option } from 'commander';
 
 
@@ -29,47 +29,91 @@ export function makeCreateContext(argv?: string[], options?: CreateCommandOption
 
 export function makeCreateRuntime(context: PartialCreateContext, source: Plugin): Proxy<CreateContext>;
 
-export function spinnerAction({ gasket, context, spinner } : {
-  gasket?: GasketEngine;
-  context?: CreateContext;
-  spinner?: ora.Ora
-}): Promise<void>;
-export function withSpinnerWrapper({ gasket, context } : { gasket: GasketEngine, context: CreateContext }): Promise<void>; 
+/**
+ * Represents the execution context for a task.
+ */
+export interface SpinnerContext {
+  gasket?: Gasket;
+  context: PartialCreateContext;
+  spinner: Ora;
+}
+
+/**
+ * Task function type that runs within a spinner wrapper.
+ */
+export type SpinnerTask = (params: SpinnerContext) => Promise<void>;
+
+/**
+ * Options for the spinner wrapper.
+ */
+export interface SpinnerOptions {
+  startSpinner?: boolean;
+}
+
+/**
+ * Wraps a task with a spinner, handling success and failure states.
+ */
+export function wrapWithSpinner(
+  label: string,
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { context: SpinnerContext['context'] } & {
+  errors?: Error[]
+}) => Promise<void>;
+
+/**
+ * Wraps a task with a spinner, using both gasket and context.
+ */
+export function withGasketSpinner(
+  label: string,
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { gasket: any; context: SpinnerContext['context'] }) => Promise<void>;
+
+/**
+ * Wraps a task with a spinner, using only context.
+ */
 export function withSpinner(
   label: string,
-  fn: spinnerAction,
-  options?: { startSpinner?: boolean }
-): withSpinnerWrapper
+  task: SpinnerTask,
+  options?: SpinnerOptions
+): (context: { context: SpinnerContext['context'] }) => Promise<void>;
+
+export function spinnerAction(params: {
+  gasket?: GasketEngine;
+  context: PartialCreateContext;
+  spinner?: Ora
+}): Promise<void>;
+
+export function execute(params: { gasket: Gasket, context: PartialCreateContext } & {
+  errors?: Error[]
+}): Promise<void>;
 
 /** sacaffold/actions */
 
-export function createHooks({ gasket, context } : { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function createHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
 
-export function chooseAppDescription(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function choosePackageManager(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function chooseTestPlugins(context: CreateContext, prompt: CreatePrompt): Promise<void>;
+export function chooseAppDescription(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function choosePackageManager(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function chooseTestPlugins(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
 export function promptForTestPlugin(
-  prompt: CreatePrompt, 
-  message: string, 
+  prompt: CreatePrompt,
+  message: string,
   choices: { name: string; value: string; }[]
 ): Promise<string | null>;
-export function allowExtantOverwriting(context: CreateContext, prompt: CreatePrompt): Promise<void>;
-export function globalPrompts({ context } : { context: CreateContext }): Promise<void>;
-
-export function loadPresets({ context } : { context: CreateContext }): Promise<void>;
-
-export function presetPromptHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function allowExtantOverwriting(context: PartialCreateContext, prompt: CreatePrompt): Promise<void>;
+export function globalPrompts(params: { context: PartialCreateContext }): Promise<void>;
+export function loadPresets(params: { context: PartialCreateContext }): Promise<void>;
+export function presetPromptHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function presetConfigHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function promptHooks(params: { gasket?: Gasket; context: PartialCreateContext }): Promise<void>;
+export function execPluginPrompts(gasket: Gasket, context: PartialCreateContext): Promise<void>;
 
-export function presetConfigHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
+export function mkDir({ context, spinner }: { context: CreateContext, spinner: Ora }): Promise<void>;
 
-export function promptHooks({ gasket, context }: { gasket: GasketEngine; context: CreateContext }): Promise<void>;
-export function execPluginPrompts(gasket: GasketEngine, context: CreateContext): Promise<void>;
+export function setupPkg(params: { context: PartialCreateContext }): Promise<void>;
 
-export function mkDir({ context, spinner }: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
-
-export function setupPkg({ context }: { context: CreateContext }): Promise<void>;
-
-export function writePkg({ context }: { context: CreateContext }): Promise<void>;
+export function writePkg(params: { context: PartialCreateContext }): Promise<void>;
 
 export type Descriptior = {
   pattern: string;
@@ -80,28 +124,30 @@ export type Descriptior = {
   from: string;
   overrides?: string;
 }
-export function generateFiles({ context, spinner }: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
+export function generateFiles({ context, spinner }: { context: CreateContext, spinner: Ora }): Promise<void>;
 export function performGenerate(context: CreateContext, descriptors: Descriptior[]): boolean[];
 export function getDescriptors(context: CreateContext): Promise<Descriptior[]>;
-export function assembleDescriptors(dest: string, from: string, pattern: string, srcPaths: sring[]): Descriptior[];
+export function assembleDescriptors(dest: string, from: string, pattern: string, srcPaths: string[]): Descriptior[];
 export function reduceDescriptors(descriptors: Descriptior[]): Descriptior[];
 
-export function writeGasketConfig({ context }: { context: CreateContext }): Promise<void>;
+export function writeGasketConfig(params: { context: PartialCreateContext }): Promise<void>;
 export function writeImports(imports: object | null): string;
 export function writeExpressions(expressions: string[] | null): string;
 export function createInjectionAssignments(config: object, assignments: (object | null)): string;
 export function cleanupFields(config: ConfigBuilder): void;
 export function writePluginImports(plugins: string[]): string;
 export function replaceInjectionAssignments(content: string, assignments: (object | null)): string;
 
-export function installModules({ context }: { context: CreateContext }): Promise<void>;
+export function installModules(params: { context: PartialCreateContext }): Promise<void>;
 
-export function linkModules({context, spinner}: { context: CreateContext, spinner: ora.Ora }): Promise<void>;
+export function linkModules(params: { context: CreateContext, spinner: Ora }): Promise<void>;
 
-export function postCreateHooks({ gasket, context }: { gasket: GasketEngine, context: CreateContext }): Promise<void>;
+export function postCreateHooks(params: { gasket?: Gasket, context: PartialCreateContext }): Promise<void>;
 
-export function printReport({ context }: { context: CreateContext }): Promise<void>;
-export function buildReport(context: CreateContext): {
+export function printReport(params: {
+  context: PartialCreateContext
+}): Promise<void>;
+export function buildReport(context: PartialCreateContext): {
   appName?: string;
   output?: string;
   generatedFiles?: string[];
@@ -119,15 +165,14 @@ export function isValidCommand(command: CreateCommand): boolean;
 export function processArgs(args: CommandArgument[]): [string, string?, any?][];
 export function isValidArg(arg: CommandArgument): boolean;
 
-interface OptionDefinition { 
+interface OptionDefinition {
   options: [string, string];
   conflicts: CommandOption['conflicts'];
   hidden: CommandOption['hidden'];
   required: CommandOption['required'];
   defaultValue: CommandOption['default'];
   parse: CommandOption['parse']
-};
+}
 export function isValidOption(option: CommandOption): boolean;
-export function processOptions(options: CommandOption[]): OptionDefinition[]
-
-export function createOption(definition: OptionDefinition): Option
+export function processOptions(options: CommandOption[]): OptionDefinition[];
+export function createOption(definition: OptionDefinition): Option;