@yeoman/types 1.5.0 → 1.7.0

package/README.md

@@ -0,0 +1,15 @@
+# @yeoman/types
+
+[![NPM version][npm-image]][npm-url]
+[![NPM Test](https://github.com/yeoman/yeoman-api/actions/workflows/ci.yml/badge.svg)](https://github.com/yeoman/yeoman-api/actions/workflows/ci.yml)
+
+> Stable types for yeoman's generator/environment stack
+
+Intended for internal yeoman generator/environment stack use.
+
+## License
+
+MIT © [The Yeoman Team](http://yeoman.io)
+
+[npm-image]: https://badge.fury.io/js/@yeoman%2Ftypes.svg
+[npm-url]: https://npmjs.org/package/@yeoman/types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -24,9 +24,6 @@
     "clean-all": "rimraf node_modules",
     "test": ""
   },
-  "dependencies": {
-    "@yeoman/adapter": "^1.6.0"
-  },
   "devDependencies": {
     "@types/node": "16.18.26",
     "@yeoman/adapter": "^1.6.0",
@@ -35,11 +32,14 @@
   },
   "peerDependencies": {
     "@types/node": ">=16.18.26",
-    "@yeoman/adapter": "^1.6.0",
-    "mem-fs": "^3.0.0",
-    "mem-fs-editor": "^10.0.2"
+    "@yeoman/adapter": "^1.6.0 || ^2.0.0-beta.0",
+    "mem-fs": "^3.0.0 || ^4.0.0-beta.1",
+    "mem-fs-editor": "^10.0.2 || >=10.0.2"
   },
   "peerDependenciesMeta": {
+    "@yeoman/adapter": {
+      "optional": true
+    },
     "mem-fs": {
       "optional": true
     },
@@ -54,10 +54,5 @@
     "access": "public",
     "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": "c348c764066d1a6159ac9da52a7ab5a417904abb"
+  "gitHead": "470cd91302fc306da2e51656f187943c4d5edd03"
 }

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

@@ -67,13 +67,18 @@ export type BaseGeneratorMeta = {
 export type GeneratorMeta = BaseGeneratorMeta & {
   packageNamespace?: string;
   /** Import and find the Generator Class */
-  importGenerator: () => Promise<GetGeneratorConstructor>;
+  importGenerator: <G extends BaseGenerator>() => Promise<
+    GetGeneratorConstructor<G> &
+      BaseGeneratorMeta & {
+        _meta?: GeneratorMeta;
+      }
+  >;
   /** Import the module `import(meta.resolved)` */
   importModule?: () => Promise<unknown>;
   /** Intantiate the Generator `env.instantiate(await meta.importGenerator())` */
-  instantiate: (arguments_?: string[], options?: any) => Promise<BaseGenerator>;
+  instantiate: <G extends BaseGenerator>(arguments_?: string[], options?: any) => Promise<G>;
   /** Intantiate the Generator passing help option */
-  instantiateHelp: () => Promise<BaseGenerator>;
+  instantiateHelp: <G extends BaseGenerator>() => Promise<G>;
 };
 
 export type InstantiateOptions<G extends BaseGenerator = BaseGenerator> = {

package/types/generator/generator.d.ts

@@ -1,4 +1,5 @@
 import type { BaseEnvironment } from '../environment/environment.js';
+import type { GeneratorMeta } from '../environment/methods-options.js';
 import type { GeneratorFeatures } from './generator-features.js';
 import type { GeneratorOptions } from './generator-options.js';
 
@@ -33,10 +34,12 @@ export type BaseGenerator<
 
   // Generator >= v5
   readonly features: F | undefined;
+
+  readonly _meta?: GeneratorMeta;
 };
 
-export type BaseGeneratorConstructor<
-  O extends GeneratorOptions = GeneratorOptions,
-  F extends GeneratorFeatures = GeneratorFeatures,
-> = (new (arguments_?: string[], options?: O, features?: F) => BaseGenerator<O, F>) &
-  (new (options?: O, features?: F) => BaseGenerator<O, F>);
+export type BaseGeneratorConstructor<O extends GeneratorOptions = GeneratorOptions, F extends GeneratorFeatures = GeneratorFeatures> = new (
+  arguments_?: string[],
+  options?: O,
+  features?: F,
+) => BaseGenerator<O, F>;

package/types/generator/utils.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable unicorn/prevent-abbreviations */
 import type { BaseGenerator, BaseGeneratorConstructor } from './generator.js';
 
 export type GetGeneratorOptions<T extends BaseGenerator = BaseGenerator> = T extends BaseGenerator<infer Options> ? Options : never;