@yeoman/types 0.1.4 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -55,5 +55,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "97588cdda4231d1e760707bca22f4bec65785cd3"
+  "gitHead": "6d33420db41115e6d1867dede74000470d245a6e"
 }

package/types/environment/adapter.d.ts

@@ -36,14 +36,12 @@ export type InputOutputAdapter = {
    * Close underline inputs.
    */
   close(): void;
+};
 
-  /**
-   * Shows a color-based diff of two strings.
-   *
-   * @param actual The actual text.
-   * @param expected The expected text.
-   * @param changes The changes returned by `diff`.
-   * @returns The formatted message.
-   */
-  diff(actual: string, expected: string, changes: unknown[]): string;
+type Task<TaskResultType> =
+  | ((adapter: InputOutputAdapter) => PromiseLike<TaskResultType>)
+  | ((adapter: InputOutputAdapter) => TaskResultType);
+
+export type QueuedAdapter = InputOutputAdapter & {
+  queue<TaskResultType>(fn: Task<TaskResultType>): Promise<void | TaskResultType>;
 };

package/types/environment/environment.d.ts

@@ -2,7 +2,7 @@ import type { Transform } from 'node:stream';
 import type { Store } from 'mem-fs';
 import type { MemFsEditorFile } from 'mem-fs-editor';
 
-import type { GeneratorBaseOptions } from '../generator/generator-options.js';
+import type { BaseGeneratorOptions } from '../generator/generator-options.js';
 import type { BaseGenerator } from '../generator/generator.js';
 import type { GetGeneratorConstructor, GetGeneratorOptions } from '../generator/utils.js';
 import type { InputOutputAdapter } from './adapter.js';
@@ -12,7 +12,7 @@ export type EnvironmentConstructor<A extends InputOutputAdapter = InputOutputAda
   adapter?: A,
 ) => BaseEnvironment<A>;
 
-export type BaseEnvironmentOptions = GeneratorBaseOptions & {
+export type BaseEnvironmentOptions = BaseGeneratorOptions & {
   /**
    * The working-directory of the environment.
    */
@@ -26,7 +26,7 @@ export type BaseEnvironmentOptions = GeneratorBaseOptions & {
   /**
    * Options to pass to every generator instantiated by this Environment.
    */
-  sharedOptions?: GeneratorBaseOptions;
+  sharedOptions?: BaseGeneratorOptions;
 
   /**
    * `mem-fs` Store.
@@ -41,7 +41,7 @@ export type ApplyTransformsOptions = {
   streamOptions: Parameters<Store<MemFsEditorFile>['stream']>[0];
 };
 
-export type BaseEnvironment<A = InputOutputAdapter, S extends Store = Store> = {
+export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorFile> = Store<MemFsEditorFile>> = {
   cwd: string;
   adapter: A;
   sharedFs: S;
@@ -53,13 +53,13 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store = Store> = {
   create<G extends BaseGenerator = BaseGenerator>(
     namespaceOrPath: string | GetGeneratorConstructor<G>,
     args: string[],
-    options?: Partial<Omit<GetGeneratorOptions<G>, 'env' | 'resolved' | 'resolvec'>>,
+    options?: Partial<Omit<GetGeneratorOptions<G>, 'env' | 'resolved' | 'namespace'>>,
   ): Promise<G>;
 
   instantiate<G extends BaseGenerator = BaseGenerator>(
     generator: GetGeneratorConstructor<G>,
     args: string[],
-    options?: Partial<Omit<GetGeneratorOptions<G>, 'env' | 'resolved' | 'resolvec'>>,
+    options?: Partial<Omit<GetGeneratorOptions<G>, 'env' | 'resolved' | 'namespace'>>,
   ): Promise<G>;
 
   /**
@@ -97,7 +97,7 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store = Store> = {
    * @param namespace The namespace under which the generator should be registered.
    * @param packagePath The path to the npm package of the generator.
    */
-  register(filePath: string, namespace?: string, packagePath?: string): Promise<void>;
+  register(filePath: string, namespace?: string, packagePath?: string): void;
 
   /**
    * Registers a stubbed generator to this environment.
@@ -115,7 +115,7 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store = Store> = {
    * @param task
    * @param options
    */
-  queueTask(priority: string, task: (...args: any[]) => void | Promise<void>, options?: { once?: string, startQueue?: boolean }): void;
+  queueTask(priority: string, task: (...args: any[]) => void | Promise<void>, options?: { once?: string; startQueue?: boolean }): void;
 
   /**
    * Add priority

package/types/environment/logger.d.ts

@@ -3,7 +3,18 @@ import type { format } from 'node:util';
 /**
  * Provides default color-categories.
  */
-export type DefaultLoggerCategories = 'skip' | 'force' | 'create' | 'invoke' | 'conflict' | 'identical' | 'info';
+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.
@@ -50,4 +61,10 @@ export type Logger<LoggerCategories extends string | number | symbol = DefaultLo
    * 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>;
 };

package/types/generator/generator-options.d.ts

@@ -2,7 +2,7 @@ import type { BaseEnvironment } from '../environment/environment.js';
 
 export type GeneratorCustomOptions = Record<string, unknown>;
 
-export type GeneratorBaseOptions = {
+export type BaseGeneratorOptions = {
   /**
    * Skip package manager install task.
    */
@@ -58,7 +58,7 @@ type GeneratorHelpOptions<H extends boolean | undefined> = {
   help: H;
 };
 
-export type GeneratorOptions = GeneratorBaseOptions &
+export type GeneratorOptions = BaseGeneratorOptions &
   GeneratorNamespace &
   (
     | (GeneratorHelpOptions<false | undefined> & GeneratorEnvironmentOptions)