stonyx 0.2.3-alpha.47 → 0.2.3-alpha.49

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/README.md CHANGED
@@ -22,7 +22,7 @@ stonyx serve
22
22
  The `new` command walks you through module selection and generates a ready-to-run project. From there, the CLI handles bootstrapping:
23
23
 
24
24
  ```bash
25
- stonyx serve # Bootstrap + run app.js
25
+ stonyx serve # Bootstrap + run app.ts (or app.js)
26
26
  stonyx test # Bootstrap + run tests
27
27
  stonyx help # Show all available commands
28
28
  ```
package/dist/cli/help.js CHANGED
@@ -23,8 +23,8 @@ export default async function help({ args, builtInCommands, loadModuleCommands }
23
23
  }
24
24
  console.log('\nAliases: s=serve, t=test, n=new, h=help\n');
25
25
  console.log('Project conventions:\n');
26
- console.log(' Entry point: app.js');
27
- console.log(' Config: config/environment.js');
26
+ console.log(' Entry point: app.ts (or app.js)');
27
+ console.log(' Config: config/environment.ts (or .js)');
28
28
  console.log(' DB schema: config/db-schema.js');
29
29
  console.log(' Models: models/');
30
30
  console.log(' Serializers: serializers/');
@@ -18,4 +18,35 @@ export declare const CONFIG_NOT_FOUND_PREFIX = "Config not found:";
18
18
  * both produced the byte-identical `Config not found: .../config/environment.js`.
19
19
  */
20
20
  export declare const CONFIG_NOT_LOADABLE_PREFIX = "Config present but not loadable:";
21
+ /**
22
+ * Did this runtime refuse OUR config file, or something our config imported?
23
+ *
24
+ * `FILE_TYPE_REFUSAL_CODES.has(code)` alone cannot tell. A config that loaded
25
+ * and ran perfectly well, but whose own nested `import()` hit a `.ts` under
26
+ * `node_modules`, throws the SAME code — and was reported as "this Node runtime
27
+ * refused to load your config", naming a file that is fine. That misdirection
28
+ * points the consumer at the one file that is not the problem, and the likeliest
29
+ * instance of it is the exact `.ts`-under-node_modules case this loader's own
30
+ * docs tell people to look for.
31
+ *
32
+ * FAIL DIRECTION — this is the property, not an implementation detail.
33
+ * `true` means "re-frame this as a refusal of the config", which is exactly the
34
+ * F-3 misdirection above. So when no path can be extracted this returns
35
+ * `false`, and the caller rethrows Node's own error untouched, `cause` and all.
36
+ * The consumer then reads what actually happened instead of a friendly sentence
37
+ * about the wrong file. This is what makes every future gap in the two patterns
38
+ * harmless: an unparseable message costs the I2 re-framing, not correctness.
39
+ *
40
+ * It previously returned `true` here, on the reasoning that keeping the loud
41
+ * re-frame mattered more than getting the filename right. Measured, that is
42
+ * backwards: the raw error is loud too — `main.ts`'s `NODE_ENV=test` swallow
43
+ * only absorbs `CONFIG_NOT_FOUND_PREFIX`, which a Node refusal never starts
44
+ * with — so failing this way loses nothing and stops naming the wrong file.
45
+ *
46
+ * Exported ONLY so its branches can be reached directly. Driving it through
47
+ * `importConfig` reaches the two path-comparison outcomes and nothing else.
48
+ * A predicate inside the guard that makes failures loud does not get to have
49
+ * branches no test can reach.
50
+ */
51
+ export declare function refusalIsAboutTheConfig(message: string, configPath: string): boolean;
21
52
  export declare function importConfig<T = unknown>(basePath: string): Promise<T>;
@@ -1,5 +1,5 @@
1
- import { existsSync } from 'fs';
2
- import { pathToFileURL } from 'url';
1
+ import { existsSync, realpathSync } from 'fs';
2
+ import { fileURLToPath, pathToFileURL } from 'url';
3
3
  /**
4
4
  * Extensions `importConfig` will load, in preference order.
5
5
  *
@@ -18,10 +18,18 @@ import { pathToFileURL } from 'url';
18
18
  */
19
19
  const LOADABLE_EXTENSIONS = ['ts', 'js'];
