@nzyme/cli 0.13.0 → 0.15.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/bin/cli.js +3 -0
- package/dist/Command.d.ts +59 -0
- package/dist/Command.js +87 -0
- package/dist/Command.js.map +1 -0
- package/dist/Command.test.d.ts +1 -0
- package/dist/Command.test.js +77 -0
- package/dist/Command.test.js.map +1 -0
- package/dist/cli.d.ts +1 -1
- package/dist/cli.js +27 -15
- package/dist/cli.js.map +1 -1
- package/dist/codeIndex/IndexSettings.d.ts +60 -0
- package/dist/codeIndex/IndexSettings.js +59 -0
- package/dist/codeIndex/IndexSettings.js.map +1 -0
- package/dist/codeIndex/IndexSymbol.d.ts +32 -0
- package/dist/codeIndex/IndexSymbol.js +2 -0
- package/dist/codeIndex/IndexSymbol.js.map +1 -0
- package/dist/codeIndex/NzymeIndexConfig.d.ts +72 -0
- package/dist/codeIndex/NzymeIndexConfig.js +101 -0
- package/dist/codeIndex/NzymeIndexConfig.js.map +1 -0
- package/dist/codeIndex/NzymeIndexConfig.test.d.ts +1 -0
- package/dist/codeIndex/NzymeIndexConfig.test.js +56 -0
- package/dist/codeIndex/NzymeIndexConfig.test.js.map +1 -0
- package/dist/codeIndex/collectIndexSourceFiles.d.ts +8 -0
- package/dist/codeIndex/collectIndexSourceFiles.js +57 -0
- package/dist/codeIndex/collectIndexSourceFiles.js.map +1 -0
- package/dist/codeIndex/collectSymbols.d.ts +27 -0
- package/dist/codeIndex/collectSymbols.js +151 -0
- package/dist/codeIndex/collectSymbols.js.map +1 -0
- package/dist/codeIndex/collectSymbols.test.d.ts +1 -0
- package/dist/codeIndex/collectSymbols.test.js +204 -0
- package/dist/codeIndex/collectSymbols.test.js.map +1 -0
- package/dist/codeIndex/extractComponent.d.ts +25 -0
- package/dist/codeIndex/extractComponent.js +38 -0
- package/dist/codeIndex/extractComponent.js.map +1 -0
- package/dist/codeIndex/extractComponent.test.d.ts +1 -0
- package/dist/codeIndex/extractComponent.test.js +65 -0
- package/dist/codeIndex/extractComponent.test.js.map +1 -0
- package/dist/codeIndex/extractDefineSymbol.d.ts +30 -0
- package/dist/codeIndex/extractDefineSymbol.js +86 -0
- package/dist/codeIndex/extractDefineSymbol.js.map +1 -0
- package/dist/codeIndex/extractDefineSymbol.test.d.ts +1 -0
- package/dist/codeIndex/extractDefineSymbol.test.js +142 -0
- package/dist/codeIndex/extractDefineSymbol.test.js.map +1 -0
- package/dist/codeIndex/extractEntity.d.ts +29 -0
- package/dist/codeIndex/extractEntity.js +63 -0
- package/dist/codeIndex/extractEntity.js.map +1 -0
- package/dist/codeIndex/extractEntity.test.d.ts +1 -0
- package/dist/codeIndex/extractEntity.test.js +79 -0
- package/dist/codeIndex/extractEntity.test.js.map +1 -0
- package/dist/codeIndex/extractUtil.d.ts +27 -0
- package/dist/codeIndex/extractUtil.js +98 -0
- package/dist/codeIndex/extractUtil.js.map +1 -0
- package/dist/codeIndex/extractUtil.test.d.ts +1 -0
- package/dist/codeIndex/extractUtil.test.js +111 -0
- package/dist/codeIndex/extractUtil.test.js.map +1 -0
- package/dist/codeIndex/importPathOf.d.ts +18 -0
- package/dist/codeIndex/importPathOf.js +17 -0
- package/dist/codeIndex/importPathOf.js.map +1 -0
- package/dist/codeIndex/importPathOf.test.d.ts +1 -0
- package/dist/codeIndex/importPathOf.test.js +40 -0
- package/dist/codeIndex/importPathOf.test.js.map +1 -0
- package/dist/codeIndex/jsdocSummary.d.ts +9 -0
- package/dist/codeIndex/jsdocSummary.js +18 -0
- package/dist/codeIndex/jsdocSummary.js.map +1 -0
- package/dist/codeIndex/jsdocSummary.test.d.ts +1 -0
- package/dist/codeIndex/jsdocSummary.test.js +33 -0
- package/dist/codeIndex/jsdocSummary.test.js.map +1 -0
- package/dist/codeIndex/renderMarkdown.d.ts +27 -0
- package/dist/codeIndex/renderMarkdown.js +171 -0
- package/dist/codeIndex/renderMarkdown.js.map +1 -0
- package/dist/codeIndex/renderMarkdown.test.d.ts +1 -0
- package/dist/codeIndex/renderMarkdown.test.js +291 -0
- package/dist/codeIndex/renderMarkdown.test.js.map +1 -0
- package/dist/commands/DepcheckCommand.d.ts +25 -2
- package/dist/commands/DepcheckCommand.js +296 -107
- package/dist/commands/DepcheckCommand.js.map +1 -1
- package/dist/commands/FormatMarkdownCommand.d.ts +22 -0
- package/dist/commands/FormatMarkdownCommand.js +256 -0
- package/dist/commands/FormatMarkdownCommand.js.map +1 -0
- package/dist/commands/FormatMarkdownCommand.test.d.ts +1 -0
- package/dist/commands/FormatMarkdownCommand.test.js +82 -0
- package/dist/commands/FormatMarkdownCommand.test.js.map +1 -0
- package/dist/commands/IndexCommand.d.ts +20 -0
- package/dist/commands/IndexCommand.js +81 -0
- package/dist/commands/IndexCommand.js.map +1 -0
- package/dist/commands/IndexCommand.test.d.ts +1 -0
- package/dist/commands/IndexCommand.test.js +126 -0
- package/dist/commands/IndexCommand.test.js.map +1 -0
- package/dist/commands/LocaliseCommand.d.ts +23 -0
- package/dist/commands/LocaliseCommand.js +125 -0
- package/dist/commands/LocaliseCommand.js.map +1 -0
- package/dist/commands/MonorepoCommand.d.ts +23 -1
- package/dist/commands/MonorepoCommand.js +255 -149
- package/dist/commands/MonorepoCommand.js.map +1 -1
- package/dist/commands/QuietRunCommand.d.ts +27 -0
- package/dist/commands/QuietRunCommand.js +140 -0
- package/dist/commands/QuietRunCommand.js.map +1 -0
- package/dist/commands/QuietRunCommand.test.d.ts +1 -0
- package/dist/commands/QuietRunCommand.test.js +48 -0
- package/dist/commands/QuietRunCommand.test.js.map +1 -0
- package/dist/commands/SubmoduleBumpCommand.d.ts +27 -0
- package/dist/commands/SubmoduleBumpCommand.js +77 -0
- package/dist/commands/SubmoduleBumpCommand.js.map +1 -0
- package/dist/execute.d.ts +25 -0
- package/dist/execute.js +22 -0
- package/dist/execute.js.map +1 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/dist/initialize.d.ts +1 -15
- package/dist/initialize.js +4 -8
- package/dist/initialize.js.map +1 -1
- package/dist/quietRun/quietRunReport.d.ts +70 -0
- package/dist/quietRun/quietRunReport.js +128 -0
- package/dist/quietRun/quietRunReport.js.map +1 -0
- package/dist/quietRun/quietRunReport.test.d.ts +1 -0
- package/dist/quietRun/quietRunReport.test.js +87 -0
- package/dist/quietRun/quietRunReport.test.js.map +1 -0
- package/dist/submodule/GitRepository.d.ts +70 -0
- package/dist/submodule/GitRepository.js +129 -0
- package/dist/submodule/GitRepository.js.map +1 -0
- package/dist/submodule/bumpSubmodule.d.ts +45 -0
- package/dist/submodule/bumpSubmodule.js +52 -0
- package/dist/submodule/bumpSubmodule.js.map +1 -0
- package/dist/submodule/renderBumpSummary.d.ts +12 -0
- package/dist/submodule/renderBumpSummary.js +50 -0
- package/dist/submodule/renderBumpSummary.js.map +1 -0
- package/dist/submodule/renderBumpSummary.test.d.ts +1 -0
- package/dist/submodule/renderBumpSummary.test.js +55 -0
- package/dist/submodule/renderBumpSummary.test.js.map +1 -0
- package/dist/submodule/submodule.test.d.ts +1 -0
- package/dist/submodule/submodule.test.js +155 -0
- package/dist/submodule/submodule.test.js.map +1 -0
- package/package.json +55 -50
- package/dist/commands/BuildCommand.d.ts +0 -4
- package/dist/commands/BuildCommand.js +0 -47
- package/dist/commands/BuildCommand.js.map +0 -1
- package/dist/defineCommand.d.ts +0 -48
- package/dist/defineCommand.js +0 -11
- package/dist/defineCommand.js.map +0 -1
- package/dist/defineProgram.d.ts +0 -30
- package/dist/defineProgram.js +0 -53
- package/dist/defineProgram.js.map +0 -1
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
import { join } from 'node:path';
|
|
2
|
+
import { describe, expect, it } from 'bun:test';
|
|
3
|
+
import { getIndexSettings } from './IndexSettings.js';
|
|
4
|
+
import { renderMarkdown } from './renderMarkdown.js';
|
|
5
|
+
const ROOT = '/repo';
|
|
6
|
+
/** `@acme/utils` feeds UTILS.md; entities and an `actor` kind are configured. */
|
|
7
|
+
const settings = getIndexSettings({
|
|
8
|
+
globalUtilPackages: ['@acme/utils'],
|
|
9
|
+
defineKinds: [{ kind: 'actor', section: 'Actors', callee: 'defineActor', nameKey: 'type', order: 40 }],
|
|
10
|
+
entities: { tableFunctions: ['pgTable'] },
|
|
11
|
+
});
|
|
12
|
+
function pkg(name, path, description) {
|
|
13
|
+
return { path, packageJson: { name, description } };
|
|
14
|
+
}
|
|
15
|
+
function symbol(overrides) {
|
|
16
|
+
return {
|
|
17
|
+
importPath: `${overrides.packageName}/${overrides.exportName}.js`,
|
|
18
|
+
internalName: null,
|
|
19
|
+
description: null,
|
|
20
|
+
signature: null,
|
|
21
|
+
relPath: join('packages', 'pkg', 'src', `${overrides.exportName}.ts`),
|
|
22
|
+
...overrides,
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
describe('renderMarkdown', () => {
|
|
26
|
+
it('lists every package sorted by name in the root INDEX.md, incl. a zero-symbol one, with a UTILS.md link', () => {
|
|
27
|
+
const packages = [
|
|
28
|
+
pkg('@acme/zeta', join(ROOT, 'packages/zeta'), 'The zeta package.'),
|
|
29
|
+
pkg('@acme/alpha', join(ROOT, 'packages/alpha'), 'The alpha package.'),
|
|
30
|
+
pkg('@acme/empty', join(ROOT, 'packages/empty')),
|
|
31
|
+
];
|
|
32
|
+
const symbols = [
|
|
33
|
+
symbol({ kind: 'service', packageName: '@acme/alpha', exportName: 'AlphaService' }),
|
|
34
|
+
];
|
|
35
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
36
|
+
const rootIndex = files.get(join(ROOT, 'INDEX.md'));
|
|
37
|
+
expect(rootIndex).toBeDefined();
|
|
38
|
+
const lines = rootIndex.split('\n');
|
|
39
|
+
expect(lines[0]).toBe('<!-- AUTOGENERATED by `bun index` — do not edit. Run `bun index` to regenerate. -->');
|
|
40
|
+
// Packages appear sorted by name: alpha, empty, zeta.
|
|
41
|
+
const alphaLine = rootIndex.indexOf('@acme/alpha');
|
|
42
|
+
const emptyLine = rootIndex.indexOf('@acme/empty');
|
|
43
|
+
const zetaLine = rootIndex.indexOf('@acme/zeta');
|
|
44
|
+
expect(alphaLine).toBeGreaterThan(-1);
|
|
45
|
+
expect(emptyLine).toBeGreaterThan(-1);
|
|
46
|
+
expect(zetaLine).toBeGreaterThan(-1);
|
|
47
|
+
expect(alphaLine).toBeLessThan(emptyLine);
|
|
48
|
+
expect(emptyLine).toBeLessThan(zetaLine);
|
|
49
|
+
// Zero-symbol package still listed, with no description shown as a placeholder.
|
|
50
|
+
expect(rootIndex).toContain('packages/empty');
|
|
51
|
+
expect(rootIndex).toContain('_(no description)_');
|
|
52
|
+
// Alpha has a per-package INDEX.md (it has a non-util symbol) and root links to it.
|
|
53
|
+
expect(rootIndex).toContain(join('packages', 'alpha', 'INDEX.md').replaceAll('\\', '/'));
|
|
54
|
+
// Root links to UTILS.md.
|
|
55
|
+
expect(rootIndex).toContain('UTILS.md');
|
|
56
|
+
expect(files.has(join(ROOT, 'UTILS.md'))).toBe(true);
|
|
57
|
+
});
|
|
58
|
+
it('groups util symbols by package in UTILS.md, showing signature and importPath', () => {
|
|
59
|
+
const packages = [pkg('@acme/utils', join(ROOT, 'packages/utils'))];
|
|
60
|
+
const symbols = [
|
|
61
|
+
symbol({
|
|
62
|
+
kind: 'util',
|
|
63
|
+
packageName: '@acme/utils',
|
|
64
|
+
exportName: 'clamp',
|
|
65
|
+
importPath: '@acme/utils/clamp.js',
|
|
66
|
+
description: 'Clamps a number.',
|
|
67
|
+
signature: 'clamp(v: number): number',
|
|
68
|
+
}),
|
|
69
|
+
];
|
|
70
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
71
|
+
const utils = files.get(join(ROOT, 'UTILS.md'));
|
|
72
|
+
expect(utils).toBeDefined();
|
|
73
|
+
expect(utils.split('\n')[0]).toBe('<!-- AUTOGENERATED by `bun index` — do not edit. Run `bun index` to regenerate. -->');
|
|
74
|
+
expect(utils).toContain('## @acme/utils');
|
|
75
|
+
expect(utils).toContain('clamp(v: number): number');
|
|
76
|
+
expect(utils).toContain('Clamps a number.');
|
|
77
|
+
expect(utils).toContain('@acme/utils/clamp.js');
|
|
78
|
+
// A util-only package now also gets a per-package INDEX.md (with a Utils section).
|
|
79
|
+
const pkgIndex = files.get(join(ROOT, 'packages/utils', 'INDEX.md'));
|
|
80
|
+
expect(pkgIndex).toBeDefined();
|
|
81
|
+
expect(pkgIndex).toContain('## Utils');
|
|
82
|
+
expect(pkgIndex).toContain('clamp(v: number): number');
|
|
83
|
+
});
|
|
84
|
+
it('narrows UTILS.md to foundational packages, excluding a non-global package (which keeps it in its own INDEX.md only)', () => {
|
|
85
|
+
const packages = [
|
|
86
|
+
pkg('@acme/utils', join(ROOT, 'packages/utils')),
|
|
87
|
+
pkg('@acme/backend', join(ROOT, 'packages/backend')),
|
|
88
|
+
];
|
|
89
|
+
const symbols = [
|
|
90
|
+
symbol({
|
|
91
|
+
kind: 'util',
|
|
92
|
+
packageName: '@acme/utils',
|
|
93
|
+
exportName: 'clamp',
|
|
94
|
+
importPath: '@acme/utils/clamp.js',
|
|
95
|
+
signature: 'clamp(v: number): number',
|
|
96
|
+
}),
|
|
97
|
+
symbol({
|
|
98
|
+
kind: 'util',
|
|
99
|
+
packageName: '@acme/backend',
|
|
100
|
+
exportName: 'shardKeyOf',
|
|
101
|
+
importPath: '@acme/backend/shardKeyOf.js',
|
|
102
|
+
signature: 'shardKeyOf(id: string): number',
|
|
103
|
+
}),
|
|
104
|
+
];
|
|
105
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
106
|
+
const utils = files.get(join(ROOT, 'UTILS.md'));
|
|
107
|
+
expect(utils).toBeDefined();
|
|
108
|
+
expect(utils).toContain('@acme/utils');
|
|
109
|
+
expect(utils).toContain('clamp(v: number): number');
|
|
110
|
+
expect(utils).not.toContain('shardKeyOf');
|
|
111
|
+
expect(utils).not.toContain('@acme/backend');
|
|
112
|
+
// The non-global package's util still shows up in its own package INDEX.md Utils section.
|
|
113
|
+
const backendIndex = files.get(join(ROOT, 'packages/backend', 'INDEX.md'));
|
|
114
|
+
expect(backendIndex).toBeDefined();
|
|
115
|
+
expect(backendIndex).toContain('## Utils');
|
|
116
|
+
expect(backendIndex).toContain('shardKeyOf(id: string): number');
|
|
117
|
+
});
|
|
118
|
+
it('renders a package INDEX.md with Services before Endpoints, showing the endpoint RPC name', () => {
|
|
119
|
+
const packages = [pkg('@acme/api', join(ROOT, 'packages/api'), 'The API package.')];
|
|
120
|
+
const symbols = [
|
|
121
|
+
symbol({
|
|
122
|
+
kind: 'endpoint',
|
|
123
|
+
packageName: '@acme/api',
|
|
124
|
+
exportName: 'OrderGetEndpoint',
|
|
125
|
+
internalName: 'OrderGet',
|
|
126
|
+
}),
|
|
127
|
+
symbol({
|
|
128
|
+
kind: 'service',
|
|
129
|
+
packageName: '@acme/api',
|
|
130
|
+
exportName: 'OrderService',
|
|
131
|
+
}),
|
|
132
|
+
];
|
|
133
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
134
|
+
const pkgIndex = files.get(join(ROOT, 'packages/api', 'INDEX.md'));
|
|
135
|
+
expect(pkgIndex).toBeDefined();
|
|
136
|
+
expect(pkgIndex.split('\n')[0]).toBe('<!-- AUTOGENERATED by `bun index` — do not edit. Run `bun index` to regenerate. -->');
|
|
137
|
+
const servicesIdx = pkgIndex.indexOf('## Services');
|
|
138
|
+
const endpointsIdx = pkgIndex.indexOf('## Endpoints');
|
|
139
|
+
expect(servicesIdx).toBeGreaterThan(-1);
|
|
140
|
+
expect(endpointsIdx).toBeGreaterThan(-1);
|
|
141
|
+
expect(servicesIdx).toBeLessThan(endpointsIdx);
|
|
142
|
+
expect(pkgIndex).toContain('OrderGetEndpoint');
|
|
143
|
+
expect(pkgIndex).toContain('name: `OrderGet`');
|
|
144
|
+
});
|
|
145
|
+
it('renders Entities with the table name for a package with an entity symbol', () => {
|
|
146
|
+
const packages = [pkg('@acme/database', join(ROOT, 'packages/database'))];
|
|
147
|
+
const symbols = [
|
|
148
|
+
symbol({
|
|
149
|
+
kind: 'entity',
|
|
150
|
+
packageName: '@acme/database',
|
|
151
|
+
exportName: 'payment',
|
|
152
|
+
internalName: 'payment',
|
|
153
|
+
importPath: '@acme/database/schema/payment.js',
|
|
154
|
+
}),
|
|
155
|
+
];
|
|
156
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
157
|
+
const pkgIndex = files.get(join(ROOT, 'packages/database', 'INDEX.md'));
|
|
158
|
+
expect(pkgIndex).toBeDefined();
|
|
159
|
+
expect(pkgIndex).toContain('## Entities');
|
|
160
|
+
expect(pkgIndex).toContain('table: `payment`');
|
|
161
|
+
});
|
|
162
|
+
it('renders a package Utils section last (after Entities), signature-first like UTILS.md', () => {
|
|
163
|
+
const packages = [pkg('@acme/database', join(ROOT, 'packages/database'))];
|
|
164
|
+
const symbols = [
|
|
165
|
+
symbol({
|
|
166
|
+
kind: 'entity',
|
|
167
|
+
packageName: '@acme/database',
|
|
168
|
+
exportName: 'payment',
|
|
169
|
+
internalName: 'payment',
|
|
170
|
+
importPath: '@acme/database/schema/payment.js',
|
|
171
|
+
}),
|
|
172
|
+
symbol({
|
|
173
|
+
kind: 'util',
|
|
174
|
+
packageName: '@acme/database',
|
|
175
|
+
exportName: 'shardKeyOf',
|
|
176
|
+
importPath: '@acme/database/shardKeyOf.js',
|
|
177
|
+
description: 'Computes a shard key.',
|
|
178
|
+
signature: 'shardKeyOf(id: string): number',
|
|
179
|
+
}),
|
|
180
|
+
];
|
|
181
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
182
|
+
const pkgIndex = files.get(join(ROOT, 'packages/database', 'INDEX.md'));
|
|
183
|
+
expect(pkgIndex).toBeDefined();
|
|
184
|
+
const entitiesIdx = pkgIndex.indexOf('## Entities');
|
|
185
|
+
const utilsIdx = pkgIndex.indexOf('## Utils');
|
|
186
|
+
expect(entitiesIdx).toBeGreaterThan(-1);
|
|
187
|
+
expect(utilsIdx).toBeGreaterThan(-1);
|
|
188
|
+
expect(entitiesIdx).toBeLessThan(utilsIdx);
|
|
189
|
+
// Signature-first row style, same as the global UTILS.md.
|
|
190
|
+
expect(pkgIndex).toContain('- `shardKeyOf(id: string): number` — Computes a shard key. (`@acme/database/shardKeyOf.js`)');
|
|
191
|
+
});
|
|
192
|
+
it('emits a per-package file (with a Utils section) and a root link for a package whose only symbol is a util', () => {
|
|
193
|
+
const packages = [pkg('@acme/backend', join(ROOT, 'packages/backend'))];
|
|
194
|
+
const symbols = [
|
|
195
|
+
symbol({
|
|
196
|
+
kind: 'util',
|
|
197
|
+
packageName: '@acme/backend',
|
|
198
|
+
exportName: 'clamp',
|
|
199
|
+
importPath: '@acme/backend/clamp.js',
|
|
200
|
+
signature: 'clamp(v: number): number',
|
|
201
|
+
}),
|
|
202
|
+
];
|
|
203
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
204
|
+
const pkgIndex = files.get(join(ROOT, 'packages/backend', 'INDEX.md'));
|
|
205
|
+
expect(pkgIndex).toBeDefined();
|
|
206
|
+
expect(pkgIndex).toContain('## Utils');
|
|
207
|
+
expect(pkgIndex).toContain('clamp(v: number): number');
|
|
208
|
+
const rootIndex = files.get(join(ROOT, 'INDEX.md'));
|
|
209
|
+
expect(rootIndex).toContain(join('packages', 'backend', 'INDEX.md').replaceAll('\\', '/'));
|
|
210
|
+
});
|
|
211
|
+
it('produces a byte-identical Map when the same symbols are rendered in shuffled order (determinism)', () => {
|
|
212
|
+
const packages = [
|
|
213
|
+
pkg('@acme/zeta', join(ROOT, 'packages/zeta'), 'Zeta.'),
|
|
214
|
+
pkg('@acme/alpha', join(ROOT, 'packages/alpha'), 'Alpha.'),
|
|
215
|
+
];
|
|
216
|
+
const symbols = [
|
|
217
|
+
symbol({ kind: 'service', packageName: '@acme/alpha', exportName: 'BService' }),
|
|
218
|
+
symbol({ kind: 'service', packageName: '@acme/alpha', exportName: 'AService' }),
|
|
219
|
+
symbol({ kind: 'endpoint', packageName: '@acme/zeta', exportName: 'ZEndpoint', internalName: 'Z' }),
|
|
220
|
+
symbol({
|
|
221
|
+
kind: 'util',
|
|
222
|
+
packageName: '@acme/alpha',
|
|
223
|
+
exportName: 'helperB',
|
|
224
|
+
signature: 'helperB(): void',
|
|
225
|
+
}),
|
|
226
|
+
symbol({
|
|
227
|
+
kind: 'util',
|
|
228
|
+
packageName: '@acme/alpha',
|
|
229
|
+
exportName: 'helperA',
|
|
230
|
+
signature: 'helperA(): void',
|
|
231
|
+
}),
|
|
232
|
+
];
|
|
233
|
+
const shuffledSymbols = symbols.toReversed();
|
|
234
|
+
const shuffledPackages = packages.toReversed();
|
|
235
|
+
const a = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
236
|
+
const b = renderMarkdown({ root: ROOT, packages: shuffledPackages, symbols: shuffledSymbols, settings });
|
|
237
|
+
expect(a.size).toBe(b.size);
|
|
238
|
+
for (const [key, content] of a) {
|
|
239
|
+
expect(b.get(key)).toBe(content);
|
|
240
|
+
}
|
|
241
|
+
// Re-rendering the same input again is also byte-identical (idempotency).
|
|
242
|
+
const c = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
243
|
+
for (const [key, content] of a) {
|
|
244
|
+
expect(c.get(key)).toBe(content);
|
|
245
|
+
}
|
|
246
|
+
});
|
|
247
|
+
it('skips packages with no name', () => {
|
|
248
|
+
const packages = [
|
|
249
|
+
{ path: join(ROOT, 'packages/anon'), packageJson: {} },
|
|
250
|
+
pkg('@acme/named', join(ROOT, 'packages/named'), 'Named.'),
|
|
251
|
+
];
|
|
252
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols: [], settings });
|
|
253
|
+
const rootIndex = files.get(join(ROOT, 'INDEX.md'));
|
|
254
|
+
expect(rootIndex).not.toContain('packages/anon');
|
|
255
|
+
expect(rootIndex).toContain('@acme/named');
|
|
256
|
+
});
|
|
257
|
+
it('renders a configured kind in its configured place, labelled with its name key', () => {
|
|
258
|
+
const packages = [pkg('@acme/chat', join(ROOT, 'packages/chat'))];
|
|
259
|
+
const symbols = [
|
|
260
|
+
symbol({ kind: 'endpoint', packageName: '@acme/chat', exportName: 'ChatEndpoint', internalName: 'Chat' }),
|
|
261
|
+
symbol({ kind: 'actor', packageName: '@acme/chat', exportName: 'ChatActor', internalName: 'chat' }),
|
|
262
|
+
symbol({ kind: 'factory', packageName: '@acme/chat', exportName: 'ChatFactory', internalName: 'Chat' }),
|
|
263
|
+
];
|
|
264
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings });
|
|
265
|
+
const pkgIndex = files.get(join(ROOT, 'packages/chat', 'INDEX.md')) ?? '';
|
|
266
|
+
const factoriesIdx = pkgIndex.indexOf('## Factories');
|
|
267
|
+
const actorsIdx = pkgIndex.indexOf('## Actors');
|
|
268
|
+
const endpointsIdx = pkgIndex.indexOf('## Endpoints');
|
|
269
|
+
expect(factoriesIdx).toBeGreaterThan(-1);
|
|
270
|
+
expect(factoriesIdx).toBeLessThan(actorsIdx);
|
|
271
|
+
expect(actorsIdx).toBeLessThan(endpointsIdx);
|
|
272
|
+
expect(pkgIndex).toContain('type: `chat`');
|
|
273
|
+
});
|
|
274
|
+
it('lists the indexed kinds in the root INDEX.md preamble', () => {
|
|
275
|
+
const files = renderMarkdown({ root: ROOT, packages: [], symbols: [], settings });
|
|
276
|
+
expect(files.get(join(ROOT, 'INDEX.md'))).toContain('listing its services, commands, factories, actors, endpoints, components, entities, and `@util` helpers');
|
|
277
|
+
});
|
|
278
|
+
it('writes no UTILS.md and does not link it when no global util packages are configured', () => {
|
|
279
|
+
const packages = [pkg('@acme/utils', join(ROOT, 'packages/utils'))];
|
|
280
|
+
const symbols = [
|
|
281
|
+
symbol({ kind: 'util', packageName: '@acme/utils', exportName: 'clamp', signature: 'clamp(): void' }),
|
|
282
|
+
];
|
|
283
|
+
const files = renderMarkdown({ root: ROOT, packages, symbols, settings: getIndexSettings({}) });
|
|
284
|
+
expect(files.has(join(ROOT, 'UTILS.md'))).toBe(false);
|
|
285
|
+
const rootIndex = files.get(join(ROOT, 'INDEX.md'));
|
|
286
|
+
expect(rootIndex).not.toContain('UTILS.md');
|
|
287
|
+
expect(rootIndex).toContain('listing its services, commands, factories, endpoints, components, and `@util` helpers');
|
|
288
|
+
expect(files.get(join(ROOT, 'packages/utils', 'INDEX.md'))).toContain('clamp(): void');
|
|
289
|
+
});
|
|
290
|
+
});
|
|
291
|
+
//# sourceMappingURL=renderMarkdown.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderMarkdown.test.js","sourceRoot":"","sources":["../../src/codeIndex/renderMarkdown.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,IAAI,GAAG,OAAO,CAAC;AAErB,iFAAiF;AACjF,MAAM,QAAQ,GAAG,gBAAgB,CAAC;IAC9B,kBAAkB,EAAE,CAAC,aAAa,CAAC;IACnC,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACtG,QAAQ,EAAE,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC,EAAE;CAC5C,CAAC,CAAC;AAIH,SAAS,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,WAAoB;IACzD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;AACxD,CAAC;AAED,SAAS,MAAM,CAAC,SAA0B;IACtC,OAAO;QACH,UAAU,EAAE,GAAG,SAAS,CAAC,WAAW,IAAI,SAAS,CAAC,UAAU,KAAK;QACjE,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,IAAI;QACjB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,UAAU,KAAK,CAAC;QACrE,GAAG,SAAS;KACf,CAAC;AACN,CAAC;AAED,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,wGAAwG,EAAE,GAAG,EAAE;QAC9G,MAAM,QAAQ,GAAG;YACb,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,mBAAmB,CAAC;YACnE,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;YACtE,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;SACnD,CAAC;QACF,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;SACtF,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,SAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,qFAAqF,CAAC,CAAC;QAE7G,sDAAsD;QACtD,MAAM,SAAS,GAAG,SAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,SAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,SAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEzC,gFAAgF;QAChF,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAElD,oFAAoF;QACpF,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;QAEzF,0BAA0B;QAC1B,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAExC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACpF,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,aAAa;gBAC1B,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,sBAAsB;gBAClC,WAAW,EAAE,kBAAkB;gBAC/B,SAAS,EAAE,0BAA0B;aACxC,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAC9B,qFAAqF,CACxF,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAEhD,mFAAmF;QACnF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC;QACrE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qHAAqH,EAAE,GAAG,EAAE;QAC3H,MAAM,QAAQ,GAAG;YACb,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAChD,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;SACvD,CAAC;QACF,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,aAAa;gBAC1B,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,sBAAsB;gBAClC,SAAS,EAAE,0BAA0B;aACxC,CAAC;YACF,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,YAAY;gBACxB,UAAU,EAAE,6BAA6B;gBACzC,SAAS,EAAE,gCAAgC;aAC9C,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAE7C,0FAA0F;QAC1F,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0FAA0F,EAAE,GAAG,EAAE;QAChG,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACpF,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,WAAW;gBACxB,UAAU,EAAE,kBAAkB;gBAC9B,YAAY,EAAE,UAAU;aAC3B,CAAC;YACF,MAAM,CAAC;gBACH,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,WAAW;gBACxB,UAAU,EAAE,cAAc;aAC7B,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CACjC,qFAAqF,CACxF,CAAC;QAEF,MAAM,WAAW,GAAG,QAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrD,MAAM,YAAY,GAAG,QAAS,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAE/C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAChF,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gBAAgB;gBAC7B,UAAU,EAAE,SAAS;gBACrB,YAAY,EAAE,SAAS;gBACvB,UAAU,EAAE,kCAAkC;aACjD,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;QACxE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAC5F,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gBAAgB;gBAC7B,UAAU,EAAE,SAAS;gBACrB,YAAY,EAAE,SAAS;gBACvB,UAAU,EAAE,kCAAkC;aACjD,CAAC;YACF,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,gBAAgB;gBAC7B,UAAU,EAAE,YAAY;gBACxB,UAAU,EAAE,8BAA8B;gBAC1C,WAAW,EAAE,uBAAuB;gBACpC,SAAS,EAAE,gCAAgC;aAC9C,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;QACxE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAE/B,MAAM,WAAW,GAAG,QAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,QAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE3C,0DAA0D;QAC1D,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CACtB,6FAA6F,CAChG,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2GAA2G,EAAE,GAAG,EAAE;QACjH,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,eAAe;gBAC5B,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,wBAAwB;gBACpC,SAAS,EAAE,0BAA0B;aACxC,CAAC;SACL,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC,CAAC;QACvE,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QAEvD,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kGAAkG,EAAE,GAAG,EAAE;QACxG,MAAM,QAAQ,GAAG;YACb,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,OAAO,CAAC;YACvD,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,QAAQ,CAAC;SAC7D,CAAC;QACF,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;YAC/E,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;YAC/E,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;YACnG,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,aAAa;gBAC1B,UAAU,EAAE,SAAS;gBACrB,SAAS,EAAE,iBAAiB;aAC/B,CAAC;YACF,MAAM,CAAC;gBACH,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,aAAa;gBAC1B,UAAU,EAAE,SAAS;gBACrB,SAAS,EAAE,iBAAiB;aAC/B,CAAC;SACL,CAAC;QACF,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QAC7C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE/C,MAAM,CAAC,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEzG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,0EAA0E;QAC1E,MAAM,CAAC,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtE,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACnC,MAAM,QAAQ,GAAG;YACb,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;YACtD,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,QAAQ,CAAC;SAC7D,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE9E,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACjD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACrF,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QAClE,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;YACzG,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;YACnG,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;SAC1G,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1E,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAElF,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAC/C,yGAAyG,CAC5G,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qFAAqF,EAAE,GAAG,EAAE;QAC3F,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,GAAkB;YAC3B,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;SACxG,CAAC;QAEF,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAEhG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CACvB,uFAAuF,CAC1F,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
@@ -1,6 +1,29 @@
|
|
|
1
|
+
import { Command } from '../Command.js';
|
|
1
2
|
/**
|
|
2
3
|
* Command to check and manage package dependencies
|
|
3
4
|
*/
|
|
4
|
-
export declare
|
|
5
|
+
export declare class DepcheckCommand extends Command {
|
|
6
|
+
static paths: string[][];
|
|
7
|
+
static usage: import("clipanion").Usage;
|
|
5
8
|
fix: boolean | undefined;
|
|
6
|
-
|
|
9
|
+
interactive: boolean | undefined;
|
|
10
|
+
/**
|
|
11
|
+
* Executes the depcheck command to analyze and manage package dependencies
|
|
12
|
+
*/
|
|
13
|
+
run(): Promise<void>;
|
|
14
|
+
private processPackage;
|
|
15
|
+
/**
|
|
16
|
+
* Fetches the latest version of a package from npm
|
|
17
|
+
*/
|
|
18
|
+
private getLatestVersion;
|
|
19
|
+
/**
|
|
20
|
+
* Prompts user for action on a dependency
|
|
21
|
+
* @returns 'remove' | 'skip' | 'ignore' for unused deps, 'add-dep' | 'add-dev' | 'skip' for missing deps
|
|
22
|
+
*/
|
|
23
|
+
private promptAction;
|
|
24
|
+
/**
|
|
25
|
+
* Adds a dependency to the depcheck ignore list in package.json
|
|
26
|
+
*/
|
|
27
|
+
private addToIgnoreList;
|
|
28
|
+
private getOptions;
|
|
29
|
+
}
|