@yeoman/types - npm Package Compare versions

Comparing version 0.5.0 to 1.0.0

package.json

		{
		"name": "@yeoman/types",
		"version": "0.5.0",
		"version": "1.0.0",
		"private": false,
		@@ -59,3 +59,3 @@ "description": "Common API for yeoman's generator/environment stack",
		},
		"gitHead": "3ed560f6ed88dc0e2cc414b77676462f2934aad2"
		"gitHead": "cb5b453d1e92fcc70874d4cdaea77cf90fdd60f7"
		}

types/environment/environment.d.ts

		@@ -1,2 +0,2 @@
		import type { Transform } from 'node:stream';
		import type { PipelineSource, Transform } from 'node:stream';
		import type { Store } from 'mem-fs';
		@@ -48,6 +48,9 @@ import type { MemFsEditorFile } from 'mem-fs-editor';
		log?: boolean;
		stream?: ReturnType<Store<MemFsEditorFile>['stream']>;
		stream?: PipelineSource<any>;
		streamOptions?: Parameters<Store<MemFsEditorFile>['stream']>[0];
		};

		/**
		* BaseEnvironment provides the api used by yeoman-test and yeoman-generator that should remain stable between major yeoman-environment versions.
		*/
		export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorFile> = Store<MemFsEditorFile>> = {
		@@ -59,2 +62,4 @@ cwd: 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;

		@@ -190,15 +195,2 @@ applyTransforms(transformStreams: Transform[], options?: ApplyTransformsOptions): Promise<void>;
		/**
		* Checks whether a package with the specified `packageNamespace` has been registered.
		*
		* @param packageNamespace The package-namespace to check.
		* @returns A value indicating whether a package with the specified `packageNamespace` has been registered.
		*/
		isPackageRegistered(packageNamespace: string): boolean;

		/**
		* Gets the namespaces of all registered packages.
		*/
		getRegisteredPackages(): string[];

		/**
		* Returns stored generators meta
		@@ -205,0 +197,0 @@ */

types/environment/methods-options.d.ts

		@@ -43,26 +43,17 @@ import type { GetGeneratorOptions, BaseGenerator, GetGeneratorConstructor } from '../index.js';
		/**
		* Provides information about a generator.
		* Provides lookup information about a generator.
		*/
		export type LookupGeneratorMeta = {
		/**
		* A value indicating whether the generator could be registered.
		*/
		registered: boolean;
		export type LookupGeneratorMeta = NotRegisteredLookupGeneratorMeta \| RegisteredLookupGeneratorMeta;

		/**
		* The resolved path to the generator.
		*/
		generatorPath?: string;
		export type NotRegisteredLookupGeneratorMeta = Required<BaseGeneratorMeta> & {
		/** Failed to register. */
		registered: false;
		};

		/**
		* The namespace of the generator.
		*/
		namespace?: string;
		export type RegisteredLookupGeneratorMeta = Required<BaseGeneratorMeta> &
		GeneratorMeta & {
		/** Successfully registered package. */
		registered: true;
		};

		/**
		* The path to the package containing the generator.
		*/
		packagePath?: string;
		};

		export type BaseGeneratorMeta = {
		@@ -69,0 +60,0 @@ /** The key under which the generator can be retrieved */

types/generator/generator.d.ts

		@@ -9,2 +9,6 @@ import type { BaseEnvironment } from '../environment/environment.js';

		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;

		_postConstruct?(): Promise<void>;
		@@ -11,0 +15,0 @@

New alerts