@yeoman/types 0.1.3 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -29,11 +29,13 @@
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.3",
-    "mem-fs": "^3.0.0"
+    "mem-fs": "^3.0.0",
+    "mem-fs-editor": "^10.0.2"
   },
   "peerDependencies": {
     "@types/inquirer": "^9.0.3",
-    "mem-fs": "^3.0.0"
+    "mem-fs": "^3.0.0",
+    "mem-fs-editor": "^10.0.2"
   },
   "peerDependenciesMeta": {
     "inquirer": {
@@ -41,6 +43,9 @@
     },
     "mem-fs": {
       "optional": true
+    },
+    "mem-fs-editor": {
+      "optional": true
     }
   },
   "engines": {
@@ -50,5 +55,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "ea9353672f5eaac702e0e024f954f43f193ca627"
+  "gitHead": "1982816cfe6af4e92f999e344cf9b8539ff308eb"
 }

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

@@ -1,5 +1,6 @@
 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 { BaseGenerator } from '../generator/generator.js';
@@ -36,8 +37,8 @@ export type BaseEnvironmentOptions = GeneratorBaseOptions & {
 export type ApplyTransformsOptions = {
   name?: string;
   log?: boolean;
-  stream?: ReturnType<Store['stream']>;
-  streamOptions: Parameters<Store['stream']>[0];
+  stream?: ReturnType<Store<MemFsEditorFile>['stream']>;
+  streamOptions: Parameters<Store<MemFsEditorFile>['stream']>[0];
 };
 
 export type BaseEnvironment<A = InputOutputAdapter, S extends Store = Store> = {
@@ -114,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>;
 };