@yeoman/types 1.3.0 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -25,24 +25,21 @@
     "test": ""
   },
   "dependencies": {
-    "@types/node": "^16.18.26"
+    "@yeoman/adapter": "^1.6.0"
   },
   "devDependencies": {
-    "@types/inquirer": "^9.0.3",
-    "inquirer": "^9.3.6",
+    "@types/node": "16.18.26",
+    "@yeoman/adapter": "^1.6.0",
     "mem-fs": "^3.0.0",
     "mem-fs-editor": "^10.0.2"
   },
   "peerDependencies": {
-    "@types/inquirer": "^9.0.3",
-    "inquirer": "^9.2.2",
+    "@types/node": ">=16.18.26",
+    "@yeoman/adapter": "^1.6.0",
     "mem-fs": "^3.0.0",
     "mem-fs-editor": "^10.0.2"
   },
   "peerDependenciesMeta": {
-    "inquirer": {
-      "optional": true
-    },
     "mem-fs": {
       "optional": true
     },
@@ -58,8 +55,9 @@
     "registry": "https://registry.npmjs.org/"
   },
   "acceptDependencies": {
+    "@yeoman/adapter": "^2.0.0-beta.0",
     "mem-fs": "^4.0.0-beta.1",
     "mem-fs-editor": ">=10.0.2"
   },
-  "gitHead": "27aa4d0f591e1591ba0cadff64664e67dea32e5b"
+  "gitHead": "c348c764066d1a6159ac9da52a7ab5a417904abb"
 }

package/types/environment/environment.d.ts

@@ -5,7 +5,7 @@ import type { MemFsEditorFile } from 'mem-fs-editor';
 import type { BaseGeneratorOptions } from '../generator/generator-options.js';
 import type { BaseGenerator, BaseGeneratorConstructor } from '../generator/generator.js';
 import type { GetGeneratorConstructor } from '../generator/utils.js';
