@biorate/hygen 0.5.2 → 0.6.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.
- package/dist/cjs/src/config-resolver.js +37 -1
- package/dist/cjs/src/errors.js +9 -1
- package/dist/esm/src/config-resolver.js +37 -2
- package/dist/esm/src/errors.js +7 -0
- package/dist/types/src/config-resolver.d.ts +3 -1
- package/dist/types/src/errors.d.ts +3 -0
- package/dist/types/src/index.d.ts +1 -1
- package/dist/types/src/types/config.d.ts +2 -0
- package/package.json +2 -2
|
@@ -26,20 +26,56 @@ 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.normalizeProjectConfig = void 0;
|
|
29
30
|
const path_1 = __importDefault(require("path"));
|
|
30
31
|
const fs_extra_1 = __importDefault(require("fs-extra"));
|
|
31
32
|
const config_1 = require("./config");
|
|
32
33
|
const errors_1 = require("./errors");
|
|
33
34
|
const ts_node_register_1 = __importDefault(require("./ts-node-register"));
|
|
34
35
|
const constants_1 = require("./constants");
|
|
36
|
+
let resolvedConfigFile;
|
|
35
37
|
const configResolver = new config_1.ConfigResolver(constants_1.CONFIG_FILES, {
|
|
36
38
|
exists: (f) => fs_extra_1.default.pathExists(f),
|
|
37
39
|
load: async (f) => {
|
|
38
40
|
await (0, ts_node_register_1.default)(f, errors_1.ConfigTsNodeError);
|
|
41
|
+
resolvedConfigFile = f;
|
|
39
42
|
return await Promise.resolve(`${f}`).then(s => __importStar(require(s)));
|
|
40
43
|
},
|
|
41
44
|
none: (_) => ({}),
|
|
42
45
|
});
|
|
46
|
+
const PROJECT_CONFIG_KEYS = ['templates', 'argCase', 'helpers', 'hooks'];
|
|
47
|
+
const normalizeProjectConfig = (mod, file, logger) => {
|
|
48
|
+
const named = Object.keys(mod).filter((key) => key !== 'default');
|
|
49
|
+
if (named.length > 0) {
|
|
50
|
+
return Object.fromEntries(named.map((key) => [key, mod[key]]));
|
|
51
|
+
}
|
|
52
|
+
const raw = mod.default;
|
|
53
|
+
if (raw === undefined || raw === null)
|
|
54
|
+
return {};
|
|
55
|
+
if (typeof raw === 'object' && !Array.isArray(raw))
|
|
56
|
+
return raw;
|
|
57
|
+
if (typeof raw !== 'function') {
|
|
58
|
+
logger.warn(`Ignoring unsupported default export of project config '${file}': expected an object or a class.`);
|
|
59
|
+
return {};
|
|
60
|
+
}
|
|
61
|
+
let instance;
|
|
62
|
+
try {
|
|
63
|
+
instance = new raw();
|
|
64
|
+
}
|
|
65
|
+
catch (cause) {
|
|
66
|
+
throw new errors_1.ConfigClassError(file, cause);
|
|
67
|
+
}
|
|
68
|
+
const own = Object.keys(instance);
|
|
69
|
+
for (const key of own) {
|
|
70
|
+
if (!PROJECT_CONFIG_KEYS.includes(key)) {
|
|
71
|
+
logger.warn(`Ignoring unknown project config property '${key}' in '${file}' (known: ${PROJECT_CONFIG_KEYS.join(', ')}).`);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
return Object.fromEntries(own
|
|
75
|
+
.filter((key) => PROJECT_CONFIG_KEYS.includes(key))
|
|
76
|
+
.map((key) => [key, instance[key]]));
|
|
77
|
+
};
|
|
78
|
+
exports.normalizeProjectConfig = normalizeProjectConfig;
|
|
43
79
|
const resolve = (cwd, defaultTemplates, templatesOverride) => {
|
|
44
80
|
return [
|
|
45
81
|
templatesOverride && path_1.default.resolve(cwd, templatesOverride),
|
|
@@ -54,6 +90,6 @@ exports.default = async (config) => {
|
|
|
54
90
|
return {
|
|
55
91
|
...config,
|
|
56
92
|
templates: resolvedTemplates,
|
|
57
|
-
...(await configResolver.resolve(cwd)),
|
|
93
|
+
...normalizeProjectConfig((await configResolver.resolve(cwd)), resolvedConfigFile ?? path_1.default.join(cwd, constants_1.CONFIG_FILES[0]), config.logger),
|
|
58
94
|
};
|
|
59
95
|
};
|
package/dist/cjs/src/errors.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
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;
|
|
3
|
+
exports.ParamUnknownTypeError = exports.ParamRequiredError = exports.ParamCoercionError = exports.NameFlagRemovedError = exports.CliArgumentError = exports.SetupRepositoryError = exports.UnknownTransformError = exports.HookModuleError = exports.HookTsNodeError = exports.ConfigClassError = 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) {
|
|
@@ -83,6 +83,14 @@ class ConfigTsNodeError extends errors_1.BaseError {
|
|
|
83
83
|
}
|
|
84
84
|
}
|
|
85
85
|
exports.ConfigTsNodeError = ConfigTsNodeError;
|
|
86
|
+
class ConfigClassError extends errors_1.BaseError {
|
|
87
|
+
constructor(file, cause) {
|
|
88
|
+
super('Project config [%s] default-exports a class that could not be instantiated ' +
|
|
89
|
+
'without constructor arguments (error: [%s]). The config class must have a ' +
|
|
90
|
+
'parameterless constructor.', [file, cause?.message ?? cause]);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
exports.ConfigClassError = ConfigClassError;
|
|
86
94
|
class HookTsNodeError extends errors_1.BaseError {
|
|
87
95
|
constructor(file, cause) {
|
|
88
96
|
super('TypeScript hook [%s] requires ts-node: install it with `npm i -D ts-node` (error: [%s])', [file, cause?.message ?? cause]);
|
|
@@ -1,17 +1,51 @@
|
|
|
1
1
|
import path from 'path';
|
|
2
2
|
import fs from 'fs-extra';
|
|
3
3
|
import { ConfigResolver } from './config.js';
|
|
4
|
-
import { ConfigTsNodeError } from './errors.js';
|
|
4
|
+
import { ConfigClassError, ConfigTsNodeError } from './errors.js';
|
|
5
5
|
import registerTsNode from './ts-node-register.js';
|
|
6
6
|
import { CONFIG_FILES } from './constants/index.js';
|
|
7
|
+
let resolvedConfigFile;
|
|
7
8
|
const configResolver = new ConfigResolver(CONFIG_FILES, {
|
|
8
9
|
exists: (f) => fs.pathExists(f),
|
|
9
10
|
load: async (f) => {
|
|
10
11
|
await registerTsNode(f, ConfigTsNodeError);
|
|
12
|
+
resolvedConfigFile = f;
|
|
11
13
|
return await import(f);
|
|
12
14
|
},
|
|
13
15
|
none: (_) => ({}),
|
|
14
16
|
});
|
|
17
|
+
const PROJECT_CONFIG_KEYS = ['templates', 'argCase', 'helpers', 'hooks'];
|
|
18
|
+
const normalizeProjectConfig = (mod, file, logger) => {
|
|
19
|
+
const named = Object.keys(mod).filter((key) => key !== 'default');
|
|
20
|
+
if (named.length > 0) {
|
|
21
|
+
return Object.fromEntries(named.map((key) => [key, mod[key]]));
|
|
22
|
+
}
|
|
23
|
+
const raw = mod.default;
|
|
24
|
+
if (raw === undefined || raw === null)
|
|
25
|
+
return {};
|
|
26
|
+
if (typeof raw === 'object' && !Array.isArray(raw))
|
|
27
|
+
return raw;
|
|
28
|
+
if (typeof raw !== 'function') {
|
|
29
|
+
logger.warn(`Ignoring unsupported default export of project config '${file}': expected an object or a class.`);
|
|
30
|
+
return {};
|
|
31
|
+
}
|
|
32
|
+
let instance;
|
|
33
|
+
try {
|
|
34
|
+
instance = new raw();
|
|
35
|
+
}
|
|
36
|
+
catch (cause) {
|
|
37
|
+
throw new ConfigClassError(file, cause);
|
|
38
|
+
}
|
|
39
|
+
const own = Object.keys(instance);
|
|
40
|
+
for (const key of own) {
|
|
41
|
+
if (!PROJECT_CONFIG_KEYS.includes(key)) {
|
|
42
|
+
logger.warn(`Ignoring unknown project config property '${key}' in '${file}' (known: ${PROJECT_CONFIG_KEYS.join(', ')}).`);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return Object.fromEntries(own
|
|
46
|
+
.filter((key) => PROJECT_CONFIG_KEYS.includes(key))
|
|
47
|
+
.map((key) => [key, instance[key]]));
|
|
48
|
+
};
|
|
15
49
|
const resolve = (cwd, defaultTemplates, templatesOverride) => {
|
|
16
50
|
return [
|
|
17
51
|
templatesOverride && path.resolve(cwd, templatesOverride),
|
|
@@ -20,12 +54,13 @@ const resolve = (cwd, defaultTemplates, templatesOverride) => {
|
|
|
20
54
|
defaultTemplates && path.resolve(cwd, defaultTemplates),
|
|
21
55
|
].find((_) => _ && fs.existsSync(_));
|
|
22
56
|
};
|
|
57
|
+
export { normalizeProjectConfig };
|
|
23
58
|
export default async (config) => {
|
|
24
59
|
const { cwd, templates: defaultTemplates, templatesOverride } = config;
|
|
25
60
|
const resolvedTemplates = resolve(cwd, defaultTemplates, templatesOverride);
|
|
26
61
|
return {
|
|
27
62
|
...config,
|
|
28
63
|
templates: resolvedTemplates,
|
|
29
|
-
...(await configResolver.resolve(cwd)),
|
|
64
|
+
...normalizeProjectConfig((await configResolver.resolve(cwd)), resolvedConfigFile ?? path.join(cwd, CONFIG_FILES[0]), config.logger),
|
|
30
65
|
};
|
|
31
66
|
};
|
package/dist/esm/src/errors.js
CHANGED
|
@@ -69,6 +69,13 @@ export class ConfigTsNodeError extends BaseError {
|
|
|
69
69
|
super('TypeScript config [%s] requires ts-node: install it with `npm i -D ts-node` (error: [%s])', [file, cause?.message ?? cause]);
|
|
70
70
|
}
|
|
71
71
|
}
|
|
72
|
+
export class ConfigClassError extends BaseError {
|
|
73
|
+
constructor(file, cause) {
|
|
74
|
+
super('Project config [%s] default-exports a class that could not be instantiated ' +
|
|
75
|
+
'without constructor arguments (error: [%s]). The config class must have a ' +
|
|
76
|
+
'parameterless constructor.', [file, cause?.message ?? cause]);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
72
79
|
export class HookTsNodeError extends BaseError {
|
|
73
80
|
constructor(file, cause) {
|
|
74
81
|
super('TypeScript hook [%s] requires ts-node: install it with `npm i -D ts-node` (error: [%s])', [file, cause?.message ?? cause]);
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
import type { RunnerConfig } from './types';
|
|
1
|
+
import type { Logger, RunnerConfig } from './types';
|
|
2
|
+
declare const normalizeProjectConfig: (mod: Record<string, unknown>, file: string, logger: Logger) => Record<string, unknown>;
|
|
3
|
+
export { normalizeProjectConfig };
|
|
2
4
|
declare const _default: (config: RunnerConfig) => Promise<RunnerConfig>;
|
|
3
5
|
export default _default;
|
|
@@ -36,6 +36,9 @@ export declare class GlobMirrorConflictError extends BaseError {
|
|
|
36
36
|
export declare class ConfigTsNodeError extends BaseError {
|
|
37
37
|
constructor(file: string, cause: unknown);
|
|
38
38
|
}
|
|
39
|
+
export declare class ConfigClassError extends BaseError {
|
|
40
|
+
constructor(file: string, cause: unknown);
|
|
41
|
+
}
|
|
39
42
|
export declare class HookTsNodeError extends BaseError {
|
|
40
43
|
constructor(file: string, cause: unknown);
|
|
41
44
|
}
|
|
@@ -4,4 +4,4 @@ export { default as resolve } from './config-resolver';
|
|
|
4
4
|
export { printHelp, availableActions, VERSION } from './help';
|
|
5
5
|
export { default as Logger } from './logger';
|
|
6
6
|
export * as errors from './errors';
|
|
7
|
-
export type { ParamDescriptor, ParamType, ParamsSchema } from './types';
|
|
7
|
+
export type { ParamDescriptor, ParamType, ParamsSchema, ProjectConfig, RunnerContextConfig, } from './types';
|
|
@@ -2,6 +2,8 @@ import type { Logger } from './logger';
|
|
|
2
2
|
import type { Helpers, Transforms } from './helpers-ns';
|
|
3
3
|
import type { Prompter } from './prompter';
|
|
4
4
|
import type { ProjectHooks } from './hooks';
|
|
5
|
+
export interface ProjectConfig extends Pick<RunnerConfig, 'templates' | 'argCase' | 'helpers' | 'hooks'> {
|
|
6
|
+
}
|
|
5
7
|
export interface RunnerConfig {
|
|
6
8
|
exec: (sh: string, body: string) => void;
|
|
7
9
|
templates?: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@biorate/hygen",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "The scalable code generator that saves you time. Fork of jondot/hygen",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"template",
|
|
@@ -80,5 +80,5 @@
|
|
|
80
80
|
"@types/inflection": "1.13.0",
|
|
81
81
|
"@types/yargs-parser": "21.0.3"
|
|
82
82
|
},
|
|
83
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "5598fe1b70ffbaa051da5581cfc23493545559d8"
|
|
84
84
|
}
|