20
20
  /**
21
- * Extensions a consumer plausibly writes a config as, that this loader will not
22
- * read. Their only purpose is to be DETECTED: see `CONFIG_NOT_LOADABLE_PREFIX`.
21
+ * Extensions a consumer plausibly writes a config as, that this loader does not
22
+ * RESOLVE. Their only purpose is to be DETECTED: see `CONFIG_NOT_LOADABLE_PREFIX`.
23
+ *
24
+ * Named for what is actually true of them. `.mjs`, `.cjs` and `.json` are all
25
+ * perfectly readable by Node — `import()` handles every one of them today.
26
+ * Nothing here is unreadable; they are simply not in `LOADABLE_EXTENSIONS`, so
27
+ * this loader never forms a path with them, and a consumer who writes one gets
28
+ * "config present but not loadable" instead of a silent "not found". The old
29
+ * name, UNREADABLE_EXTENSIONS, asserted a property of Node that is false, and
30
+ * invited a future reader to "fix" it by adding them to the resolver.
23
31
  */
24
- const UNREADABLE_EXTENSIONS = ['mts', 'cts', 'tsx', 'jsx', 'mjs', 'cjs', 'json'];
32
+ const UNRESOLVED_EXTENSIONS = ['mts', 'cts', 'tsx', 'jsx', 'mjs', 'cjs', 'json'];
25
33
  /**
26
34
  * "There is no config here." Callers are allowed to treat this as benign —
27
35
  * `src/main.ts` does, for the optional `test/config/environment.*` override.
@@ -58,10 +66,150 @@ const FILE_TYPE_REFUSAL_CODES = new Set([
58
66
  'ERR_UNKNOWN_FILE_EXTENSION',
59
67
  'ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING',
60
68
  ]);
69
+ /**
70
+ * The absolute POSIX path a Node refusal names, in the two shapes it names it.
71
+ *
72
+ * Both refusal codes name the file they refused, but differently — measured on
73
+ * node v24.13.0 at this head:
74
+ *
75
+ * ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING
76
+ * Stripping types is currently unsupported for files under node_modules,
77
+ * for "/private/tmp/x/node_modules/dep/thing.ts"
78
+ * ERR_UNKNOWN_FILE_EXTENSION
79
+ * Unknown file extension ".ts" for /private/tmp/x/environment.ts
80
+ *
81
+ * In BOTH shapes the path is the last thing in the message, and both patterns
82
+ * are GREEDY, so each runs to the message tail rather than being bounded by a
83
+ * character class on the path body: the quoted one to the message-final quote,
84
+ * the bare one to the last `.ext` in the message. That is the whole mechanism —
85
+ * measured, an explicit `\s*$` anchor on either one is an equivalent mutant,
86
+ * so it is not there. The previous single pattern instead excluded space, `(`,
87
+ * `)`, `'` and `"` from the body,
88
+ * which meant a config under `~/My Project/` either failed extraction outright
89
+ * or backtracked onto an earlier `.` and yielded a truncated non-path.
90
+ * Measured end-to-end through `dist/` before this change, two consumers one
91
+ * character apart, each with a good `.js` config that nested-imports a `.ts`
92
+ * under `node_modules`:
93
+ *
94
+ * .../plain/config/environment.js -> raw ERR_UNSUPPORTED_...
95
+ * naming node_modules/dep/thing.ts
96
+ * .../My Project/config/environment.js -> "Config present but not loadable:
97
+ * .../My Project/config/environment.js"
98
+ *
99
+ * The second names a `.js` that loaded and ran perfectly. Anchoring on the
100
+ * tail extracts both, and the quoted form tolerates quotes inside the path
101
+ * because it runs to the message-final quote rather than to the first one.
102
+ *
103
+ * `(?:file:\/\/)?` is not defensive padding. Node names the refused file as a
104
+ * `file://` URL whenever the package scope containing it declares a `type`,
105
+ * and as a bare path when it does not -- one function
106
+ * (`stripTypeScriptModuleTypes`) reached from two call sites,
107
+ * `internal/modules/esm/translators:654,663` with the URL and
108
+ * `internal/modules/esm/get_format:148` with `fileURLToPath(url)`. Scope
109
+ * lookup stops at `node_modules`, so for `src/modules.ts:103` the deciding
110
+ * file is the MODULE's `package.json` -- and every `@stonyx/*` module declares
111
+ * `type: 'module'`, as does the app `src/cli/new.ts:81` scaffolds. The URL
112
+ * shape is the default case. See `test/unit/import-config-test.ts` for the
113
+ * measured matrix.
114
+ *
115
+ * Still POSIX-only, and still not exhaustive — a Windows path is not extracted,
116
+ * and neither is a message with trailing text after the path. That is now SAFE
117
+ * rather than merely degraded: see `refusalIsAboutTheConfig`.
118
+ */
119
+ const QUOTED_REFUSED_PATH = /["']((?:file:\/\/)?\/.+)["']/;
120
+ const BARE_REFUSED_PATH = /(?:^|\s)((?:file:\/\/)?\/.+\.[A-Za-z0-9]+)/;
121
+ /** Resolves symlinks so `/tmp/...` and `/private/tmp/...` compare equal. */
122
+ function realPath(path) {
123
+ try {
124
+ return realpathSync(path);
125
+ }
126
+ catch {
127
+ return path;
128
+ }
129
+ }
130
+ /**
131
+ * The path a refusal names, or `null` when no path can be extracted from it.
132
+ *
133
+ * `fileURLToPath` is contained for the same reason `realPath` is: this runs
134
+ * INSIDE `importConfig`'s catch handler, so anything it throws replaces the
135
+ * refusal being handled and takes its `cause` with it — the exact loss
136
+ * invariant I2 exists to prevent. Regex-matchable inputs that throw exist and
137
+ * were measured at this head: `file:///a%2Fb.ts` -> `ERR_INVALID_FILE_URL_PATH`,
138
+ * `file:///%.ts` and `file:///a%zz.ts` -> bare `URIError: URI malformed`.
139
+ *
140
+ * Node's own emissions never produce them — `pathToFileURL` percent-encodes a
141
+ * literal `%` and never emits a bare `%2F` for a POSIX filename — but the
142
+ * message is only USUALLY Node's. `refusalIsAboutTheConfig` is exported public
143
+ * API with no input validation, and a `register()` / `--import` loader hook
144
+ * (this suite itself runs under `tsx`) can throw `ERR_UNKNOWN_FILE_EXTENSION`
145
+ * with any message it likes. Driven end-to-end through `dist/` with such a
146
+ * hook before this containment, the consumer got `ERR_INVALID_FILE_URL_PATH:
147
+ * File URL path must not include encoded / characters` with `cause` undefined,
148
+ * and the refusal it was actually handling was gone.
149
+ *
150
+ * An unparseable URL returns `null`, which the predicate reads as "cannot
151
+ * tell" -> `false` -> the original error propagates untouched. Same fail
152
+ * direction as every other unknown in here.
153
+ *
154
+ * Quoted shape first: it is the more specific of the two. Measured at this
155
+ * head the order is an EQUIVALENT mutant — swapping it leaves the suite at
156
+ * 130/0, because neither measured message shape matches both patterns — so the
157
+ * order is a statement of intent, not a load-bearing branch. Recorded here so
158
+ * the next mutation run does not re-chase it.
159
+ */
160
+ function refusedPathFrom(message) {
161
+ const refused = QUOTED_REFUSED_PATH.exec(message)?.[1] ?? BARE_REFUSED_PATH.exec(message)?.[1];
162
+ if (!refused)
163
+ return null;
164
+ if (!refused.startsWith('file://'))
165
+ return refused;
166
+ try {
167
+ return fileURLToPath(refused);
168
+ }
169
+ catch {
170
+ return null;
171
+ }
172
+ }
173
+ /**
174
+ * Did this runtime refuse OUR config file, or something our config imported?
175
+ *
176
+ * `FILE_TYPE_REFUSAL_CODES.has(code)` alone cannot tell. A config that loaded
177
+ * and ran perfectly well, but whose own nested `import()` hit a `.ts` under
178
+ * `node_modules`, throws the SAME code — and was reported as "this Node runtime
179
+ * refused to load your config", naming a file that is fine. That misdirection
180
+ * points the consumer at the one file that is not the problem, and the likeliest
181
+ * instance of it is the exact `.ts`-under-node_modules case this loader's own
182
+ * docs tell people to look for.
183
+ *
184
+ * FAIL DIRECTION — this is the property, not an implementation detail.
185
+ * `true` means "re-frame this as a refusal of the config", which is exactly the
186
+ * F-3 misdirection above. So when no path can be extracted this returns
187
+ * `false`, and the caller rethrows Node's own error untouched, `cause` and all.
188
+ * The consumer then reads what actually happened instead of a friendly sentence
189
+ * about the wrong file. This is what makes every future gap in the two patterns
190
+ * harmless: an unparseable message costs the I2 re-framing, not correctness.
191
+ *
192
+ * It previously returned `true` here, on the reasoning that keeping the loud
193
+ * re-frame mattered more than getting the filename right. Measured, that is
194
+ * backwards: the raw error is loud too — `main.ts`'s `NODE_ENV=test` swallow
195
+ * only absorbs `CONFIG_NOT_FOUND_PREFIX`, which a Node refusal never starts
196
+ * with — so failing this way loses nothing and stops naming the wrong file.
197
+ *
198
+ * Exported ONLY so its branches can be reached directly. Driving it through
199
+ * `importConfig` reaches the two path-comparison outcomes and nothing else.
200
+ * A predicate inside the guard that makes failures loud does not get to have
201
+ * branches no test can reach.
202
+ */
203
+ export function refusalIsAboutTheConfig(message, configPath) {
204
+ const refusedPath = refusedPathFrom(message);
205
+ if (refusedPath === null)
206
+ return false;
207
+ return refusedPath === configPath || realPath(refusedPath) === realPath(configPath);
208
+ }
61
209
  export async function importConfig(basePath) {
62
210
  const matches = LOADABLE_EXTENSIONS.filter(ext => existsSync(`${basePath}.${ext}`));
63
211
  if (matches.length === 0) {
64
- const declined = UNREADABLE_EXTENSIONS.filter(ext => existsSync(`${basePath}.${ext}`));
212
+ const declined = UNRESOLVED_EXTENSIONS.filter(ext => existsSync(`${basePath}.${ext}`));
65
213
  if (declined.length > 0) {
66
214
  throw new Error(`${CONFIG_NOT_LOADABLE_PREFIX} ${basePath}.${declined.join(` and ${basePath}.`)} ` +
67
215
  `exists, but Stonyx loads ${basePath}.ts or ${basePath}.js only. ` +
@@ -79,12 +227,29 @@ export async function importConfig(basePath) {
79
227
  }
80
228
  catch (error) {
81
229
  const code = error?.code;
82
- if (code && FILE_TYPE_REFUSAL_CODES.has(code)) {
230
+ if (code && FILE_TYPE_REFUSAL_CODES.has(code) && refusalIsAboutTheConfig(error.message, path)) {
231
+ // Both files exist AND the `.ts` was refused. This is the one state where
232
+ // the both-present warning printed a few lines above is actively wrong
233
+ // advice: it says "delete the .js", and here the `.js` is the only file
234
+ // this runtime can read. Say so explicitly rather than leaving the
235
+ // consumer to reconcile two messages from the same call.
236
+ //
237
+ // It is also a deliberate behaviour change. `stonyx@0.2.3-beta.95`
238
+ // resolved `${basePath}.js` unconditionally, so this exact state LOADED
239
+ // and booted; measured against that loader, same fixture, plain node:
240
+ // it returned the `.js` default export with no warning. Preferring `.ts`
241
+ // is the point of #105, and the population most likely to hold both
242
+ // files is the one that worked around #105 by renaming to `.js` while
243
+ // the postinstall kept writing the `.ts` stub. So this message has to
244
+ // carry the "this used to work" fact, not just the remedy.
83
245
  const sibling = matches.length > 1
84
- ? ` A ${basePath}.js also exists; .ts wins by design, so this is not resolved by leaving the .js in place.`
246
+ ? ` ${basePath}.js also exists and this runtime CAN read it, but .ts wins the preference order` +
247
+ ` so the .js is never reached. Disregard the "delete the .js" warning above — in THIS state the` +
248
+ ` fix is the opposite one: remove or compile ${basePath}.ts.` +
249
+ ` (stonyx@0.2.3-beta.95 loaded the .js here; preferring .ts is a deliberate change — abofs/stonyx#105.)`
85
250
  : '';
86
251
  throw new Error(`${CONFIG_NOT_LOADABLE_PREFIX} ${path} exists, but this Node runtime refused to load it ` +
87
- `(${code}): ${error.message}${sibling}`, { cause: error });
252
+ `(${code}): ${error.message}.${sibling}`, { cause: error });
88
253
  }
89
254
  throw error;
90
255
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stonyx",
3
- "version": "0.2.3-alpha.47",
3
+ "version": "0.2.3-alpha.49",
4
4
  "description": "Base stonyx framework module",
5
5
  "main": "dist/main.js",
6
6
  "types": "dist/main.d.ts",