-import type { InputOutputAdapter } from './adapter.js';
+import type { InputOutputAdapter } from '@yeoman/adapter/types';
 import type {
   BaseGeneratorMeta,
   ComposeOptions,
@@ -72,9 +72,9 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorF
    */
   logCwd: string;
 
-  emit(eventName: string | symbol, ...args: any[]): boolean;
-  on(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
-  once(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
+  emit(eventName: string | symbol, ...arguments_: any[]): boolean;
+  on(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;
+  once(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;
 
   applyTransforms(transformStreams: Transform[], options?: ApplyTransformsOptions): Promise<void>;
 
@@ -178,7 +178,11 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorF
    * @param task
    * @param options
    */
-  queueTask(priority: string, task: (...args: any[]) => void | Promise<void>, options?: { once?: string; startQueue?: boolean }): void;
+  queueTask(
+    priority: string,
+    task: (...arguments_: any[]) => void | Promise<void>,
+    options?: { once?: string; startQueue?: boolean },
+  ): void;
 
   /**
    * Add priority

package/types/environment/methods-options.d.ts

@@ -71,7 +71,7 @@ export type GeneratorMeta = BaseGeneratorMeta & {
   /** Import the module `import(meta.resolved)` */
   importModule?: () => Promise<unknown>;
   /** Intantiate the Generator `env.instantiate(await meta.importGenerator())` */
-  instantiate: (args?: string[], options?: any) => Promise<BaseGenerator>;
+  instantiate: (arguments_?: string[], options?: any) => Promise<BaseGenerator>;
   /** Intantiate the Generator passing help option */
   instantiateHelp: () => Promise<BaseGenerator>;
 };

package/types/generator/generator.d.ts

@@ -6,9 +6,9 @@ export type EnvironmentGenerator = {
   readonly env: BaseEnvironment;
   readonly features: unknown;
 
-  emit(eventName: string | symbol, ...args: any[]): boolean;
-  on(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
-  once(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
+  emit(eventName: string | symbol, ...arguments_: any[]): boolean;
+  on(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;
+  once(eventName: string | symbol, listener: (...arguments_: any[]) => void): unknown;
 
   _postConstruct?(): Promise<void>;
 
@@ -38,4 +38,5 @@ export type BaseGenerator<
 export type BaseGeneratorConstructor<
   O extends GeneratorOptions = GeneratorOptions,
   F extends GeneratorFeatures = GeneratorFeatures,
-> = (new (args?: string[], options?: O, features?: F) => BaseGenerator<O, F>) & (new (options?: O, features?: F) => BaseGenerator<O, F>);
+> = (new (arguments_?: string[], options?: O, features?: F) => BaseGenerator<O, F>) &
+  (new (options?: O, features?: F) => BaseGenerator<O, F>);

package/types/index.d.ts

@@ -1,6 +1,5 @@
-export * from './environment/adapter.js';
+export * from '@yeoman/adapter/types';
 export * from './environment/environment.js';
-export * from './environment/logger.js';
 export * from './environment/methods-options.js';
 
 export * from './generator/generator-features.js';

package/types/environment/adapter.d.ts

@@ -1,51 +0,0 @@
-import type { DistinctQuestion, Answers as InquirerAnswers } from 'inquirer';
-import type { Logger } from './logger.js';
-
-/**
- * Represents an answer-hash.
- */
-export type PromptAnswers = InquirerAnswers;
-
-export type PromptQuestion<A extends PromptAnswers = PromptAnswers> = DistinctQuestion<A>;
-
-/**
- * Provides a set of questions.
- */
-export type PromptQuestions<A extends PromptAnswers = PromptAnswers> = PromptQuestion<A> | Array<PromptQuestion<A>>; // | Observable<Question<A>>;
-
-/**
- * Abstraction layer that defines the I/O interactions.
- *
- * It provides a CLI interaction
- */
-export type InputOutputAdapter = {
-  /**
-   * A component for logging messages.
-   */
-  log: Logger;
-
-  /**
-   * Prompts the user for one or more questions.
-   *
-   * @param questions The questions to prompt.
-   * @param initialAnswers Initial answers.
-   */
-  prompt<A extends PromptAnswers = PromptAnswers>(questions: PromptQuestions<A>, initialAnswers?: Partial<A>): Promise<A>;
-
-  /**
-   * Close underline inputs.
-   */
-  close(): void;
-};
-
-type Task<TaskResultType> =
-  | ((adapter: InputOutputAdapter) => PromiseLike<TaskResultType>)
-  | ((adapter: InputOutputAdapter) => TaskResultType);
-
-export type ProgressCallback<ReturnType> = (progress: { step: (prefix: string, message: string, ...args: any[]) => void }) => ReturnType;
-export type ProgressOptions = { disabled?: boolean; name?: string };
-
-export type QueuedAdapter = InputOutputAdapter & {
-  queue<TaskResultType>(fn: Task<TaskResultType>): Promise<void | TaskResultType>;
-  progress<ResultType>(fn: ProgressCallback<ResultType>, options?: ProgressOptions): Promise<void | ResultType>;
-};

package/types/environment/logger.d.ts

@@ -1,70 +0,0 @@
-import type { format } from 'node:util';
-
-/**
- * Provides default color-categories.
- */
-export type DefaultLoggerCategories = 'skip' | 'force' | 'create' | 'invoke' | 'conflict' | 'identical' | 'info' | 'added' | 'removed';
-
-export type ColoredMessage<Color extends string | number | symbol = DefaultLoggerCategories> = {
-  /**
-   * Text content.
-   */
-  message: string;
-  /**
-   * Color to apply.
-   */
-  color?: Color;
-};
-
-/**
- * Provides the functionality to log messages.
- */
-export type Logger<LoggerCategories extends string | number | symbol = DefaultLoggerCategories> = {
-  /**
-   * Logs a message of the specified category.
-   */
-  [P in LoggerCategories]: (...args: Parameters<typeof format>) => Logger<LoggerCategories>;
-} & {
-  /**
-   * Writes a log-message.
-   *
-   * @param format
-   * The format of the log-messages.
-   * See <https://github.com/mikeal/logref> for more info.
-   *
-   * @param params
-   * The parameters to replace variables with.
-   */
-  (format?: string, parameters?: Record<string, any>): Logger<LoggerCategories>;
-
-  /**
-   * Writes a log-message.
-   */
-  (message?: any, ...optionalParameters: any[]): Logger<LoggerCategories>;
-
-  /**
-   * Writes a log-message.
-   */
-  write(...args: Parameters<typeof format>): Logger<LoggerCategories>;
-
-  /**
-   * Writes a log-message with an appended newline character.
-   */
-  writeln(...args: Parameters<typeof format>): Logger<LoggerCategories>;
-
-  /**
-   * Writes a success status with a check mark `✔`.
-   */
-  ok(...args: Parameters<typeof format>): Logger<LoggerCategories>;
-
-  /**
-   * Writes an error-message with a prepended cross mark.
-   */
-  error(...args: Parameters<typeof format>): Logger<LoggerCategories>;
-
-  /**
-   * @since `yeoman-environment` version 3.17.0
-   * Shows a colored message.
-   */
-  colored(coloredMessage: Array<ColoredMessage<LoggerCategories>>): Logger<LoggerCategories>;
-};