@miyaoka/fsss 0.1.0 → 0.2.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/README.md +117 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/codegen.d.ts +3 -0
- package/dist/codegen.d.ts.map +1 -0
- package/dist/codegen.js +57 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +76 -24
- package/dist/plugin.d.ts +12 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/router.d.ts +1 -0
- package/dist/router.d.ts.map +1 -1
- package/dist/types.d.ts +19 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +7 -2
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# fsss
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@miyaoka/fsss)
|
|
4
|
+
[](https://www.npmjs.com/package/@miyaoka/fsss)
|
|
5
|
+
[](https://github.com/miyaoka/fsss/blob/main/LICENSE)
|
|
6
|
+
|
|
7
|
+
**fsss** — "File Structure, Single Schema" — bun + TypeScript + Zod
|
|
8
|
+
|
|
9
|
+
> ファイル構造がそのままコマンド構造になり、スキーマを一回書けば CLI フラグ・環境変数・設定ファイルのどこから値が来ても同じように型付きで受け取れる CLI フレームワーク
|
|
10
|
+
>
|
|
11
|
+
> _A CLI framework where your file structure becomes your command structure, and a single schema gives you typed values whether they come from flags, env vars, or config files._
|
|
12
|
+
|
|
13
|
+
## File Structure — ファイルを置くだけでコマンドが生える
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
commands/
|
|
17
|
+
serve.ts → my-app serve
|
|
18
|
+
config/
|
|
19
|
+
set.ts → my-app config set
|
|
20
|
+
get.ts → my-app config get
|
|
21
|
+
remote/
|
|
22
|
+
[name]/
|
|
23
|
+
push.ts → my-app remote origin push
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
ファイルを置くだけでコマンドが生える。ディレクトリのネストがサブコマンドの階層になる。`[name]` は動的セグメントで、`params.name` として値を受け取れる。
|
|
27
|
+
|
|
28
|
+
## Single Schema — 1つの定義で CLI / env / config を統合
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
// commands/serve.ts
|
|
32
|
+
export default defineCommand({
|
|
33
|
+
description: "サーバーを起動する",
|
|
34
|
+
args: {
|
|
35
|
+
port: {
|
|
36
|
+
type: z.coerce.number().min(1).max(65535),
|
|
37
|
+
description: "ポート番号",
|
|
38
|
+
alias: "p",
|
|
39
|
+
default: 3000,
|
|
40
|
+
},
|
|
41
|
+
host: {
|
|
42
|
+
type: z.string(),
|
|
43
|
+
description: "ホスト名",
|
|
44
|
+
default: "localhost",
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
run({ args }) {
|
|
48
|
+
// args.port: number, args.host: string — 型推論される
|
|
49
|
+
console.log(`${args.host}:${args.port}`);
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
この1つの定義だけで、CLI フラグ・環境変数・設定ファイル・デフォルト値のすべてが統合される。
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
CLI flag my-app serve --port 8080 ← 最優先
|
|
58
|
+
env MYAPP_SERVE_PORT=5000 ← prefix + コマンドパス + arg 名で自動導出
|
|
59
|
+
config file { "serve": { "port": 4000 } } ← コマンドツリーと同じ構造
|
|
60
|
+
default 3000
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
どのソースから来た値も、最終的に同じ Zod スキーマでバリデーションされる。
|
|
64
|
+
|
|
65
|
+
### 環境変数の自動マッピング
|
|
66
|
+
|
|
67
|
+
`autoEnv` を指定すると、コマンドパス + arg 名から環境変数名を自動導出する。
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
const cli = createCLI({
|
|
71
|
+
name: "my-app",
|
|
72
|
+
autoEnv: { prefix: "MYAPP" },
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
| コマンド | arg | 自動導出される env 名 |
|
|
77
|
+
| ------------- | ------- | ------------------------- |
|
|
78
|
+
| `serve` | `port` | `MYAPP_SERVE_PORT` |
|
|
79
|
+
| `remote push` | `force` | `MYAPP_REMOTE_PUSH_FORCE` |
|
|
80
|
+
|
|
81
|
+
### 設定ファイルの自動マッピング
|
|
82
|
+
|
|
83
|
+
config ファイルの JSON 構造はコマンドツリーと一致する。
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"serve": { "port": 5000, "host": "0.0.0.0" },
|
|
88
|
+
"remote": { "push": { "force": true } }
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
my-app --config app.json serve
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### ヘルプ自動生成
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
$ my-app serve --help
|
|
100
|
+
|
|
101
|
+
サーバーを起動する
|
|
102
|
+
|
|
103
|
+
Usage: my-app serve [options]
|
|
104
|
+
|
|
105
|
+
Options:
|
|
106
|
+
-p, --port <port> ポート番号 (env: MYAPP_SERVE_PORT, default: 3000)
|
|
107
|
+
--host <host> ホスト名 (env: MYAPP_SERVE_HOST, default: localhost)
|
|
108
|
+
-h, --help ヘルプを表示する
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## ドキュメント
|
|
112
|
+
|
|
113
|
+
- [ファイルベースルーティング](docs/routing.md) — コマンドツリー、動的セグメント、params と args の分離
|
|
114
|
+
- [スキーマと値の解決](docs/schema.md) — defineCommand、args 定義、値の優先順位、ヘルプ生成
|
|
115
|
+
- [設定ファイルと環境変数](docs/config.md) — autoEnv、config ファイル階層、`--config` フラグ
|
|
116
|
+
- [内部アーキテクチャ](docs/architecture.md) — パイプライン設計、各モジュールの責務、処理トレース
|
|
117
|
+
- [既存ツールとの比較](docs/comparison.md) — commander / oclif / Pastel / Gud CLI / convict との比較
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAaA,UAAU,aAAa;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,UAAU,GAAG;IACX,GAAG,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAgFD,iBAAS,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,CA4G3C;AAED,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../src/codegen.ts"],"names":[],"mappings":""}
|
package/dist/codegen.js
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { join, relative } from "node:path";
|
|
3
|
+
import { mkdir, readFile, readdir, writeFile } from "node:fs/promises";
|
|
4
|
+
import { parseArgs } from "node:util";
|
|
5
|
+
var PLUGINS_DIR_NAME = "_plugins", PLUGIN_FILE_EXTENSION = ".ts", INTERFACE_NAME_PATTERN = /export\s+interface\s+(\w+)/g;
|
|
6
|
+
async function findAllPluginFiles(t) {
|
|
7
|
+
let n = [];
|
|
8
|
+
async function r(t) {
|
|
9
|
+
let a = await readdir(t, { withFileTypes: !0 });
|
|
10
|
+
for (let o of a) {
|
|
11
|
+
if (!o.isDirectory()) continue;
|
|
12
|
+
let a = join(t, o.name);
|
|
13
|
+
if (o.name === PLUGINS_DIR_NAME) {
|
|
14
|
+
let t = await readdir(a, { withFileTypes: !0 });
|
|
15
|
+
for (let r of t) r.isFile() && r.name.endsWith(PLUGIN_FILE_EXTENSION) && n.push(join(a, r.name));
|
|
16
|
+
continue;
|
|
17
|
+
}
|
|
18
|
+
await r(a);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
return await r(t), n.sort();
|
|
22
|
+
}
|
|
23
|
+
async function extractInterfaceNames(e) {
|
|
24
|
+
let t = await readFile(e, "utf-8"), n = [], i = INTERFACE_NAME_PATTERN.exec(t);
|
|
25
|
+
for (; i !== null;) n.push(i[1]), i = INTERFACE_NAME_PATTERN.exec(t);
|
|
26
|
+
return n;
|
|
27
|
+
}
|
|
28
|
+
async function generateExtensionsType(r, i) {
|
|
29
|
+
let o = await findAllPluginFiles(r), s = [];
|
|
30
|
+
for (let e of o) {
|
|
31
|
+
let n = await extractInterfaceNames(e);
|
|
32
|
+
if (n.length === 0) continue;
|
|
33
|
+
let r = relative(i, e).replace(/\.ts$/, ""), a = r.startsWith(".") ? r : `./${r}`;
|
|
34
|
+
s.push({
|
|
35
|
+
importPath: a,
|
|
36
|
+
interfaceNames: n
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
let c = ["// このファイルは自動生成されます。手動で編集しないでください。"];
|
|
40
|
+
if (s.length === 0) c.push("", "declare module \"@miyaoka/fsss\" {", " // eslint-disable-next-line @typescript-eslint/no-empty-object-type", " interface Extensions {}", "}", "");
|
|
41
|
+
else {
|
|
42
|
+
for (let e of s) {
|
|
43
|
+
let t = e.interfaceNames.join(", ");
|
|
44
|
+
c.push(`import type { ${t} } from "${e.importPath}";`);
|
|
45
|
+
}
|
|
46
|
+
let e = s.flatMap((e) => e.interfaceNames);
|
|
47
|
+
c.push("", "declare module \"@miyaoka/fsss\" {", ` interface Extensions extends ${e.join(", ")} {}`, "}", "");
|
|
48
|
+
}
|
|
49
|
+
await mkdir(i, { recursive: !0 });
|
|
50
|
+
let l = join(i, "extensions.d.ts");
|
|
51
|
+
await writeFile(l, c.join("\n"), "utf-8"), console.log(`Generated ${l}`);
|
|
52
|
+
}
|
|
53
|
+
var { values } = parseArgs({ options: {
|
|
54
|
+
commandsDir: { type: "string" },
|
|
55
|
+
outDir: { type: "string" }
|
|
56
|
+
} });
|
|
57
|
+
(values.commandsDir === void 0 || values.outDir === void 0) && (console.error("Usage: bun run codegen.ts --commandsDir <path> --outDir <path>"), process.exit(1)), await generateExtensionsType(values.commandsDir, values.outDir);
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export { createCLI } from './cli';
|
|
2
|
+
export { definePlugin } from './plugin';
|
|
2
3
|
export { defineCommand } from './types';
|
|
3
4
|
export type { CLI, CLIOptions } from './cli';
|
|
4
|
-
export type { ArgDef, ArgDefBase, ArgsDefs, CommandConfig, InferArgs, Params, RunContext, } from './types';
|
|
5
|
+
export type { ArgDef, ArgDefBase, ArgsDefs, CommandConfig, Extensions, InferArgs, Middleware, MiddlewareContext, Params, PluginConfig, PluginContext, PluginSetup, RunContext, } from './types';
|
|
5
6
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC7C,YAAY,EACV,MAAM,EACN,UAAU,EACV,QAAQ,EACR,aAAa,EACb,SAAS,EACT,MAAM,EACN,UAAU,GACX,MAAM,SAAS,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC7C,YAAY,EACV,MAAM,EACN,UAAU,EACV,QAAQ,EACR,aAAa,EACb,UAAU,EACV,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,MAAM,EACN,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,GACX,MAAM,SAAS,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -204,6 +204,47 @@ function parseTokens(e, t) {
|
|
|
204
204
|
doubleDashArgs: i
|
|
205
205
|
};
|
|
206
206
|
}
|
|
207
|
+
var PLUGINS_DIR_NAME = "_plugins", PLUGIN_FILE_EXTENSION = ".ts";
|
|
208
|
+
function definePlugin(e) {
|
|
209
|
+
return e;
|
|
210
|
+
}
|
|
211
|
+
async function resolvePlugins(e, t) {
|
|
212
|
+
let n = {}, r = [];
|
|
213
|
+
for (let i of e) {
|
|
214
|
+
let e = await i(t);
|
|
215
|
+
e.provide !== void 0 && Object.assign(n, e.provide), e.middleware !== void 0 && r.push(e.middleware);
|
|
216
|
+
}
|
|
217
|
+
return {
|
|
218
|
+
extensions: n,
|
|
219
|
+
middlewares: r
|
|
220
|
+
};
|
|
221
|
+
}
|
|
222
|
+
function buildMiddlewareChain(e, t) {
|
|
223
|
+
let n = t;
|
|
224
|
+
for (let t = e.length - 1; t >= 0; t--) {
|
|
225
|
+
let r = e[t], i = n;
|
|
226
|
+
n = (e) => r(e, () => i(e));
|
|
227
|
+
}
|
|
228
|
+
return n;
|
|
229
|
+
}
|
|
230
|
+
async function scanPluginsAlongPath(t, n) {
|
|
231
|
+
let r = [];
|
|
232
|
+
for (let n of t) {
|
|
233
|
+
let t = join(n, PLUGINS_DIR_NAME), i;
|
|
234
|
+
try {
|
|
235
|
+
i = await readdir(t, { withFileTypes: !0 });
|
|
236
|
+
} catch {
|
|
237
|
+
continue;
|
|
238
|
+
}
|
|
239
|
+
let a = i.filter((e) => e.isFile() && e.name.endsWith(PLUGIN_FILE_EXTENSION)).sort((e, t) => e.name.localeCompare(t.name));
|
|
240
|
+
for (let n of a) {
|
|
241
|
+
let i = join(t, n.name), a = (await import(i)).default;
|
|
242
|
+
if (a === void 0) throw Error(`Plugin file ${i} does not have a default export`);
|
|
243
|
+
r.push(a);
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
return resolvePlugins(r, n);
|
|
247
|
+
}
|
|
207
248
|
function resolveEnvName(e, t, n, r) {
|
|
208
249
|
if (e !== void 0) return e;
|
|
209
250
|
if (t !== void 0) return deriveEnvName(t, n, r);
|
|
@@ -246,7 +287,7 @@ function resolveValues(e) {
|
|
|
246
287
|
}
|
|
247
288
|
return s;
|
|
248
289
|
}
|
|
249
|
-
var DYNAMIC_SEGMENT_PATTERN = /^\[(.+)]$/, COMMAND_FILE_EXTENSION = ".ts", INDEX_FILE_NAME = "index";
|
|
290
|
+
var DYNAMIC_SEGMENT_PATTERN = /^\[(.+)]$/, COMMAND_FILE_EXTENSION = ".ts", INDEX_FILE_NAME = "index", INTERNAL_PREFIX = "_";
|
|
250
291
|
async function fileExists(e) {
|
|
251
292
|
try {
|
|
252
293
|
return (await stat(e)).isFile();
|
|
@@ -257,7 +298,7 @@ async function fileExists(e) {
|
|
|
257
298
|
async function listAvailableEntries(e) {
|
|
258
299
|
try {
|
|
259
300
|
let t = await readdir(e, { withFileTypes: !0 }), n = [];
|
|
260
|
-
for (let e of t) {
|
|
301
|
+
for (let e of t) if (!e.name.startsWith(INTERNAL_PREFIX)) {
|
|
261
302
|
if (e.isFile() && e.name.endsWith(COMMAND_FILE_EXTENSION)) {
|
|
262
303
|
let t = e.name.slice(0, -3);
|
|
263
304
|
if (t === INDEX_FILE_NAME) continue;
|
|
@@ -289,45 +330,47 @@ async function listAvailableEntries(e) {
|
|
|
289
330
|
}
|
|
290
331
|
}
|
|
291
332
|
async function resolveRoute(t, r) {
|
|
292
|
-
let i = resolve(t), a = {}, o = 0;
|
|
333
|
+
let i = resolve(t), a = {}, o = [i], s = 0;
|
|
293
334
|
for (let t = 0; t < r.length; t++) {
|
|
294
335
|
let n = r[t];
|
|
295
336
|
if (n.startsWith("-")) break;
|
|
296
|
-
let
|
|
297
|
-
if (
|
|
337
|
+
let l = await readdir(i, { withFileTypes: !0 }), u = n + COMMAND_FILE_EXTENSION, d = l.find((e) => e.isFile() && e.name === u);
|
|
338
|
+
if (d) return s = t + 1, {
|
|
298
339
|
kind: "resolved",
|
|
299
|
-
filePath: join(i,
|
|
340
|
+
filePath: join(i, d.name),
|
|
300
341
|
params: a,
|
|
301
|
-
remainingTokens: r.slice(
|
|
342
|
+
remainingTokens: r.slice(s),
|
|
343
|
+
traversedDirs: o
|
|
302
344
|
};
|
|
303
|
-
let
|
|
304
|
-
if (
|
|
305
|
-
i = join(i,
|
|
345
|
+
let f = l.find((e) => e.isDirectory() && e.name === n);
|
|
346
|
+
if (f) {
|
|
347
|
+
i = join(i, f.name), o.push(i), s = t + 1;
|
|
306
348
|
continue;
|
|
307
349
|
}
|
|
308
|
-
let
|
|
350
|
+
let p, m = l.find((e) => {
|
|
309
351
|
if (!e.isDirectory()) return !1;
|
|
310
352
|
let t = e.name.match(DYNAMIC_SEGMENT_PATTERN);
|
|
311
|
-
return t === null ? !1 : (
|
|
353
|
+
return t === null ? !1 : (p = t[1], !0);
|
|
312
354
|
});
|
|
313
|
-
if (
|
|
314
|
-
a[
|
|
355
|
+
if (m && p !== void 0) {
|
|
356
|
+
a[p] = n, i = join(i, m.name), o.push(i), s = t + 1;
|
|
315
357
|
continue;
|
|
316
358
|
}
|
|
317
359
|
break;
|
|
318
360
|
}
|
|
319
|
-
let
|
|
320
|
-
if (await fileExists(
|
|
361
|
+
let l = join(i, INDEX_FILE_NAME + COMMAND_FILE_EXTENSION);
|
|
362
|
+
if (await fileExists(l)) return {
|
|
321
363
|
kind: "resolved",
|
|
322
|
-
filePath:
|
|
364
|
+
filePath: l,
|
|
323
365
|
params: a,
|
|
324
|
-
remainingTokens: r.slice(
|
|
366
|
+
remainingTokens: r.slice(s),
|
|
367
|
+
traversedDirs: o
|
|
325
368
|
};
|
|
326
|
-
let
|
|
369
|
+
let u = await listAvailableEntries(i);
|
|
327
370
|
return {
|
|
328
371
|
kind: "unresolved",
|
|
329
372
|
stoppedDir: i,
|
|
330
|
-
availableEntries:
|
|
373
|
+
availableEntries: u
|
|
331
374
|
};
|
|
332
375
|
}
|
|
333
376
|
function wrapWithStringPreprocess(e) {
|
|
@@ -424,14 +467,23 @@ function createCLI(e) {
|
|
|
424
467
|
}
|
|
425
468
|
throw e instanceof Error && (console.error(generateValidationErrorHelp(u, [e.message])), process.exit(EXIT_CODE_ERROR)), e;
|
|
426
469
|
}
|
|
427
|
-
await
|
|
470
|
+
let { extensions: p, middlewares: m } = await scanPluginsAlongPath(o.traversedDirs, { cliName: n }), h = {
|
|
471
|
+
commandPath: l,
|
|
428
472
|
params: o.params,
|
|
429
|
-
args: f
|
|
430
|
-
|
|
473
|
+
args: f,
|
|
474
|
+
extensions: p
|
|
475
|
+
};
|
|
476
|
+
await buildMiddlewareChain(m, async (e) => {
|
|
477
|
+
await s.run({
|
|
478
|
+
params: e.params,
|
|
479
|
+
args: e.args,
|
|
480
|
+
extensions: e.extensions
|
|
481
|
+
});
|
|
482
|
+
})(h);
|
|
431
483
|
}
|
|
432
484
|
return { run: a };
|
|
433
485
|
}
|
|
434
486
|
function defineCommand(e) {
|
|
435
487
|
return e;
|
|
436
488
|
}
|
|
437
|
-
export { createCLI, defineCommand };
|
|
489
|
+
export { createCLI, defineCommand, definePlugin };
|
package/dist/plugin.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Extensions, Middleware, MiddlewareContext, PluginContext, PluginSetup } from './types';
|
|
2
|
+
interface ResolvedPlugins {
|
|
3
|
+
extensions: Extensions;
|
|
4
|
+
middlewares: Middleware[];
|
|
5
|
+
}
|
|
6
|
+
declare function definePlugin(setup: PluginSetup): PluginSetup;
|
|
7
|
+
declare function resolvePlugins(plugins: PluginSetup[], pluginContext: PluginContext): Promise<ResolvedPlugins>;
|
|
8
|
+
declare function buildMiddlewareChain(middlewares: Middleware[], finalHandler: (context: MiddlewareContext) => Promise<void>): (context: MiddlewareContext) => Promise<void>;
|
|
9
|
+
declare function scanPluginsAlongPath(traversedDirs: string[], pluginContext: PluginContext): Promise<ResolvedPlugins>;
|
|
10
|
+
export { buildMiddlewareChain, definePlugin, resolvePlugins, scanPluginsAlongPath };
|
|
11
|
+
export type { ResolvedPlugins };
|
|
12
|
+
//# sourceMappingURL=plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,WAAW,EACZ,MAAM,SAAS,CAAC;AAKjB,UAAU,eAAe;IACvB,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,iBAAS,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW,CAErD;AAED,iBAAe,cAAc,CAC3B,OAAO,EAAE,WAAW,EAAE,EACtB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,eAAe,CAAC,CAiB1B;AAGD,iBAAS,oBAAoB,CAC3B,WAAW,EAAE,UAAU,EAAE,EACzB,YAAY,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,GAC1D,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAW/C;AAID,iBAAe,oBAAoB,CACjC,aAAa,EAAE,MAAM,EAAE,EACvB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,eAAe,CAAC,CA+B1B;AAED,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,CAAC;AACpF,YAAY,EAAE,eAAe,EAAE,CAAC"}
|
package/dist/router.d.ts
CHANGED
package/dist/router.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAQA,UAAU,aAAa;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,UAAU,eAAe;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,cAAc,EAAE,CAAC;CACpC;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,KAAK,WAAW,GAAG,aAAa,GAAG,eAAe,CAAC;AAqDnD,iBAAe,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAmFvF;AAED,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -15,9 +15,27 @@ type InferArgs<T extends ArgsDefs> = {
|
|
|
15
15
|
[K in keyof T]: T[K]["multiple"] extends true ? z.output<T[K]["type"]>[] : z.output<T[K]["type"]>;
|
|
16
16
|
};
|
|
17
17
|
type Params = Record<string, string>;
|
|
18
|
+
interface Extensions {
|
|
19
|
+
}
|
|
20
|
+
interface MiddlewareContext {
|
|
21
|
+
commandPath: string[];
|
|
22
|
+
params: Params;
|
|
23
|
+
args: Record<string, unknown>;
|
|
24
|
+
extensions: Extensions;
|
|
25
|
+
}
|
|
26
|
+
type Middleware = (context: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
|
|
27
|
+
interface PluginContext {
|
|
28
|
+
cliName: string;
|
|
29
|
+
}
|
|
30
|
+
interface PluginConfig {
|
|
31
|
+
provide?: Partial<Extensions>;
|
|
32
|
+
middleware?: Middleware;
|
|
33
|
+
}
|
|
34
|
+
type PluginSetup = (context: PluginContext) => PluginConfig | Promise<PluginConfig>;
|
|
18
35
|
interface RunContext<T extends ArgsDefs> {
|
|
19
36
|
params: Params;
|
|
20
37
|
args: InferArgs<T>;
|
|
38
|
+
extensions: Extensions;
|
|
21
39
|
}
|
|
22
40
|
interface CommandConfig<T extends ArgsDefs = ArgsDefs> {
|
|
23
41
|
description?: string;
|
|
@@ -26,5 +44,5 @@ interface CommandConfig<T extends ArgsDefs = ArgsDefs> {
|
|
|
26
44
|
}
|
|
27
45
|
declare function defineCommand<T extends ArgsDefs>(config: CommandConfig<T>): CommandConfig<T>;
|
|
28
46
|
export { defineCommand };
|
|
29
|
-
export type { ArgDef, ArgDefBase, ArgsDefs, CommandConfig, InferArgs, Params, RunContext };
|
|
47
|
+
export type { ArgDef, ArgDefBase, ArgsDefs, CommandConfig, Extensions, InferArgs, Middleware, MiddlewareContext, Params, PluginConfig, PluginContext, PluginSetup, RunContext, };
|
|
30
48
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAItC,UAAU,UAAU,CAAC,CAAC,SAAS,OAAO;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAGD,KAAK,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAGlC,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAIvC,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAClG,CAAC;AAMF,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAItC,UAAU,UAAU,CAAC,CAAC,SAAS,OAAO;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAGD,KAAK,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAGlC,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAIvC,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAClG,CAAC;AAMF,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAMrC,UAAU,UAAU;CAAG;AAGvB,UAAU,iBAAiB;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,KAAK,UAAU,GAAG,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAG3F,UAAU,aAAa;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,YAAY;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,KAAK,WAAW,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAIpF,UAAU,UAAU,CAAC,CAAC,SAAS,QAAQ;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,UAAU,aAAa,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,GAAG,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAOD,iBAAS,aAAa,CAAC,CAAC,SAAS,QAAQ,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAErF;AAED,OAAO,EAAE,aAAa,EAAE,CAAC;AACzB,YAAY,EACV,MAAM,EACN,UAAU,EACV,QAAQ,EACR,aAAa,EACb,UAAU,EACV,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,MAAM,EACN,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,GACX,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@miyaoka/fsss",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "A CLI framework where your file structure becomes your command structure, and a single schema gives you typed values whether they come from flags, env vars, or config files.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "miyaoka",
|
|
@@ -20,6 +20,9 @@
|
|
|
20
20
|
],
|
|
21
21
|
"main": "dist/index.js",
|
|
22
22
|
"types": "dist/index.d.ts",
|
|
23
|
+
"bin": {
|
|
24
|
+
"fsss-codegen": "./dist/codegen.js"
|
|
25
|
+
},
|
|
23
26
|
"exports": {
|
|
24
27
|
".": {
|
|
25
28
|
"types": "./dist/index.d.ts",
|
|
@@ -30,7 +33,9 @@
|
|
|
30
33
|
"dist"
|
|
31
34
|
],
|
|
32
35
|
"scripts": {
|
|
33
|
-
"
|
|
36
|
+
"prepack": "cp ../../README.md .",
|
|
37
|
+
"postpack": "rm README.md",
|
|
38
|
+
"prepare": "vite build",
|
|
34
39
|
"build": "vite build",
|
|
35
40
|
"dev": "vite build --watch",
|
|
36
41
|
"test": "bun test",
|