@biorate/hygen 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +14 -14
  2. package/dist/cjs/src/config-resolver.js +4 -11
  3. package/dist/cjs/src/constants/config.js +5 -0
  4. package/dist/cjs/src/constants/engine.js +4 -0
  5. package/dist/cjs/src/constants/hooks.js +18 -0
  6. package/dist/cjs/src/constants/index.js +19 -0
  7. package/dist/cjs/src/engine.js +14 -14
  8. package/dist/cjs/src/errors.js +19 -1
  9. package/dist/cjs/src/help.js +3 -3
  10. package/dist/cjs/src/params-schema/index.js +11 -0
  11. package/dist/cjs/src/params-schema/prompts.js +34 -0
  12. package/dist/cjs/src/params-schema/registry.js +92 -0
  13. package/dist/cjs/src/params.js +21 -5
  14. package/dist/cjs/src/picker.js +55 -0
  15. package/dist/cjs/src/prompt.js +39 -69
  16. package/dist/cjs/src/ts-node-register.js +36 -0
  17. package/dist/cjs/src/types/config.js +2 -0
  18. package/dist/cjs/src/types/helpers-ns.js +2 -0
  19. package/dist/cjs/src/types/hooks.js +2 -0
  20. package/dist/cjs/src/types/index.js +28 -0
  21. package/dist/cjs/src/types/inflection.js +2 -0
  22. package/dist/cjs/src/types/logger.js +2 -0
  23. package/dist/cjs/src/types/ops.js +2 -0
  24. package/dist/cjs/src/types/params-schema.js +2 -0
  25. package/dist/cjs/src/types/params.js +2 -0
  26. package/dist/cjs/src/types/prompter-ns.js +2 -0
  27. package/dist/cjs/src/types/prompter.js +2 -0
  28. package/dist/cjs/src/types/results.js +2 -0
  29. package/dist/esm/src/config-resolver.js +3 -9
  30. package/dist/esm/src/constants/config.js +2 -0
  31. package/dist/esm/src/constants/engine.js +1 -0
  32. package/dist/esm/src/constants/hooks.js +15 -0
  33. package/dist/esm/src/constants/index.js +3 -0
  34. package/dist/esm/src/engine.js +10 -10
  35. package/dist/esm/src/errors.js +15 -0
  36. package/dist/esm/src/help.js +1 -1
  37. package/dist/esm/src/params-schema/index.js +2 -0
  38. package/dist/esm/src/params-schema/prompts.js +30 -0
  39. package/dist/esm/src/params-schema/registry.js +84 -0
  40. package/dist/esm/src/params.js +19 -2
  41. package/dist/esm/src/picker.js +48 -0
  42. package/dist/esm/src/prompt.js +34 -64
  43. package/dist/esm/src/ts-node-register.js +11 -0
  44. package/dist/esm/src/types/config.js +1 -0
  45. package/dist/esm/src/types/helpers-ns.js +1 -0
  46. package/dist/esm/src/types/hooks.js +1 -0
  47. package/dist/esm/src/types/index.js +12 -0
  48. package/dist/esm/src/types/inflection.js +1 -0
  49. package/dist/esm/src/types/logger.js +1 -0
  50. package/dist/esm/src/types/ops.js +1 -0
  51. package/dist/esm/src/types/params-schema.js +1 -0
  52. package/dist/esm/src/types/params.js +1 -0
  53. package/dist/esm/src/types/prompter-ns.js +1 -0
  54. package/dist/esm/src/types/prompter.js +1 -0
  55. package/dist/esm/src/types/results.js +1 -0
  56. package/dist/types/src/config-resolver.d.ts +0 -1
  57. package/dist/types/src/constants/config.d.ts +2 -0
  58. package/dist/types/src/constants/engine.d.ts +1 -0
  59. package/dist/types/src/constants/hooks.d.ts +4 -0
  60. package/dist/types/src/constants/index.d.ts +3 -0
  61. package/dist/types/src/context.d.ts +1 -1
  62. package/dist/types/src/errors.d.ts +9 -0
  63. package/dist/types/src/helpers.d.ts +1 -13
  64. package/dist/types/src/index.d.ts +1 -0
  65. package/dist/types/src/ops/anchors.d.ts +0 -3
  66. package/dist/types/src/ops/index.d.ts +1 -2
  67. package/dist/types/src/params-schema/index.d.ts +2 -0
  68. package/dist/types/src/params-schema/prompts.d.ts +2 -0
  69. package/dist/types/src/params-schema/registry.d.ts +6 -0
  70. package/dist/types/src/params.d.ts +1 -2
  71. package/dist/types/src/picker.d.ts +2 -0
  72. package/dist/types/src/prompt.d.ts +4 -18
  73. package/dist/types/src/ts-node-register.d.ts +2 -0
  74. package/dist/types/src/types/attributes.d.ts +18 -0
  75. package/dist/types/src/types/config.d.ts +26 -0
  76. package/dist/types/src/types/helpers-ns.d.ts +4 -0
  77. package/dist/types/src/types/hooks.d.ts +39 -0
  78. package/dist/types/src/types/index.d.ts +12 -0
  79. package/dist/types/src/types/inflection.d.ts +12 -0
  80. package/dist/types/src/types/logger.d.ts +8 -0
  81. package/dist/types/src/types/ops.d.ts +7 -0
  82. package/dist/types/src/types/params-schema.d.ts +9 -0
  83. package/dist/types/src/types/params.d.ts +14 -0
  84. package/dist/types/src/types/prompter-ns.d.ts +4 -0
  85. package/dist/types/src/types/prompter.d.ts +3 -0
  86. package/dist/types/src/types/results.d.ts +27 -0
  87. package/package.json +2 -2
  88. package/dist/types/src/types.d.ts +0 -121
  89. /package/dist/cjs/src/{types.js → types/attributes.js} +0 -0
  90. /package/dist/esm/src/{types.js → types/attributes.js} +0 -0
