stonyx 0.2.3-beta.77 → 0.2.3-beta.78
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/modules.js +8 -3
- package/dist/util/extension-resolution.d.ts +22 -0
- package/dist/util/extension-resolution.js +24 -0
- package/dist/util/import-config.d.ts +21 -0
- package/dist/util/import-config.js +29 -3
- package/dist/util/import-module-config.d.ts +16 -0
- package/dist/util/import-module-config.js +25 -0
- package/dist/util/resolve-entry-point.js +2 -2
- package/package.json +1 -1
package/dist/modules.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import { readFile } from '@stonyx/utils/file';
|
|
6
6
|
import { kebabCaseToCamelCase } from '@stonyx/utils/string';
|
|
7
7
|
import { mergeObject } from '@stonyx/utils/object';
|
|
8
|
-
import {
|
|
8
|
+
import { importModuleConfig } from './util/import-module-config.js';
|
|
9
9
|
const modulePromises = {};
|
|
10
10
|
// Configure module-specific logging
|
|
11
11
|
function configureLog(chronicle, module, config) {
|
|
@@ -64,7 +64,10 @@ export default async function loadModules(config, rootPath, chronicle) {
|
|
|
64
64
|
}
|
|
65
65
|
try {
|
|
66
66
|
// Load & Configure Async Modules
|
|
67
|
-
|
|
67
|
+
// MODULE-OWNED: `.js` only, always. Routing this to the app-owned
|
|
68
|
+
// `importConfig` re-ships abofs/stonyx-orm#118 — Node refuses to
|
|
69
|
+
// type-strip inside `node_modules`. See abofs/stonyx#90.
|
|
70
|
+
const moduleConfig = await importModuleConfig(`${rootPath}/node_modules/${moduleName}/config/environment`);
|
|
68
71
|
const module = kebabCaseToCamelCase(moduleName.split('/').pop() ?? moduleName);
|
|
69
72
|
const userConfig = config[module] || {};
|
|
70
73
|
const finalConfig = mergeObject(moduleConfig, userConfig);
|
|
@@ -77,7 +80,9 @@ export default async function loadModules(config, rootPath, chronicle) {
|
|
|
77
80
|
}
|
|
78
81
|
catch (error) {
|
|
79
82
|
console.error(error);
|
|
80
|
-
throw new Error(
|
|
83
|
+
throw new Error('Stonyx modules with async loading must ship a config/environment.js with default configurations. ' +
|
|
84
|
+
'Module configs resolve as .js only — never .ts, because Node refuses to type-strip inside node_modules. ' +
|
|
85
|
+
`Module "${moduleName}" failed to load.`);
|
|
81
86
|
}
|
|
82
87
|
}
|
|
83
88
|
// Wait until all modules are initialized
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared constants for APP-OWNED `{ts,js}` resolution.
|
|
3
|
+
*
|
|
4
|
+
* Two resolvers pick an extension for a file in the consuming project's own
|
|
5
|
+
* tree — `resolveEntryPoint` (`./resolve-entry-point.ts`, since
|
|
6
|
+
* abofs/stonyx#67) and `importConfig` (`./import-config.ts`, since
|
|
7
|
+
* abofs/stonyx#90). They must agree on the candidate list, on the preference
|
|
8
|
+
* order, and on the wording of the dual-extension warning.
|
|
9
|
+
*
|
|
10
|
+
* They previously agreed by copy. Each string was pinned by its own suite, so
|
|
11
|
+
* editing one file left BOTH suites green while the two messages diverged —
|
|
12
|
+
* which is why this lives here and not at the top of either consumer
|
|
13
|
+
* (`docs/conventions/index.md` § Universal Rules: constants shared across
|
|
14
|
+
* files go in a dedicated constants file).
|
|
15
|
+
*
|
|
16
|
+
* MODULE-OWNED configs are not in scope: `./import-module-config.ts` resolves
|
|
17
|
+
* `.js` only, forever, and deliberately shares nothing with this file.
|
|
18
|
+
*/
|
|
19
|
+
/** Candidate extensions in preference order — `.ts` wins over `.js`. */
|
|
20
|
+
export declare const EXTENSIONS: readonly ["ts", "js"];
|
|
21
|
+
/** The warning both app-owned resolvers emit when a `.ts`/`.js` pair exists. */
|
|
22
|
+
export declare function dualExtensionWarning(basePath: string): string;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared constants for APP-OWNED `{ts,js}` resolution.
|
|
3
|
+
*
|
|
4
|
+
* Two resolvers pick an extension for a file in the consuming project's own
|
|
5
|
+
* tree — `resolveEntryPoint` (`./resolve-entry-point.ts`, since
|
|
6
|
+
* abofs/stonyx#67) and `importConfig` (`./import-config.ts`, since
|
|
7
|
+
* abofs/stonyx#90). They must agree on the candidate list, on the preference
|
|
8
|
+
* order, and on the wording of the dual-extension warning.
|
|
9
|
+
*
|
|
10
|
+
* They previously agreed by copy. Each string was pinned by its own suite, so
|
|
11
|
+
* editing one file left BOTH suites green while the two messages diverged —
|
|
12
|
+
* which is why this lives here and not at the top of either consumer
|
|
13
|
+
* (`docs/conventions/index.md` § Universal Rules: constants shared across
|
|
14
|
+
* files go in a dedicated constants file).
|
|
15
|
+
*
|
|
16
|
+
* MODULE-OWNED configs are not in scope: `./import-module-config.ts` resolves
|
|
17
|
+
* `.js` only, forever, and deliberately shares nothing with this file.
|
|
18
|
+
*/
|
|
19
|
+
/** Candidate extensions in preference order — `.ts` wins over `.js`. */
|
|
20
|
+
export const EXTENSIONS = ['ts', 'js'];
|
|
21
|
+
/** The warning both app-owned resolvers emit when a `.ts`/`.js` pair exists. */
|
|
22
|
+
export function dualExtensionWarning(basePath) {
|
|
23
|
+
return `Warning: both ${basePath}.ts and ${basePath}.js exist. Using .ts — delete the .js to silence this warning (it is likely a stale compiled artifact or postinstall stub).`;
|
|
24
|
+
}
|
|
@@ -1 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolve an APP-OWNED config — `<cwd>/config/environment`,
|
|
3
|
+
* `<rootPath>/test/config/environment` — as `{ts,js}`, preferring `.ts`.
|
|
4
|
+
* Mirrors `src/util/resolve-entry-point.ts`, which has resolved app-owned
|
|
5
|
+
* entry points this way since abofs/stonyx#67 — the candidate list and the
|
|
6
|
+
* dual-extension warning are shared through `./extension-resolution.ts` so
|
|
7
|
+
* the two cannot drift.
|
|
8
|
+
*
|
|
9
|
+
* These paths live in the consuming project's own tree, never inside
|
|
10
|
+
* `node_modules`, so they load under the app's own loader and Node's type
|
|
11
|
+
* stripping applies to them.
|
|
12
|
+
*
|
|
13
|
+
* MODULE-OWNED configs are NOT this function's business: see
|
|
14
|
+
* `importModuleConfig` in `./import-module-config.ts`, which resolves `.js`
|
|
15
|
+
* only. Routing `src/modules.ts` here re-ships abofs/stonyx-orm#118 — Node
|
|
16
|
+
* refuses to type-strip inside `node_modules`, so a `.ts` module config
|
|
17
|
+
* crashes every consumer at parse time. See abofs/stonyx#90.
|
|
18
|
+
*
|
|
19
|
+
* The "Config not found:" prefix is load-bearing: `src/main.ts` matches on it
|
|
20
|
+
* to tell an absent optional config from a real import failure.
|
|
21
|
+
*/
|
|
1
22
|
export declare function importConfig<T = unknown>(basePath: string): Promise<T>;
|
|
@@ -1,10 +1,36 @@
|
|
|
1
1
|
import { existsSync } from 'fs';
|
|
2
2
|
import { pathToFileURL } from 'url';
|
|
3
|
+
import { EXTENSIONS, dualExtensionWarning } from './extension-resolution.js';
|
|
4
|
+
/**
|
|
5
|
+
* Resolve an APP-OWNED config — `<cwd>/config/environment`,
|
|
6
|
+
* `<rootPath>/test/config/environment` — as `{ts,js}`, preferring `.ts`.
|
|
7
|
+
* Mirrors `src/util/resolve-entry-point.ts`, which has resolved app-owned
|
|
8
|
+
* entry points this way since abofs/stonyx#67 — the candidate list and the
|
|
9
|
+
* dual-extension warning are shared through `./extension-resolution.ts` so
|
|
10
|
+
* the two cannot drift.
|
|
11
|
+
*
|
|
12
|
+
* These paths live in the consuming project's own tree, never inside
|
|
13
|
+
* `node_modules`, so they load under the app's own loader and Node's type
|
|
14
|
+
* stripping applies to them.
|
|
15
|
+
*
|
|
16
|
+
* MODULE-OWNED configs are NOT this function's business: see
|
|
17
|
+
* `importModuleConfig` in `./import-module-config.ts`, which resolves `.js`
|
|
18
|
+
* only. Routing `src/modules.ts` here re-ships abofs/stonyx-orm#118 — Node
|
|
19
|
+
* refuses to type-strip inside `node_modules`, so a `.ts` module config
|
|
20
|
+
* crashes every consumer at parse time. See abofs/stonyx#90.
|
|
21
|
+
*
|
|
22
|
+
* The "Config not found:" prefix is load-bearing: `src/main.ts` matches on it
|
|
23
|
+
* to tell an absent optional config from a real import failure.
|
|
24
|
+
*/
|
|
3
25
|
export async function importConfig(basePath) {
|
|
4
|
-
const
|
|
5
|
-
if (
|
|
6
|
-
throw new Error(`Config not found: ${
|
|
26
|
+
const matches = EXTENSIONS.filter(ext => existsSync(`${basePath}.${ext}`));
|
|
27
|
+
if (matches.length === 0) {
|
|
28
|
+
throw new Error(`Config not found: ${basePath}.{ts,js}`);
|
|
7
29
|
}
|
|
30
|
+
if (matches.length > 1) {
|
|
31
|
+
console.warn(dualExtensionWarning(basePath));
|
|
32
|
+
}
|
|
33
|
+
const path = `${basePath}.${matches[0]}`;
|
|
8
34
|
const mod = await import(pathToFileURL(path).href);
|
|
9
35
|
return mod.default;
|
|
10
36
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolve a MODULE-OWNED config — `node_modules/<mod>/config/environment` — as
|
|
3
|
+
* `.js` ONLY. There is no `.ts` fallback and there must never be one.
|
|
4
|
+
*
|
|
5
|
+
* Node's type-strip loader refuses to process `.ts` files inside
|
|
6
|
+
* `node_modules`, so a `@stonyx/*` module that ships `config/environment.ts`
|
|
7
|
+
* crashes every consumer at parse time. That is abofs/stonyx-orm#118, the P0
|
|
8
|
+
* `4c80c87` was written to prevent, and this function preserves `4c80c87`'s
|
|
9
|
+
* behaviour byte-for-byte — including the exact `Config not found: <base>.js`
|
|
10
|
+
* message, which `test/unit/import-config-test.ts` pins as a regression guard.
|
|
11
|
+
*
|
|
12
|
+
* App-owned configs resolve `{ts,js}` instead: see `importConfig` in
|
|
13
|
+
* `./import-config.ts`. The boundary is OWNERSHIP, not extension — see
|
|
14
|
+
* abofs/stonyx#90 and `docs/conventions/framework-modules.md`.
|
|
15
|
+
*/
|
|
16
|
+
export declare function importModuleConfig<T = unknown>(basePath: string): Promise<T>;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { existsSync } from 'fs';
|
|
2
|
+
import { pathToFileURL } from 'url';
|
|
3
|
+
/**
|
|
4
|
+
* Resolve a MODULE-OWNED config — `node_modules/<mod>/config/environment` — as
|
|
5
|
+
* `.js` ONLY. There is no `.ts` fallback and there must never be one.
|
|
6
|
+
*
|
|
7
|
+
* Node's type-strip loader refuses to process `.ts` files inside
|
|
8
|
+
* `node_modules`, so a `@stonyx/*` module that ships `config/environment.ts`
|
|
9
|
+
* crashes every consumer at parse time. That is abofs/stonyx-orm#118, the P0
|
|
10
|
+
* `4c80c87` was written to prevent, and this function preserves `4c80c87`'s
|
|
11
|
+
* behaviour byte-for-byte — including the exact `Config not found: <base>.js`
|
|
12
|
+
* message, which `test/unit/import-config-test.ts` pins as a regression guard.
|
|
13
|
+
*
|
|
14
|
+
* App-owned configs resolve `{ts,js}` instead: see `importConfig` in
|
|
15
|
+
* `./import-config.ts`. The boundary is OWNERSHIP, not extension — see
|
|
16
|
+
* abofs/stonyx#90 and `docs/conventions/framework-modules.md`.
|
|
17
|
+
*/
|
|
18
|
+
export async function importModuleConfig(basePath) {
|
|
19
|
+
const path = `${basePath}.js`;
|
|
20
|
+
if (!existsSync(path)) {
|
|
21
|
+
throw new Error(`Config not found: ${path}`);
|
|
22
|
+
}
|
|
23
|
+
const mod = await import(pathToFileURL(path).href);
|
|
24
|
+
return mod.default;
|
|
25
|
+
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { existsSync } from 'fs';
|
|
2
2
|
import { resolve } from 'path';
|
|
3
|
-
|
|
3
|
+
import { EXTENSIONS, dualExtensionWarning } from './extension-resolution.js';
|
|
4
4
|
export function resolveEntryPoint(basePath) {
|
|
5
5
|
const matches = EXTENSIONS.filter(ext => existsSync(resolve(`${basePath}.${ext}`)));
|
|
6
6
|
if (matches.length === 0) {
|
|
7
7
|
throw new Error(`Entry point not found: ${basePath}.{ts,js}`);
|
|
8
8
|
}
|
|
9
9
|
if (matches.length > 1) {
|
|
10
|
-
console.warn(
|
|
10
|
+
console.warn(dualExtensionWarning(basePath));
|
|
11
11
|
}
|
|
12
12
|
const ext = matches[0];
|
|
13
13
|
return resolve(`${basePath}.${ext}`);
|