package/README.md CHANGED
@@ -106,20 +106,20 @@ For the full API reference see the [typedoc](https://biorate.github.io/core/modu
106
106
 
107
107
  The complete user guide lives in the package's local `docs/` pages. README is for the overview, quick start, and embedding; `docs/` is the full guide; typedoc is the generated API reference.
108
108
 
109
- | Page | Contents |
110
- | ---------------------------------------- | ------------------------------------------------------------------------------------------------ |
111
- | [quick-start](./docs/quick-start.md) | CLI installation, `init`, generator creation, `--version`. |
112
- | [templates](./docs/templates.md) | Template & frontmatter reference: `add`, `inject`, `sh`, anchors, `replace`, escaping. |
113
- | [generators](./docs/generators.md) | Building and organizing reusable generators. |
114
- | [prompts](./docs/prompts.md) | Prompt hooks reference: file names, `params`/`prompt`/array forms, filtering, TS. |
115
- | [extensibility](./docs/extensibility.md) | Extending hygen via the project config file: helpers, logger, template location, shell executor. |
116
- | [packages](./docs/packages.md) | Sharing compiled generators as publishable packages (`hygen-add`). |
117
- | [create](./docs/create.md) | Turning existing code into a generator (`hygen-create`). |
118
- | [faq](./docs/faq.md) | Why hygen and its position among generator toolkits. |
119
- | [express](./docs/express.md) | Express.js app generation pattern. |
120
- | [redux](./docs/redux.md) | Redux (ducks) app generation pattern. |
121
- | [react-native](./docs/react-native.md) | React Native app generation pattern. |
122
- | [standalone](./docs/standalone.md) | Standalone binary distribution. |
109
+ | Page | Contents |
110
+ | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
111
+ | [quick-start](./docs/quick-start.md) | CLI installation, `init`, generator creation, `--version`. |
112
+ | [templates](./docs/templates.md) | Template & frontmatter reference: `add`, `inject`, `sh`, anchors, `replace`, escaping. |
113
+ | [generators](./docs/generators.md) | Building and organizing reusable generators. |
114
+ | [prompts](./docs/prompts.md) | Prompt hooks reference: file names, `params`/`prompt`/array forms, filtering, TS. |
115
+ | [extensibility](./docs/extensibility.md) | Extending hygen via the project config file: helpers, logger, template location, shell executor; action hook classes, the declarative `params` schema and `argCase` flag normalization. |
116
+ | [packages](./docs/packages.md) | Sharing compiled generators as publishable packages (`hygen-add`). |
117
+ | [create](./docs/create.md) | Turning existing code into a generator (`hygen-create`). |
118
+ | [faq](./docs/faq.md) | Why hygen and its position among generator toolkits. |
119
+ | [express](./docs/express.md) | Express.js app generation pattern. |
120
+ | [redux](./docs/redux.md) | Redux (ducks) app generation pattern. |
121
+ | [react-native](./docs/react-native.md) | React Native app generation pattern. |
122
+ | [standalone](./docs/standalone.md) | Standalone binary distribution. |
123
123
 
124
124
  ## Differences from upstream
125
125
 
@@ -26,23 +26,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
26
26
  return (mod && mod.__esModule) ? mod : { "default": mod };
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.CONFIG_FILES = void 0;
30
29
  const path_1 = __importDefault(require("path"));
31
30
  const fs_extra_1 = __importDefault(require("fs-extra"));
32
31
  const config_1 = require("./config");
33
32
  const errors_1 = require("./errors");
34
- exports.CONFIG_FILES = ['.hygen.js', '.hygen.cjs', '.hygen.mjs', '.hygen.ts'];
35
- const configResolver = new config_1.ConfigResolver(exports.CONFIG_FILES, {
33
+ const ts_node_register_1 = __importDefault(require("./ts-node-register"));
34
+ const constants_1 = require("./constants");
35
+ const configResolver = new config_1.ConfigResolver(constants_1.CONFIG_FILES, {
36
36
  exists: (f) => fs_extra_1.default.pathExists(f),
37
37
  load: async (f) => {
38
- if (/\.ts$/.test(f)) {
39
- try {
40
- await Promise.resolve().then(() => __importStar(require('ts-node/register/transpile-only')));
41
- }
42
- catch (cause) {
43
- throw new errors_1.ConfigTsNodeError(f, cause);
44
- }
45
- }
38
+ await (0, ts_node_register_1.default)(f, errors_1.ConfigTsNodeError);
46
39
  return await Promise.resolve(`${f}`).then(s => __importStar(require(s)));
47
40
  },
48
41
  none: (_) => ({}),
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DEFAULT_ACTION = exports.CONFIG_FILES = void 0;
4
+ exports.CONFIG_FILES = ['.hygen.js', '.hygen.cjs', '.hygen.mjs', '.hygen.ts'];
5
+ exports.DEFAULT_ACTION = '_default';
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RUN_SCOPE = void 0;
4
+ exports.RUN_SCOPE = '*';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.LIFECYCLE_METHODS = exports.HOOK_FILES = exports.LEGACY_HOOK_FILES = exports.ACTION_HOOK_FILES = void 0;
4
+ exports.ACTION_HOOK_FILES = ['hooks.ts', 'hooks.js', 'hooks.mjs', 'hooks.cjs'];
5
+ exports.LEGACY_HOOK_FILES = [
6
+ 'index.js',
7
+ 'index.ts',
8
+ 'prompt.cjs',
9
+ 'prompt.js',
10
+ 'prompt.ts',
11
+ ];
12
+ exports.HOOK_FILES = [...exports.ACTION_HOOK_FILES, ...exports.LEGACY_HOOK_FILES];
13
+ exports.LIFECYCLE_METHODS = [
14
+ 'beforeAll',
15
+ 'beforeEach',
16
+ 'afterEach',
17
+ 'afterAll',
18
+ ];
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./hooks"), exports);
18
+ __exportStar(require("./config"), exports);
19
+ __exportStar(require("./engine"), exports);
@@ -32,16 +32,17 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
32
32
  const context_1 = __importDefault(require("./context"));
33
33
  const params_1 = __importDefault(require("./params"));
34
34
  const prompt_1 = __importStar(require("./prompt"));
35
+ const picker_1 = require("./picker");
35
36
  const errors_1 = require("./errors");
36
37
  Object.defineProperty(exports, "ShowHelpError", { enumerable: true, get: function () { return errors_1.ShowHelpError; } });
37
38
  Object.defineProperty(exports, "KeepGoingError", { enumerable: true, get: function () { return errors_1.KeepGoingError; } });
38
39
  const cli_help_1 = require("./cli-help");
40
+ const constants_1 = require("./constants");
39
41
  const isInteractive = ({ interactive }) => interactive === true
40
42
  ? true
41
43
  : interactive === false
42
44
  ? false
43
45
  : Boolean(process.stdin.isTTY && process.stdout.isTTY);
44
- const RUN_SCOPE = '*';
45
46
  const engine = async (argv, config) => {
46
47
  const { cwd, templates, logger } = config;
47
48
  let base = Object.assign(await (0, params_1.default)(config, argv), { cwd });
@@ -50,7 +51,7 @@ const engine = async (argv, config) => {
50
51
  (0, cli_help_1.printUsage)(logger);
51
52
  }
52
53
  if (!generator && isInteractive(config) && templates && fs_extra_1.default.pathExistsSync(templates)) {
53
- const picked = await (0, prompt_1.pickGeneratorAction)(config);
54
+ const picked = await (0, picker_1.pickGeneratorAction)(config);
54
55
  if (picked) {
55
56
  base = Object.assign(await (0, params_1.default)(config, [picked.generator, picked.action, ...argv]), {
56
57
  cwd,
@@ -76,7 +77,8 @@ const engine = async (argv, config) => {
76
77
  const execute = (await Promise.resolve().then(() => __importStar(require('./execute')))).execute;
77
78
  const render = (await Promise.resolve().then(() => __importStar(require('./render')))).render;
78
79
  const projectHooks = (0, prompt_1.normalizeProjectHooks)(config.hooks, logger);
79
- const hookHelpers = (0, context_1.default)({}, config).h;
80
+ let hookHelpers;
81
+ const getHookHelpers = () => (hookHelpers ?? (hookHelpers = (0, context_1.default)({ _: base._, ...cleanArgv }, config).h));
80
82
  const hookCache = new Map();
81
83
  const actionStates = new Map();
82
84
  const makeCtx = (action, name, subaction, args) => ({
@@ -87,7 +89,9 @@ const engine = async (argv, config) => {
87
89
  ...(subaction !== undefined ? { subaction } : {}),
88
90
  ...(name !== undefined ? { name } : {}),
89
91
  args,
90
- h: hookHelpers,
92
+ get h() {
93
+ return getHookHelpers();
94
+ },
91
95
  logger,
92
96
  dry: Boolean(base.dry),
93
97
  });
@@ -109,7 +113,7 @@ const engine = async (argv, config) => {
109
113
  };
110
114
  let projectBeforeAllError;
111
115
  try {
112
- await projectHooks.beforeAll?.(makeCtx(RUN_SCOPE, undefined, undefined, { ...cleanArgv }));
116
+ await projectHooks.beforeAll?.(makeCtx(constants_1.RUN_SCOPE, undefined, undefined, { ...cleanArgv }));
113
117
  }
114
118
  catch (err) {
115
119
  projectBeforeAllError = err;
@@ -126,10 +130,6 @@ const engine = async (argv, config) => {
126
130
  action,
127
131
  ...(name !== undefined ? { name } : {}),
128
132
  };
129
- const pairStatus = {
130
- action,
131
- ...(name !== undefined ? { name } : {}),
132
- };
133
133
  if (!(await fs_extra_1.default.pathExists(actionfolder))) {
134
134
  const err = new errors_1.ShowHelpError(`I can't find action '${action}' for generator '${generator}'.
135
135
 
@@ -144,7 +144,7 @@ const engine = async (argv, config) => {
144
144
  if (!keepGoing)
145
145
  throw err;
146
146
  failures.push({ ...pair, error: err.message });
147
- statuses.push({ ...pairStatus, status: 'failed' });
147
+ statuses.push({ ...pair, status: 'failed' });
148
148
  continue;
149
149
  }
150
150
  if (projectBeforeAllError) {
@@ -195,7 +195,7 @@ const engine = async (argv, config) => {
195
195
  if (!pairError) {
196
196
  try {
197
197
  const promptArgs = await (0, prompt_1.default)(config.createPrompter, actionfolder, hookArgs, {
198
- h: hookHelpers,
198
+ h: getHookHelpers,
199
199
  cache: hookCache,
200
200
  });
201
201
  const args = Object.assign({
@@ -275,7 +275,7 @@ const engine = async (argv, config) => {
275
275
  }
276
276
  }
277
277
  try {
278
- await projectHooks.afterAll?.(makeCtx(RUN_SCOPE, undefined, undefined, { ...cleanArgv }), results);
278
+ await projectHooks.afterAll?.(makeCtx(constants_1.RUN_SCOPE, undefined, undefined, { ...cleanArgv }), results);
279
279
  }
280
280
  catch (err) {
281
281
  afterAllErrors.push(err);
@@ -292,8 +292,8 @@ const engine = async (argv, config) => {
292
292
  if (!keepGoing)
293
293
  throw new errors_1.ShowHelpError(`afterAll failed: ${afterAllErrors[0].message}`);
294
294
  for (const err of afterAllErrors) {
295
- failures.push({ action: RUN_SCOPE, error: err.message });
296
- statuses.push({ action: RUN_SCOPE, status: 'failed' });
295
+ failures.push({ action: constants_1.RUN_SCOPE, error: err.message });
296
+ statuses.push({ action: constants_1.RUN_SCOPE, status: 'failed' });
297
297
  }
298
298
  }
299
299
  if (failures.length > 0) {
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.NameFlagRemovedError = exports.CliArgumentError = exports.SetupRepositoryError = exports.UnknownTransformError = exports.HookModuleError = exports.HookTsNodeError = exports.ConfigTsNodeError = exports.GlobMirrorConflictError = exports.PathMacroResolutionError = exports.ShellCommandError = exports.TemplateConfigError = exports.InjectionAnchorNotFoundError = exports.InjectionTargetNotFoundError = exports.TemplateNotFoundError = exports.TemplateRenderError = exports.KeepGoingError = exports.ShowHelpError = void 0;
3
+ exports.ParamUnknownTypeError = exports.ParamRequiredError = exports.ParamCoercionError = exports.NameFlagRemovedError = exports.CliArgumentError = exports.SetupRepositoryError = exports.UnknownTransformError = exports.HookModuleError = exports.HookTsNodeError = exports.ConfigTsNodeError = exports.GlobMirrorConflictError = exports.PathMacroResolutionError = exports.ShellCommandError = exports.TemplateConfigError = exports.InjectionAnchorNotFoundError = exports.InjectionTargetNotFoundError = exports.TemplateNotFoundError = exports.TemplateRenderError = exports.KeepGoingError = exports.ShowHelpError = void 0;
4
4
  const errors_1 = require("@biorate/errors");
5
5
  class ShowHelpError extends errors_1.BaseError {
6
6
  constructor(message) {
@@ -129,3 +129,21 @@ class NameFlagRemovedError extends errors_1.BaseError {
129
129
  }
130
130
  }
131
131
  exports.NameFlagRemovedError = NameFlagRemovedError;
132
+ class ParamCoercionError extends errors_1.BaseError {
133
+ constructor(name, type, raw) {
134
+ super(`cannot coerce the value [%s] of the '--%s' parameter to the expected type [%s]`, [String(raw), name, type]);
135
+ }
136
+ }
137
+ exports.ParamCoercionError = ParamCoercionError;
138
+ class ParamRequiredError extends errors_1.BaseError {
139
+ constructor(name) {
140
+ super(`the parameter '--%s' is required but was not supplied`, [name]);
141
+ }
142
+ }
143
+ exports.ParamRequiredError = ParamRequiredError;
144
+ class ParamUnknownTypeError extends errors_1.BaseError {
145
+ constructor(name, type) {
146
+ super(`the parameter '--%s' declares an unknown type [%s]`, [name, type]);
147
+ }
148
+ }
149
+ exports.ParamUnknownTypeError = ParamUnknownTypeError;
@@ -7,7 +7,7 @@ exports.isVersionFlag = exports.VERSION = exports.printHelp = exports.generatorA
7
7
  const fs_1 = __importDefault(require("fs"));
8
8
  const path_1 = __importDefault(require("path"));
9
9
  const chalk_1 = __importDefault(require("chalk"));
10
- const params_1 = require("./params");
10
+ const constants_1 = require("./constants");
11
11
  const readVersion = () => {
12
12
  let dir = __dirname;
13
13
  while (true) {
@@ -80,8 +80,8 @@ const printHelp = (templates, logger) => {
80
80
  return;
81
81
  }
82
82
  Object.entries(availableActions(templates)).forEach(([k, v]) => {
83
- logger.log(`${chalk_1.default.bold(k)}: ${v.find((a) => a === params_1.DEFAULT_ACTION) ? `${k}${v.length > 1 ? ',' : ''} ` : ''}${v
84
- .filter((a) => a !== params_1.DEFAULT_ACTION)
83
+ logger.log(`${chalk_1.default.bold(k)}: ${v.find((a) => a === constants_1.DEFAULT_ACTION) ? `${k}${v.length > 1 ? ',' : ''} ` : ''}${v
84
+ .filter((a) => a !== constants_1.DEFAULT_ACTION)
85
85
  .map((a) => `${k} ${a}`)
86
86
  .join(', ')}`);
87
87
  });
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.promptFromParams = exports.validateParams = exports.resolveType = exports.promptTypeOf = exports.checkParam = exports.coerceParam = void 0;
4
+ var registry_1 = require("./registry");
5
+ Object.defineProperty(exports, "coerceParam", { enumerable: true, get: function () { return registry_1.coerceParam; } });
6
+ Object.defineProperty(exports, "checkParam", { enumerable: true, get: function () { return registry_1.checkParam; } });
7
+ Object.defineProperty(exports, "promptTypeOf", { enumerable: true, get: function () { return registry_1.promptTypeOf; } });
8
+ Object.defineProperty(exports, "resolveType", { enumerable: true, get: function () { return registry_1.resolveType; } });
9
+ Object.defineProperty(exports, "validateParams", { enumerable: true, get: function () { return registry_1.validateParams; } });
10
+ var prompts_1 = require("./prompts");
11
+ Object.defineProperty(exports, "promptFromParams", { enumerable: true, get: function () { return prompts_1.promptFromParams; } });
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.promptFromParams = void 0;
4
+ const registry_1 = require("./registry");
5
+ const promptFromParams = async (schema, createPrompter, args) => {
6
+ const values = {};
7
+ const questions = [];
8
+ for (const descriptor of schema) {
9
+ const raw = args[descriptor.name];
10
+ if (raw !== undefined) {
11
+ values[descriptor.name] = (0, registry_1.coerceParam)(descriptor, raw);
12
+ continue;
13
+ }
14
+ if (!descriptor.required)
15
+ continue;
16
+ questions.push({
17
+ type: (0, registry_1.promptTypeOf)(descriptor),
18
+ name: descriptor.name,
19
+ message: descriptor.message ?? `Enter a value for ${descriptor.name}:`,
20
+ ...(descriptor.default !== undefined ? { initial: descriptor.default } : {}),
21
+ });
22
+ }
23
+ if (questions.length > 0) {
24
+ const prompter = createPrompter();
25
+ const answers = await prompter.prompt(questions);
26
+ const answerMap = (answers ?? {});
27
+ for (const question of questions) {
28
+ const answered = answerMap[question.name];
29
+ values[question.name] = answered !== undefined ? answered : question.initial;
30
+ }
31
+ }
32
+ return (0, registry_1.validateParams)(schema, values);
33
+ };
34
+ exports.promptFromParams = promptFromParams;
@@ -0,0 +1,92 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateParams = exports.checkParam = exports.coerceParam = exports.promptTypeOf = exports.resolveType = void 0;
4
+ const errors_1 = require("../errors");
5
+ const BUILTIN_TYPES = {
6
+ string: {
7
+ coerce: (raw) => {
8
+ if (typeof raw === 'string')
9
+ return raw;
10
+ if (typeof raw === 'number' || typeof raw === 'boolean')
11
+ return String(raw);
12
+ throw new Error(String(raw));
13
+ },
14
+ check: (value) => typeof value === 'string',
15
+ promptType: 'input',
16
+ },
17
+ number: {
18
+ coerce: (raw) => {
19
+ if (typeof raw === 'number')
20
+ return raw;
21
+ if (typeof raw === 'string' && raw.trim() !== '' && !Number.isNaN(Number(raw))) {
22
+ return Number(raw);
23
+ }
24
+ throw new Error(String(raw));
25
+ },
26
+ check: (value) => typeof value === 'number' && !Number.isNaN(value),
27
+ promptType: 'numeral',
28
+ },
29
+ boolean: {
30
+ coerce: (raw) => {
31
+ if (typeof raw === 'boolean')
32
+ return raw;
33
+ if (raw === 'true')
34
+ return true;
35
+ if (raw === 'false')
36
+ return false;
37
+ throw new Error(String(raw));
38
+ },
39
+ check: (value) => typeof value === 'boolean',
40
+ promptType: 'confirm',
41
+ },
42
+ };
43
+ const resolveType = (descriptor) => {
44
+ const { name, type } = descriptor;
45
+ if (typeof type === 'function')
46
+ return type;
47
+ const def = BUILTIN_TYPES[type];
48
+ if (!def)
49
+ throw new errors_1.ParamUnknownTypeError(name, String(type));
50
+ return def.coerce;
51
+ };
52
+ exports.resolveType = resolveType;
53
+ const promptTypeOf = (descriptor) => {
54
+ const { type } = descriptor;
55
+ if (typeof type === 'function')
56
+ return 'input';
57
+ return BUILTIN_TYPES[type]?.promptType ?? 'input';
58
+ };
59
+ exports.promptTypeOf = promptTypeOf;
60
+ const coerceParam = (descriptor, raw) => {
61
+ try {
62
+ return (0, exports.resolveType)(descriptor)(raw);
63
+ }
64
+ catch (cause) {
65
+ const typeName = typeof descriptor.type === 'function' ? 'function' : descriptor.type;
66
+ throw new errors_1.ParamCoercionError(descriptor.name, typeName, raw);
67
+ }
68
+ };
69
+ exports.coerceParam = coerceParam;
70
+ const checkParam = (descriptor, value) => {
71
+ const { type } = descriptor;
72
+ if (typeof type === 'function')
73
+ return true;
74
+ return BUILTIN_TYPES[type]?.check(value) ?? true;
75
+ };
76
+ exports.checkParam = checkParam;
77
+ const validateParams = (schema, values) => {
78
+ for (const descriptor of schema) {
79
+ const value = values[descriptor.name];
80
+ if (value === undefined) {
81
+ if (descriptor.required)
82
+ throw new errors_1.ParamRequiredError(descriptor.name);
83
+ continue;
84
+ }
85
+ if (!(0, exports.checkParam)(descriptor, value)) {
86
+ const typeName = typeof descriptor.type === 'function' ? 'function' : descriptor.type;
87
+ throw new errors_1.ParamCoercionError(descriptor.name, typeName, value);
88
+ }
89
+ }
90
+ return values;
91
+ };
92
+ exports.validateParams = validateParams;
@@ -3,12 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DEFAULT_ACTION = void 0;
7
6
  const path_1 = __importDefault(require("path"));
8
7
  const yargs_parser_1 = __importDefault(require("yargs-parser"));
9
8
  const fs_extra_1 = __importDefault(require("fs-extra"));
10
9
  const errors_1 = require("./errors");
11
- exports.DEFAULT_ACTION = '_default';
10
+ const constants_1 = require("./constants");
12
11
  const splitList = (value) => value ? value.split(',') : undefined;
13
12
  const resolvePositionals = async (templates, args) => {
14
13
  let [generator, action, name] = args;
@@ -34,15 +33,32 @@ const resolvePositionals = async (templates, args) => {
34
33
  }
35
34
  }
36
35
  if (generator &&
37
- (await fs_extra_1.default.pathExists(path_1.default.join(templates, generator, exports.DEFAULT_ACTION)))) {
36
+ (await fs_extra_1.default.pathExists(path_1.default.join(templates, generator, constants_1.DEFAULT_ACTION)))) {
38
37
  [generator, name] = args;
39
- return { generator, actions: [exports.DEFAULT_ACTION], names: splitList(name) };
38
+ return { generator, actions: [constants_1.DEFAULT_ACTION], names: splitList(name) };
40
39
  }
41
40
  return { generator, actions: actionList, names: nameList };
42
41
  };
43
- const params = async ({ templates, legacyNameFlag }, externalArgv) => {
42
+ const params = async ({ templates, legacyNameFlag, argCase: argCaseOption }, externalArgv) => {
44
43
  const argv = (0, yargs_parser_1.default)(externalArgv);
45
44
  const { _, ...cleanArgv } = argv;
45
+ const normalizeKey = (key) => key
46
+ .replace(/([a-z0-9])([A-Z])/g, '$1_$2')
47
+ .replace(/[-\s]+/g, '_')
48
+ .toUpperCase();
49
+ const RESERVED_KEYS = new Set(['name', 'generator', 'action', 'ts']);
50
+ const argCase = argCaseOption ?? 'keep';
51
+ if (argCase === 'upper-underscore') {
52
+ for (const key of Object.keys(cleanArgv)) {
53
+ if (RESERVED_KEYS.has(key))
54
+ continue;
55
+ const normalized = normalizeKey(key);
56
+ if (normalized !== key) {
57
+ cleanArgv[normalized] = cleanArgv[key];
58
+ delete cleanArgv[key];
59
+ }
60
+ }
61
+ }
46
62
  const legacyGate = process.env.HYGEN_LEGACY_NAME === '1' || legacyNameFlag === true;
47
63
  if (Array.isArray(cleanArgv.name) && !legacyGate) {
48
64
  throw new errors_1.CliArgumentError("repeating the '--name' flag is not supported; use a comma-separated positional name list instead (e.g. 'hygen <gen> <action> a,b').");
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.pickGeneratorAction = void 0;
7
+ const fs_1 = __importDefault(require("fs"));
8
+ const help_1 = require("./help");
9
+ const answerValue = (answer, name) => {
10
+ const value = answer[name];
11
+ return typeof value === 'string' && value.length > 0 ? value : undefined;
12
+ };
13
+ const pickGeneratorAction = async (config) => {
14
+ const { templates, logger } = config;
15
+ if (!templates || !fs_1.default.existsSync(templates)) {
16
+ logger.log(`No generators found.
17
+
18
+ The interactive picker needs a _templates folder here, or anywhere up the folder tree.
19
+ Create one with: $ hygen init self
20
+ `);
21
+ return null;
22
+ }
23
+ const generators = (0, help_1.pickableGenerators)(templates);
24
+ if (generators.length === 0) {
25
+ logger.log(`No generators found.
26
+
27
+ Every top-level folder in _templates should hold at least one action subfolder.
28
+ Create one with: $ hygen with-prompt new my-generator
29
+ `);
30
+ return null;
31
+ }
32
+ const prompter = config.createPrompter();
33
+ const generatorAnswer = await prompter.prompt({
34
+ type: 'select',
35
+ name: 'generator',
36
+ message: 'Select a generator:',
37
+ choices: generators,
38
+ });
39
+ const generator = answerValue(generatorAnswer, 'generator');
40
+ if (!generator)
41
+ return null;
42
+ const actions = (0, help_1.generatorActions)(templates, generator);
43
+ const actionPrompter = config.createPrompter();
44
+ const actionAnswer = await actionPrompter.prompt({
45
+ type: 'select',
46
+ name: 'action',
47
+ message: `Select an action for ${generator}:`,
48
+ choices: actions,
49
+ });
50
+ const action = answerValue(actionAnswer, 'action');
51
+ if (!action)
52
+ return null;
53
+ return { generator, action };
54
+ };
55
+ exports.pickGeneratorAction = pickGeneratorAction;