@nzyme/cli 0.14.0 → 0.15.1
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 +48 -5
- package/dist/Command.js +69 -6
- package/dist/Command.js.map +1 -1
- 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 +23 -3
- 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 +17 -0
- package/dist/commands/DepcheckCommand.js +229 -42
- 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 +14 -0
- package/dist/commands/MonorepoCommand.js +243 -144
- 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 +7 -2
- package/dist/execute.js +4 -2
- package/dist/execute.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- 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 -15
- package/dist/commands/BuildCommand.js +0 -49
- package/dist/commands/BuildCommand.js.map +0 -1
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
import fs from 'node:fs/promises';
|
|
2
|
+
import * as path from 'node:path';
|
|
3
|
+
import chalk from 'chalk';
|
|
4
|
+
import { defaultHandlers } from 'mdast-util-to-markdown';
|
|
5
|
+
import { remark } from 'remark';
|
|
6
|
+
import remarkFrontmatter from 'remark-frontmatter';
|
|
7
|
+
import remarkGfm from 'remark-gfm';
|
|
8
|
+
import { isFileIgnored } from '@nzyme/project-utils/isFileIgnored.js';
|
|
9
|
+
import { forEachParalell } from '@nzyme/utils/array/forEachParalell.js';
|
|
10
|
+
import { Command } from '../Command.js';
|
|
11
|
+
import { Option } from '../index.js';
|
|
12
|
+
const MARKDOWN_REGEX = /\.mdx?$/;
|
|
13
|
+
/** Bounded parallelism for file processing — high throughput without opening a handle per file. */
|
|
14
|
+
const CONCURRENCY = 20;
|
|
15
|
+
/** Parse-only pipeline used to check whether dropping an escape changes document structure. */
|
|
16
|
+
const structureChecker = remark().use(remarkFrontmatter, ['yaml']).use(remarkGfm, { singleTilde: false });
|
|
17
|
+
/**
|
|
18
|
+
* Removes backslashes that do not affect how the complete document parses. Checking the whole
|
|
19
|
+
* document keeps surrounding delimiters in view and covers escapes emitted outside text nodes,
|
|
20
|
+
* such as image destinations and line-start punctuation.
|
|
21
|
+
* @__NO_SIDE_EFFECTS__
|
|
22
|
+
*/
|
|
23
|
+
function removeInertEscapes(markdown) {
|
|
24
|
+
const expectedStructure = markdownStructure(markdown);
|
|
25
|
+
let result = markdown;
|
|
26
|
+
const escapedCharacters = new Set();
|
|
27
|
+
for (const match of markdown.matchAll(/\\([!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~])/g)) {
|
|
28
|
+
escapedCharacters.add(match[0]);
|
|
29
|
+
}
|
|
30
|
+
for (const escaped of escapedCharacters) {
|
|
31
|
+
const candidate = result.split(escaped).join(escaped.slice(1));
|
|
32
|
+
if (candidate !== result && markdownStructure(candidate) === expectedStructure) {
|
|
33
|
+
result = candidate;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
const escapePositions = [];
|
|
37
|
+
for (const match of result.matchAll(/\\[!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~]/g)) {
|
|
38
|
+
if (match.index != null) {
|
|
39
|
+
escapePositions.push(match.index);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
return removeEscapeGroup(result, escapePositions);
|
|
43
|
+
function removeEscapeGroup(current, positions) {
|
|
44
|
+
if (positions.length === 0) {
|
|
45
|
+
return current;
|
|
46
|
+
}
|
|
47
|
+
let candidate = '';
|
|
48
|
+
let copiedThrough = 0;
|
|
49
|
+
for (const position of positions) {
|
|
50
|
+
candidate += current.slice(copiedThrough, position);
|
|
51
|
+
copiedThrough = position + 1;
|
|
52
|
+
}
|
|
53
|
+
candidate += current.slice(copiedThrough);
|
|
54
|
+
if (markdownStructure(candidate) === expectedStructure) {
|
|
55
|
+
return candidate;
|
|
56
|
+
}
|
|
57
|
+
if (positions.length === 1) {
|
|
58
|
+
return current;
|
|
59
|
+
}
|
|
60
|
+
const midpoint = Math.ceil(positions.length / 2);
|
|
61
|
+
const afterRight = removeEscapeGroup(current, positions.slice(midpoint));
|
|
62
|
+
return removeEscapeGroup(afterRight, positions.slice(0, midpoint));
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Serializes an mdast tree without source positions so equivalent parses compare identically.
|
|
67
|
+
* @__NO_SIDE_EFFECTS__
|
|
68
|
+
*/
|
|
69
|
+
function markdownStructure(markdown) {
|
|
70
|
+
return JSON.stringify(structureChecker.parse(markdown), (key, value) => key === 'position' ? undefined : value);
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Whether the bare text alone parses back into exactly the same link, i.e. it is a literal
|
|
74
|
+
* autolink that gfm-autolink-literal re-links on its own. Asking the parser instead of matching
|
|
75
|
+
* known schemes is what keeps ordinary links whose text equals their destination — relative paths
|
|
76
|
+
* like `[README.md](README.md)` or `[#anchor](#anchor)` — from being unwrapped into plain text,
|
|
77
|
+
* which would destroy them.
|
|
78
|
+
* @__NO_SIDE_EFFECTS__
|
|
79
|
+
*/
|
|
80
|
+
function isLiteralAutolink(text, url) {
|
|
81
|
+
const root = structureChecker.parse(text);
|
|
82
|
+
const [paragraph, ...blocks] = root.children;
|
|
83
|
+
if (blocks.length > 0 || paragraph?.type !== 'paragraph') {
|
|
84
|
+
return false;
|
|
85
|
+
}
|
|
86
|
+
const [link, ...siblings] = paragraph.children;
|
|
87
|
+
if (siblings.length > 0 || link?.type !== 'link' || link.url !== url || link.title) {
|
|
88
|
+
return false;
|
|
89
|
+
}
|
|
90
|
+
const [child, ...rest] = link.children;
|
|
91
|
+
return rest.length === 0 && child?.type === 'text' && child.value === text;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Link handler that emits a bare literal autolink instead of wrapping it. gfm-autolink-literal
|
|
95
|
+
* parses bare URLs/emails into link nodes, and the default stringifier then emits noise:
|
|
96
|
+
* `http://localhost:6006` → `<http://localhost:6006>`, `a@b.com` → `<a@b.com>`, and
|
|
97
|
+
* `www.foo.com` → `[www.foo.com](http://www.foo.com)`. When a link is exactly such an autolink —
|
|
98
|
+
* a single text child, no title, and text the parser turns back into this very link — return the
|
|
99
|
+
* raw text so it stays bare. This renders identically (gfm re-links it) and is idempotent.
|
|
100
|
+
* Everything else defers to the default handler.
|
|
101
|
+
*/
|
|
102
|
+
function unwrapAutolink(node, parent, state, info) {
|
|
103
|
+
const [child, ...rest] = node.children;
|
|
104
|
+
if (!node.title && rest.length === 0 && child?.type === 'text') {
|
|
105
|
+
if (isLiteralAutolink(child.value, node.url)) {
|
|
106
|
+
return child.value;
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
return defaultHandlers.link(node, parent, state, info);
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Hard-break handler: emit the invisible two-space form instead of the default visible `\`.
|
|
113
|
+
* Delegates to the default handler first so unsafe scopes (table cells, headings — where a raw
|
|
114
|
+
* newline is illegal) still collapse to a space. Only the real backslash break is rewritten, and
|
|
115
|
+
* it is `info.before`-aware: if the preceding text already ends in spaces, emit only enough to
|
|
116
|
+
* total two, so `word \` (one stray source space) canonicalises to exactly `word␣␣` in a single
|
|
117
|
+
* pass rather than `word␣␣␣` (idempotency would otherwise need two passes).
|
|
118
|
+
*/
|
|
119
|
+
function twoSpaceBreak(node, parent, state, info) {
|
|
120
|
+
const rendered = defaultHandlers.break(node, parent, state, info);
|
|
121
|
+
if (rendered !== '\\\n') {
|
|
122
|
+
return rendered;
|
|
123
|
+
}
|
|
124
|
+
const trailingSpaces = (/ *$/.exec(info.before) ?? [''])[0].length;
|
|
125
|
+
return ' '.repeat(Math.max(0, 2 - trailingSpaces)) + '\n';
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* remark-stringify settings tuned to minimise tokens: compact (unaligned) GFM tables,
|
|
129
|
+
* single-space list indentation, `-` bullets/rules, and prose-preserving handlers (no escaping
|
|
130
|
+
* noise, bare URLs, invisible hard breaks). No prose re-wrapping — remark preserves author line
|
|
131
|
+
* breaks by default.
|
|
132
|
+
*/
|
|
133
|
+
const STRINGIFY_SETTINGS = {
|
|
134
|
+
bullet: '-',
|
|
135
|
+
listItemIndent: 'one',
|
|
136
|
+
rule: '-',
|
|
137
|
+
fences: true,
|
|
138
|
+
tightDefinitions: true,
|
|
139
|
+
handlers: { link: unwrapAutolink, break: twoSpaceBreak },
|
|
140
|
+
};
|
|
141
|
+
/**
|
|
142
|
+
* A remark pipeline that round-trips YAML frontmatter verbatim and renders GFM tables
|
|
143
|
+
* without alignment padding — the padding oxfmt adds is the dominant token cost.
|
|
144
|
+
*/
|
|
145
|
+
const processor = remark()
|
|
146
|
+
.use(remarkFrontmatter, ['yaml'])
|
|
147
|
+
.use(remarkGfm, { tablePipeAlign: false, tableCellPadding: false, singleTilde: false })
|
|
148
|
+
.data('settings', STRINGIFY_SETTINGS);
|
|
149
|
+
/**
|
|
150
|
+
* Token-minimising markdown formatter. Reserialises markdown files (or every `.md`/`.mdx`
|
|
151
|
+
* file under the given directories) through remark with compact GFM tables — the opposite
|
|
152
|
+
* of an aligning formatter like oxfmt/prettier. Reusable across projects; point it at any
|
|
153
|
+
* markdown that should stay small (e.g. agent skill files).
|
|
154
|
+
*/
|
|
155
|
+
export class FormatMarkdownCommand extends Command {
|
|
156
|
+
static paths = [['format-markdown']];
|
|
157
|
+
static usage = Command.Usage({
|
|
158
|
+
category: 'Format',
|
|
159
|
+
description: 'Format markdown for minimal tokens (compact GFM tables)',
|
|
160
|
+
details: `
|
|
161
|
+
Reserialises markdown through remark with un-padded GFM tables and single-space
|
|
162
|
+
list indentation. Arguments are files or directories; directories are walked
|
|
163
|
+
recursively for .md/.mdx files (gitignored paths are skipped). With no arguments
|
|
164
|
+
the current working directory is used. Pass --exclude to skip a file or directory
|
|
165
|
+
(e.g. generated/scraped docs or a nested submodule); repeatable. By default only a
|
|
166
|
+
summary count is printed; pass --verbose to log every file formatted/reformatted.
|
|
167
|
+
`,
|
|
168
|
+
examples: [
|
|
169
|
+
['Format the whole repo', 'nzyme format-markdown .'],
|
|
170
|
+
[
|
|
171
|
+
'Skip generated docs and a submodule',
|
|
172
|
+
'nzyme format-markdown . --exclude nzyme --exclude packages/scraped-docs',
|
|
173
|
+
],
|
|
174
|
+
['Check without writing', 'nzyme format-markdown --check docs'],
|
|
175
|
+
['List each file formatted', 'nzyme format-markdown --verbose docs'],
|
|
176
|
+
],
|
|
177
|
+
});
|
|
178
|
+
check = Option.Boolean('--check,-c', {
|
|
179
|
+
description: 'Do not write; exit non-zero if any file would change',
|
|
180
|
+
});
|
|
181
|
+
verbose = Option.Boolean('--verbose,-v', {
|
|
182
|
+
description: 'Log each file formatted/reformatted (default: summary count only)',
|
|
183
|
+
});
|
|
184
|
+
exclude = Option.Array('--exclude,-e', [], {
|
|
185
|
+
description: 'File or directory to skip (repeatable)',
|
|
186
|
+
});
|
|
187
|
+
inputs = Option.Rest();
|
|
188
|
+
cwd = process.cwd();
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
*/
|
|
192
|
+
async run() {
|
|
193
|
+
const inputs = this.inputs.length > 0 ? this.inputs : ['.'];
|
|
194
|
+
const excluded = new Set(this.exclude.map(entry => this.toAbsolute(entry)));
|
|
195
|
+
const files = [];
|
|
196
|
+
for (const input of inputs) {
|
|
197
|
+
await this.collectFiles(this.toAbsolute(input), excluded, files);
|
|
198
|
+
}
|
|
199
|
+
let changed = 0;
|
|
200
|
+
await forEachParalell(files, {
|
|
201
|
+
concurrency: CONCURRENCY,
|
|
202
|
+
callback: async (file) => {
|
|
203
|
+
const source = await fs.readFile(file, 'utf-8');
|
|
204
|
+
const safelyFormatted = String(await processor.process(source));
|
|
205
|
+
const formatted = safelyFormatted === source ? source : removeInertEscapes(safelyFormatted);
|
|
206
|
+
if (formatted === source) {
|
|
207
|
+
return;
|
|
208
|
+
}
|
|
209
|
+
changed++;
|
|
210
|
+
if (this.check) {
|
|
211
|
+
if (this.verbose) {
|
|
212
|
+
const relative = path.relative(this.cwd, file);
|
|
213
|
+
this.logger.warn(`Would reformat ${chalk.yellow(relative)}`);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
else {
|
|
217
|
+
await fs.writeFile(file, formatted);
|
|
218
|
+
if (this.verbose) {
|
|
219
|
+
const relative = path.relative(this.cwd, file);
|
|
220
|
+
this.logger.info(`Formatted ${chalk.green(relative)}`);
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
});
|
|
225
|
+
if (this.check && changed > 0) {
|
|
226
|
+
this.logger.error(`${changed} markdown file(s) are not formatted`);
|
|
227
|
+
return 1;
|
|
228
|
+
}
|
|
229
|
+
this.logger.info(`${this.check ? 'Checked' : 'Formatted'} ${files.length} markdown file(s), ${changed} changed`);
|
|
230
|
+
return 0;
|
|
231
|
+
}
|
|
232
|
+
async collectFiles(target, excluded, results) {
|
|
233
|
+
if (excluded.has(target) || isFileIgnored(target) === true) {
|
|
234
|
+
return;
|
|
235
|
+
}
|
|
236
|
+
const stats = await fs.stat(target);
|
|
237
|
+
if (stats.isDirectory()) {
|
|
238
|
+
const entries = await fs.readdir(target, { withFileTypes: true });
|
|
239
|
+
for (const entry of entries) {
|
|
240
|
+
// A symlinked file or directory is formatted where it actually lives, or not at all (e.g. a link
|
|
241
|
+
// into a git submodule); explicit inputs never reach this loop, so they still follow symlinks.
|
|
242
|
+
if (entry.isSymbolicLink()) {
|
|
243
|
+
continue;
|
|
244
|
+
}
|
|
245
|
+
await this.collectFiles(path.join(target, entry.name), excluded, results);
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
else if (stats.isFile() && MARKDOWN_REGEX.test(target)) {
|
|
249
|
+
results.push(target);
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
toAbsolute(file) {
|
|
253
|
+
return path.isAbsolute(file) ? file : path.join(this.cwd, file);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
//# sourceMappingURL=FormatMarkdownCommand.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FormatMarkdownCommand.js","sourceRoot":"","sources":["../../src/commands/FormatMarkdownCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,cAAc,GAAG,SAAS,CAAC;AAEjC,mGAAmG;AACnG,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,+FAA+F;AAC/F,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;AAE1G;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,QAAgB;IACxC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,MAAM,GAAG,QAAQ,CAAC;IAEtB,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5C,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,QAAQ,CAAC,4CAA4C,CAAC,EAAE,CAAC;QAClF,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,MAAM,IAAI,iBAAiB,CAAC,SAAS,CAAC,KAAK,iBAAiB,EAAE,CAAC;YAC7E,MAAM,GAAG,SAAS,CAAC;QACvB,CAAC;IACL,CAAC;IAED,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,0CAA0C,CAAC,EAAE,CAAC;QAC9E,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACtB,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;IAED,OAAO,iBAAiB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAElD,SAAS,iBAAiB,CAAC,OAAe,EAAE,SAAmB;QAC3D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC;QACnB,CAAC;QAED,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YACpD,aAAa,GAAG,QAAQ,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE1C,IAAI,iBAAiB,CAAC,SAAS,CAAC,KAAK,iBAAiB,EAAE,CAAC;YACrD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC;QACnB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzE,OAAO,iBAAiB,CAAC,UAAU,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,KAAc,EAAE,EAAE,CAC5E,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CACzC,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,IAAY,EAAE,GAAW;IAChD,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,SAAS,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC7C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,EAAE,IAAI,KAAK,WAAW,EAAE,CAAC;QACvD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC;IAC/C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,EAAE,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACjF,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;IACvC,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,EAAE,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC;AAC/E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,cAAc,CAAC,IAAU,EAAE,MAA2B,EAAE,KAAY,EAAE,IAAU;IACrF,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;IACvC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;QAC7D,IAAI,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,OAAO,KAAK,CAAC,KAAK,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CAAC,IAAW,EAAE,MAA2B,EAAE,KAAY,EAAE,IAAU;IACrF,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAClE,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,MAAM,cAAc,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,GAAG,IAAI,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG;IACvB,MAAM,EAAE,GAAG;IACX,cAAc,EAAE,KAAK;IACrB,IAAI,EAAE,GAAG;IACT,MAAM,EAAE,IAAI;IACZ,gBAAgB,EAAE,IAAI;IACtB,QAAQ,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,aAAa,EAAE;CAClD,CAAC;AAEX;;;GAGG;AACH,MAAM,SAAS,GAAG,MAAM,EAAE;KACrB,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC;KAChC,GAAG,CAAC,SAAS,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;KACtF,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,OAAO,qBAAsB,SAAQ,OAAO;IAC9C,MAAM,CAAU,KAAK,GAAG,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAE9C,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAClC,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,yDAAyD;QACtE,OAAO,EAAE;;;;;;;SAOR;QACD,QAAQ,EAAE;YACN,CAAC,uBAAuB,EAAE,yBAAyB,CAAC;YACpD;gBACI,qCAAqC;gBACrC,yEAAyE;aAC5E;YACD,CAAC,uBAAuB,EAAE,oCAAoC,CAAC;YAC/D,CAAC,0BAA0B,EAAE,sCAAsC,CAAC;SACvE;KACJ,CAAC,CAAC;IAEH,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE;QACjC,WAAW,EAAE,sDAAsD;KACtE,CAAC,CAAC;IAEH,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE;QACrC,WAAW,EAAE,mEAAmE;KACnF,CAAC,CAAC;IAEH,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,EAAE;QACvC,WAAW,EAAE,wCAAwC;KACxD,CAAC,CAAC;IAEH,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAEvB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAEpB;;OAEG;IACM,KAAK,CAAC,GAAG;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAE5E,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QACrE,CAAC;QAED,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,MAAM,eAAe,CAAC,KAAK,EAAE;YACzB,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;gBACnB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChD,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChE,MAAM,SAAS,GAAG,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;gBAE5F,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;oBACvB,OAAO;gBACX,CAAC;gBAED,OAAO,EAAE,CAAC;gBACV,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACb,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;wBACf,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;wBAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;oBACjE,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBACpC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;wBACf,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;wBAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;oBAC3D,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,qCAAqC,CAAC,CAAC;YACnE,OAAO,CAAC,CAAC;QACb,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,sBAAsB,OAAO,UAAU,CACjG,CAAC;QACF,OAAO,CAAC,CAAC;IACb,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,QAAqB,EAAE,OAAiB;QAC/E,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;YACzD,OAAO;QACX,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAClE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC1B,iGAAiG;gBACjG,+FAA+F;gBAC/F,IAAI,KAAK,CAAC,cAAc,EAAE,EAAE,CAAC;oBACzB,SAAS;gBACb,CAAC;gBACD,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC9E,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAEO,UAAU,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;CACJ"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import fs from 'node:fs/promises';
|
|
2
|
+
import os from 'node:os';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { expect, test } from 'bun:test';
|
|
5
|
+
const CLI_PATH = new URL('../cli.ts', import.meta.url).pathname;
|
|
6
|
+
test('formats ambiguous markdown idempotently without unnecessary escapes', async () => {
|
|
7
|
+
const directory = await fs.mkdtemp(path.join(os.tmpdir(), 'format-markdown-'));
|
|
8
|
+
const file = path.join(directory, 'fixture.md');
|
|
9
|
+
await fs.writeFile(file, [
|
|
10
|
+
'- **@/\\* import resolution**: Handles `@/*` imports correctly',
|
|
11
|
+
'',
|
|
12
|
+
'',
|
|
13
|
+
'',
|
|
14
|
+
'**Example Query: **',
|
|
15
|
+
'',
|
|
16
|
+
'curl --request GET \\',
|
|
17
|
+
"--url '{{BASE_URL}}/v3/order/{{order_id}}/result/pdf' \\",
|
|
18
|
+
"--header 'accept: application/json'",
|
|
19
|
+
'',
|
|
20
|
+
'[OLH - API TRT.postman_collection.json](./assets/OLH - API TRT.postman_collection.json)',
|
|
21
|
+
'',
|
|
22
|
+
'- **support@clientdomain.com**** - contact support',
|
|
23
|
+
' or \\*\\*',
|
|
24
|
+
'',
|
|
25
|
+
].join('\n'));
|
|
26
|
+
expect(await runFormatMarkdown(file)).toBe(0);
|
|
27
|
+
const firstPass = await fs.readFile(file, 'utf8');
|
|
28
|
+
expect(await runFormatMarkdown(file)).toBe(0);
|
|
29
|
+
const secondPass = await fs.readFile(file, 'utf8');
|
|
30
|
+
expect(secondPass).toBe(firstPass);
|
|
31
|
+
expect(firstPass).toContain('**@/\\* import resolution**');
|
|
32
|
+
expect(firstPass).not.toContain('\\&');
|
|
33
|
+
expect(firstPass).not.toContain('\\--url');
|
|
34
|
+
expect(firstPass).not.toContain(']\\(');
|
|
35
|
+
expect(firstPass).not.toContain('\\*\\*Example Query');
|
|
36
|
+
});
|
|
37
|
+
test('keeps links whose text equals their destination but only unwraps literal autolinks', async () => {
|
|
38
|
+
const directory = await fs.mkdtemp(path.join(os.tmpdir(), 'format-markdown-'));
|
|
39
|
+
const file = path.join(directory, 'fixture.md');
|
|
40
|
+
await fs.writeFile(file, [
|
|
41
|
+
'See [README.md](README.md), [docs/foo.md](docs/foo.md) and [#anchor](#anchor).',
|
|
42
|
+
'',
|
|
43
|
+
'Autolinks: [http://localhost:6006](http://localhost:6006), [a@b.com](mailto:a@b.com)',
|
|
44
|
+
'and [www.foo.com](http://www.foo.com).',
|
|
45
|
+
'',
|
|
46
|
+
].join('\n'));
|
|
47
|
+
expect(await runFormatMarkdown(file)).toBe(0);
|
|
48
|
+
const firstPass = await fs.readFile(file, 'utf8');
|
|
49
|
+
expect(await runFormatMarkdown(file)).toBe(0);
|
|
50
|
+
expect(await fs.readFile(file, 'utf8')).toBe(firstPass);
|
|
51
|
+
expect(firstPass).toContain('[README.md](README.md)');
|
|
52
|
+
expect(firstPass).toContain('[docs/foo.md](docs/foo.md)');
|
|
53
|
+
expect(firstPass).toContain('[#anchor](#anchor)');
|
|
54
|
+
expect(firstPass).toContain('Autolinks: http://localhost:6006, a@b.com');
|
|
55
|
+
expect(firstPass).toContain('and www.foo.com.');
|
|
56
|
+
});
|
|
57
|
+
test('does not follow symlinks found while walking a directory but formats an explicitly passed symlink', async () => {
|
|
58
|
+
const directory = await fs.mkdtemp(path.join(os.tmpdir(), 'format-markdown-'));
|
|
59
|
+
const linkedDirectory = path.join(directory, 'linked');
|
|
60
|
+
const walkedDirectory = path.join(directory, 'walked');
|
|
61
|
+
const unformatted = '* item\n';
|
|
62
|
+
await fs.mkdir(linkedDirectory);
|
|
63
|
+
await fs.mkdir(walkedDirectory);
|
|
64
|
+
await fs.writeFile(path.join(linkedDirectory, 'fixture.md'), unformatted);
|
|
65
|
+
await fs.writeFile(path.join(walkedDirectory, 'plain.md'), unformatted);
|
|
66
|
+
await fs.symlink(linkedDirectory, path.join(walkedDirectory, 'link-to-directory'));
|
|
67
|
+
await fs.symlink(path.join(linkedDirectory, 'fixture.md'), path.join(walkedDirectory, 'link-to-file.md'));
|
|
68
|
+
expect(await runFormatMarkdown(walkedDirectory)).toBe(0);
|
|
69
|
+
expect(await fs.readFile(path.join(walkedDirectory, 'plain.md'), 'utf8')).not.toBe(unformatted);
|
|
70
|
+
expect(await fs.readFile(path.join(linkedDirectory, 'fixture.md'), 'utf8')).toBe(unformatted);
|
|
71
|
+
expect(await runFormatMarkdown(path.join(walkedDirectory, 'link-to-directory'))).toBe(0);
|
|
72
|
+
expect(await fs.readFile(path.join(linkedDirectory, 'fixture.md'), 'utf8')).not.toBe(unformatted);
|
|
73
|
+
});
|
|
74
|
+
function runFormatMarkdown(file) {
|
|
75
|
+
const child = Bun.spawn([process.execPath, '--conditions=source', CLI_PATH, 'format-markdown', file], {
|
|
76
|
+
cwd: path.dirname(CLI_PATH),
|
|
77
|
+
stdout: 'ignore',
|
|
78
|
+
stderr: 'ignore',
|
|
79
|
+
});
|
|
80
|
+
return child.exited;
|
|
81
|
+
}
|
|
82
|
+
//# sourceMappingURL=FormatMarkdownCommand.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FormatMarkdownCommand.test.js","sourceRoot":"","sources":["../../src/commands/FormatMarkdownCommand.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;AAEhE,IAAI,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;IACnF,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,EAAE,CAAC,SAAS,CACd,IAAI,EACJ;QACI,gEAAgE;QAChE,EAAE;QACF,qEAAqE;QACrE,EAAE;QACF,qBAAqB;QACrB,EAAE;QACF,uBAAuB;QACvB,0DAA0D;QAC1D,qCAAqC;QACrC,EAAE;QACF,yFAAyF;QACzF,EAAE;QACF,oDAAoD;QACpD,aAAa;QACb,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;IAEF,MAAM,CAAC,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAElD,MAAM,CAAC,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEnD,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;IAC3D,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;AAC3D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;IAClG,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,EAAE,CAAC,SAAS,CACd,IAAI,EACJ;QACI,gFAAgF;QAChF,EAAE;QACF,sFAAsF;QACtF,wCAAwC;QACxC,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;IAEF,MAAM,CAAC,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAElD,MAAM,CAAC,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9C,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;IACtD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;IAC1D,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAClD,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,2CAA2C,CAAC,CAAC;IACzE,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;AACpD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mGAAmG,EAAE,KAAK,IAAI,EAAE;IACjH,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC/E,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,UAAU,CAAC;IAC/B,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,WAAW,CAAC,CAAC;IAC1E,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;IACxE,MAAM,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACnF,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAE1G,MAAM,CAAC,MAAM,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzD,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChG,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAE9F,MAAM,CAAC,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzF,MAAM,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACtG,CAAC,CAAC,CAAC;AAEH,SAAS,iBAAiB,CAAC,IAAY;IACnC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,qBAAqB,EAAE,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE;QAClG,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC3B,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,MAAM,CAAC;AACxB,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Command } from '../Command.js';
|
|
2
|
+
/**
|
|
3
|
+
* Generates the repo's code index, so a coding agent has a fast, always-fresh map of the codebase
|
|
4
|
+
* instead of re-deriving it by grepping every session (and reinventing utilities that already
|
|
5
|
+
* exist). Crawls every workspace package for `defineX` DSL symbols, `@util` helpers, `.vue`
|
|
6
|
+
* components and — when configured — database entities, then writes the resulting
|
|
7
|
+
* `INDEX.md`/`UTILS.md` files (root + per-package). Purely regenerative — the output is meant to be
|
|
8
|
+
* git-ignored and is safe to delete or re-run at any time; see `renderMarkdown` for the exact file
|
|
9
|
+
* set, `collectSymbols` for what gets indexed and `NzymeIndexConfig` for the configuration.
|
|
10
|
+
*/
|
|
11
|
+
export declare class IndexCommand extends Command {
|
|
12
|
+
static paths: string[][];
|
|
13
|
+
static usage: import("clipanion").Usage;
|
|
14
|
+
/**
|
|
15
|
+
* Execute the command.
|
|
16
|
+
*/
|
|
17
|
+
run(): Promise<number>;
|
|
18
|
+
/** Warns once, in a single summary line, about named packages with no `description`. */
|
|
19
|
+
private warnMissingDescriptions;
|
|
20
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { mkdir, rm, writeFile } from 'node:fs/promises';
|
|
2
|
+
import { dirname, join } from 'node:path';
|
|
3
|
+
import { getPackages } from '@nzyme/project-utils/getPackages.js';
|
|
4
|
+
import { getProjectRoot } from '@nzyme/project-utils/getProjectRoot.js';
|
|
5
|
+
import { collectSymbols } from '../codeIndex/collectSymbols.js';
|
|
6
|
+
import { getIndexSettings } from '../codeIndex/IndexSettings.js';
|
|
7
|
+
import { readIndexConfig } from '../codeIndex/NzymeIndexConfig.js';
|
|
8
|
+
import { renderMarkdown } from '../codeIndex/renderMarkdown.js';
|
|
9
|
+
import { Command } from '../Command.js';
|
|
10
|
+
/**
|
|
11
|
+
* Generates the repo's code index, so a coding agent has a fast, always-fresh map of the codebase
|
|
12
|
+
* instead of re-deriving it by grepping every session (and reinventing utilities that already
|
|
13
|
+
* exist). Crawls every workspace package for `defineX` DSL symbols, `@util` helpers, `.vue`
|
|
14
|
+
* components and — when configured — database entities, then writes the resulting
|
|
15
|
+
* `INDEX.md`/`UTILS.md` files (root + per-package). Purely regenerative — the output is meant to be
|
|
16
|
+
* git-ignored and is safe to delete or re-run at any time; see `renderMarkdown` for the exact file
|
|
17
|
+
* set, `collectSymbols` for what gets indexed and `NzymeIndexConfig` for the configuration.
|
|
18
|
+
*/
|
|
19
|
+
export class IndexCommand extends Command {
|
|
20
|
+
static paths = [['index']];
|
|
21
|
+
static usage = Command.Usage({
|
|
22
|
+
category: 'Docs',
|
|
23
|
+
description: 'Generate the code index (INDEX.md / UTILS.md) for agent navigation',
|
|
24
|
+
details: `
|
|
25
|
+
Crawls every workspace package for services, commands, factories, endpoints
|
|
26
|
+
(\`defineService\`/\`defineCommand\`/\`defineFactory\`/\`defineEndpoint\`), \`.vue\`
|
|
27
|
+
components (outside Nuxt apps) and \`@util\`-tagged helpers, then writes a root
|
|
28
|
+
\`INDEX.md\` (package hub) plus one \`INDEX.md\` per package that has at least one
|
|
29
|
+
symbol. Output is generated and should be git-ignored — safe to re-run any time.
|
|
30
|
+
|
|
31
|
+
Configured by the \`nzyme.index\` field of the root package.json, all optional:
|
|
32
|
+
\`globalUtilPackages\` (string[]) — packages whose \`@util\` helpers also go to a root
|
|
33
|
+
\`UTILS.md\` (not written without any); \`defineKinds\` ({ kind, section, callee,
|
|
34
|
+
nameKey?, order? }[]) — further \`defineX\` DSLs to index, e.g. \`{ "kind": "actor",
|
|
35
|
+
"section": "Actors", "callee": "defineActor", "nameKey": "type", "order": 40 }\`;
|
|
36
|
+
\`entities\` ({ tableFunctions: string[], packages?: string[] }) — table definitions to
|
|
37
|
+
index as entities, e.g. \`{ "tableFunctions": ["pgTable"], "packages": ["@acme/database"] }\`.
|
|
38
|
+
`,
|
|
39
|
+
examples: [['Generate the code index', 'nzyme index']],
|
|
40
|
+
});
|
|
41
|
+
/**
|
|
42
|
+
* Execute the command.
|
|
43
|
+
*/
|
|
44
|
+
async run() {
|
|
45
|
+
const root = getProjectRoot();
|
|
46
|
+
const [packages, config] = await Promise.all([getPackages(root), readIndexConfig(root)]);
|
|
47
|
+
const settings = getIndexSettings(config);
|
|
48
|
+
const symbols = await collectSymbols({
|
|
49
|
+
root,
|
|
50
|
+
packages,
|
|
51
|
+
settings,
|
|
52
|
+
onWarn: message => this.logger.warn(message),
|
|
53
|
+
});
|
|
54
|
+
const files = renderMarkdown({ root, packages, symbols, settings });
|
|
55
|
+
for (const [filePath, data] of files) {
|
|
56
|
+
await mkdir(dirname(filePath), { recursive: true });
|
|
57
|
+
await writeFile(filePath, data);
|
|
58
|
+
}
|
|
59
|
+
// Drop index files this run no longer generates (a package lost its last symbol, or
|
|
60
|
+
// `globalUtilPackages` was emptied), so a stale one never misleads an agent.
|
|
61
|
+
const staleFiles = [join(root, 'UTILS.md'), ...packages.map(pkg => join(pkg.path, 'INDEX.md'))].filter(filePath => !files.has(filePath));
|
|
62
|
+
await Promise.all(staleFiles.map(filePath => rm(filePath, { force: true })));
|
|
63
|
+
this.logger.info(`Wrote ${files.size} index files.`);
|
|
64
|
+
this.warnMissingDescriptions(packages);
|
|
65
|
+
return 0;
|
|
66
|
+
}
|
|
67
|
+
/** Warns once, in a single summary line, about named packages with no `description`. */
|
|
68
|
+
warnMissingDescriptions(packages) {
|
|
69
|
+
const names = [];
|
|
70
|
+
for (const pkg of packages) {
|
|
71
|
+
if (pkg.packageJson.name && !pkg.packageJson.description) {
|
|
72
|
+
names.push(pkg.packageJson.name);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
if (names.length === 0) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
this.logger.warn(`${names.length} package(s) have no description (shown as "(no description)"): ${names.join(', ')}`);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=IndexCommand.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IndexCommand.js","sourceRoot":"","sources":["../../src/commands/IndexCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAG1C,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,OAAO;IACrC,MAAM,CAAU,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpC,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAClC,QAAQ,EAAE,MAAM;QAChB,WAAW,EAAE,oEAAoE;QACjF,OAAO,EAAE;;;;;;;;;;;;;;SAcR;QACD,QAAQ,EAAE,CAAC,CAAC,yBAAyB,EAAE,aAAa,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH;;OAEG;IACM,KAAK,CAAC,GAAG;QACd,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;QAC9B,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzF,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC;YACjC,IAAI;YACJ,QAAQ;YACR,QAAQ;YACR,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SAC/C,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEpE,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;YACnC,MAAM,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACpD,MAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,oFAAoF;QACpF,6EAA6E;QAC7E,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAClG,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CACnC,CAAC;QACF,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE7E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,eAAe,CAAC,CAAC;QACrD,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAEvC,OAAO,CAAC,CAAC;IACb,CAAC;IAED,wFAAwF;IAChF,uBAAuB,CAAC,QAA4B;QACxD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YACzB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;gBACvD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,GAAG,KAAK,CAAC,MAAM,kEAAkE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACtG,CAAC;IACN,CAAC;CACJ"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { mkdir, mkdtemp, readFile, realpath, rm, writeFile } from 'node:fs/promises';
|
|
2
|
+
import { tmpdir } from 'node:os';
|
|
3
|
+
import { join } from 'node:path';
|
|
4
|
+
import { afterAll, beforeAll, describe, expect, it } from 'bun:test';
|
|
5
|
+
const CLI_PATH = new URL('../cli.ts', import.meta.url).pathname;
|
|
6
|
+
/**
|
|
7
|
+
* End-to-end test of `nzyme index`: the real CLI run in a throwaway workspace, so workspace
|
|
8
|
+
* discovery, reading the `nzyme.index` config from the root package.json and writing the files are
|
|
9
|
+
* all covered, not just the pure `collectSymbols` → `renderMarkdown` pipeline.
|
|
10
|
+
*/
|
|
11
|
+
const root = await realpath(await mkdtemp(join(tmpdir(), 'nzyme-index-command-')));
|
|
12
|
+
beforeAll(async () => {
|
|
13
|
+
// A lockfile is what makes the workspace discovery recognise a bun workspace.
|
|
14
|
+
await write('bun.lock', '');
|
|
15
|
+
await writeJson('package.json', {
|
|
16
|
+
name: 'fixture-root',
|
|
17
|
+
private: true,
|
|
18
|
+
workspaces: ['packages/*'],
|
|
19
|
+
nzyme: {
|
|
20
|
+
index: {
|
|
21
|
+
globalUtilPackages: ['@fix/utils'],
|
|
22
|
+
defineKinds: [{ kind: 'actor', section: 'Actors', callee: 'defineActor', nameKey: 'type', order: 40 }],
|
|
23
|
+
entities: { tableFunctions: ['pgTable'], packages: ['@fix/alpha'] },
|
|
24
|
+
},
|
|
25
|
+
},
|
|
26
|
+
});
|
|
27
|
+
// alpha: a service, a configured actor, an entity and a package-local @util helper.
|
|
28
|
+
await writeJson('packages/alpha/package.json', { name: '@fix/alpha', description: 'Alpha pkg' });
|
|
29
|
+
await write('packages/alpha/src/AlphaService.ts', `/** Alpha svc. */\nexport const AlphaService = defineService({ name: 'AlphaService' });`);
|
|
30
|
+
await write('packages/alpha/src/AlphaActor.ts', `export const AlphaActor = defineActor({ type: 'alpha' });`);
|
|
31
|
+
await write('packages/alpha/src/schema.ts', `export const order = pgTable('orders', {});`);
|
|
32
|
+
await write('packages/alpha/src/helpers.ts', `/**\n * Adds.\n * @util\n */\nexport function addUp(a: number, b: number): number { return a + b; }`);
|
|
33
|
+
// utils: a foundational package — its @util helpers also go to the root UTILS.md.
|
|
34
|
+
await writeJson('packages/utils/package.json', { name: '@fix/utils', description: 'Utils pkg' });
|
|
35
|
+
await write('packages/utils/src/clamp.ts', `/**\n * Clamps.\n * @util\n */\nexport function clamp(v: number): number { return v; }`);
|
|
36
|
+
// beta: no description, and a malformed defineService "call" — TypeScript's error-tolerant
|
|
37
|
+
// parser recovers no CallExpression from it, so it yields no symbol; the crawl must go on.
|
|
38
|
+
await writeJson('packages/beta/package.json', { name: '@fix/beta' });
|
|
39
|
+
await write('packages/beta/src/Broken.ts', `export const X = defineService not a real call @@@ {{{ garbage`);
|
|
40
|
+
// gamma: a Nuxt app (has nuxt.config.ts) — its .vue files must be excluded as component noise.
|
|
41
|
+
await writeJson('packages/gamma/package.json', { name: '@fix/gamma', description: 'Gamma app' });
|
|
42
|
+
await write('packages/gamma/nuxt.config.ts', '');
|
|
43
|
+
await write('packages/gamma/src/Widget.vue', '<!-- A widget. -->\n<script setup></script>');
|
|
44
|
+
});
|
|
45
|
+
afterAll(async () => {
|
|
46
|
+
await rm(root, { recursive: true, force: true });
|
|
47
|
+
});
|
|
48
|
+
describe('nzyme index', () => {
|
|
49
|
+
it('writes the root INDEX.md/UTILS.md and an INDEX.md for every package with symbols', async () => {
|
|
50
|
+
expect(await runIndex()).toBe(0);
|
|
51
|
+
const rootIndex = await read('INDEX.md');
|
|
52
|
+
expect(rootIndex).toContain('- **@fix/alpha** (`packages/alpha`): Alpha pkg — [INDEX.md](./packages/alpha/INDEX.md)');
|
|
53
|
+
expect(rootIndex).toContain('- **@fix/beta** (`packages/beta`): _(no description)_\n');
|
|
54
|
+
expect(rootIndex).toContain('- **@fix/gamma** (`packages/gamma`): Gamma app\n');
|
|
55
|
+
const utils = await read('UTILS.md');
|
|
56
|
+
expect(utils).toContain('- `clamp(v: number): number` — Clamps. (`@fix/utils/clamp.js`)');
|
|
57
|
+
expect(utils).not.toContain('addUp');
|
|
58
|
+
const alphaIndex = await read('packages/alpha/INDEX.md');
|
|
59
|
+
expect(alphaIndex).toContain([
|
|
60
|
+
'## Services',
|
|
61
|
+
'',
|
|
62
|
+
'- **AlphaService** — `@fix/alpha/AlphaService.js` — name: `AlphaService` — Alpha svc.',
|
|
63
|
+
'',
|
|
64
|
+
'## Actors',
|
|
65
|
+
'',
|
|
66
|
+
'- **AlphaActor** — `@fix/alpha/AlphaActor.js` — type: `alpha`',
|
|
67
|
+
'',
|
|
68
|
+
'## Entities',
|
|
69
|
+
'',
|
|
70
|
+
'- **order** — `@fix/alpha/schema.js` — table: `orders`',
|
|
71
|
+
'',
|
|
72
|
+
'## Utils',
|
|
73
|
+
'',
|
|
74
|
+
'- `addUp(a: number, b: number): number` — Adds. (`@fix/alpha/helpers.js`)',
|
|
75
|
+
'',
|
|
76
|
+
].join('\n'));
|
|
77
|
+
expect(await exists('packages/utils/INDEX.md')).toBe(true);
|
|
78
|
+
expect(await exists('packages/beta/INDEX.md')).toBe(false);
|
|
79
|
+
expect(await exists('packages/gamma/INDEX.md')).toBe(false);
|
|
80
|
+
});
|
|
81
|
+
it('is idempotent: a second run leaves byte-identical files', async () => {
|
|
82
|
+
expect(await runIndex()).toBe(0);
|
|
83
|
+
const first = await Promise.all(['INDEX.md', 'UTILS.md', 'packages/alpha/INDEX.md'].map(read));
|
|
84
|
+
expect(await runIndex()).toBe(0);
|
|
85
|
+
const second = await Promise.all(['INDEX.md', 'UTILS.md', 'packages/alpha/INDEX.md'].map(read));
|
|
86
|
+
expect(second).toEqual(first);
|
|
87
|
+
});
|
|
88
|
+
it('removes the INDEX.md of a package that lost its last symbol', async () => {
|
|
89
|
+
await writeJson('packages/delta/package.json', { name: '@fix/delta', description: 'Delta pkg' });
|
|
90
|
+
await write('packages/delta/src/DeltaService.ts', `export const DeltaService = defineService({ name: 'DeltaService' });`);
|
|
91
|
+
expect(await runIndex()).toBe(0);
|
|
92
|
+
expect(await exists('packages/delta/INDEX.md')).toBe(true);
|
|
93
|
+
await rm(join(root, 'packages/delta/src'), { recursive: true });
|
|
94
|
+
expect(await runIndex()).toBe(0);
|
|
95
|
+
expect(await exists('packages/delta/INDEX.md')).toBe(false);
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
function runIndex() {
|
|
99
|
+
const child = Bun.spawn([process.execPath, '--conditions=source', CLI_PATH, 'index'], {
|
|
100
|
+
cwd: root,
|
|
101
|
+
stdout: 'ignore',
|
|
102
|
+
stderr: 'ignore',
|
|
103
|
+
});
|
|
104
|
+
return child.exited;
|
|
105
|
+
}
|
|
106
|
+
async function write(relPath, content) {
|
|
107
|
+
const full = join(root, relPath);
|
|
108
|
+
await mkdir(join(full, '..'), { recursive: true });
|
|
109
|
+
await writeFile(full, content, 'utf8');
|
|
110
|
+
}
|
|
111
|
+
function writeJson(relPath, value) {
|
|
112
|
+
return write(relPath, JSON.stringify(value, null, 4));
|
|
113
|
+
}
|
|
114
|
+
function read(relPath) {
|
|
115
|
+
return readFile(join(root, relPath), 'utf8');
|
|
116
|
+
}
|
|
117
|
+
async function exists(relPath) {
|
|
118
|
+
try {
|
|
119
|
+
await readFile(join(root, relPath));
|
|
120
|
+
return true;
|
|
121
|
+
}
|
|
122
|
+
catch {
|
|
123
|
+
return false;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
//# sourceMappingURL=IndexCommand.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IndexCommand.test.js","sourceRoot":"","sources":["../../src/commands/IndexCommand.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAErE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;AAEhE;;;;GAIG;AAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;AAEnF,SAAS,CAAC,KAAK,IAAI,EAAE;IACjB,8EAA8E;IAC9E,MAAM,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC5B,MAAM,SAAS,CAAC,cAAc,EAAE;QAC5B,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,CAAC,YAAY,CAAC;QAC1B,KAAK,EAAE;YACH,KAAK,EAAE;gBACH,kBAAkB,EAAE,CAAC,YAAY,CAAC;gBAClC,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;gBACtG,QAAQ,EAAE,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE;aACtE;SACJ;KACJ,CAAC,CAAC;IAEH,oFAAoF;IACpF,MAAM,SAAS,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IACjG,MAAM,KAAK,CACP,oCAAoC,EACpC,yFAAyF,CAC5F,CAAC;IACF,MAAM,KAAK,CAAC,kCAAkC,EAAE,2DAA2D,CAAC,CAAC;IAC7G,MAAM,KAAK,CAAC,8BAA8B,EAAE,6CAA6C,CAAC,CAAC;IAC3F,MAAM,KAAK,CACP,+BAA+B,EAC/B,qGAAqG,CACxG,CAAC;IAEF,kFAAkF;IAClF,MAAM,SAAS,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IACjG,MAAM,KAAK,CACP,6BAA6B,EAC7B,wFAAwF,CAC3F,CAAC;IAEF,2FAA2F;IAC3F,2FAA2F;IAC3F,MAAM,SAAS,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACrE,MAAM,KAAK,CAAC,6BAA6B,EAAE,gEAAgE,CAAC,CAAC;IAE7G,+FAA+F;IAC/F,MAAM,SAAS,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;IACjG,MAAM,KAAK,CAAC,+BAA+B,EAAE,EAAE,CAAC,CAAC;IACjD,MAAM,KAAK,CAAC,+BAA+B,EAAE,6CAA6C,CAAC,CAAC;AAChG,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;IAChB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAC9F,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CACvB,wFAAwF,CAC3F,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,yDAAyD,CAAC,CAAC;QACvF,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,kDAAkD,CAAC,CAAC;QAEhF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,gEAAgE,CAAC,CAAC;QAC1F,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAErC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACzD,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CACxB;YACI,aAAa;YACb,EAAE;YACF,uFAAuF;YACvF,EAAE;YACF,WAAW;YACX,EAAE;YACF,+DAA+D;YAC/D,EAAE;YACF,aAAa;YACb,EAAE;YACF,wDAAwD;YACxD,EAAE;YACF,UAAU;YACV,EAAE;YACF,2EAA2E;YAC3E,EAAE;SACL,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;QAEF,MAAM,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,yBAAyB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAE/F,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,yBAAyB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAEhG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,SAAS,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;QACjG,MAAM,KAAK,CACP,oCAAoC,EACpC,sEAAsE,CACzE,CAAC;QACF,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE3D,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,SAAS,QAAQ;IACb,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,qBAAqB,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE;QAClF,GAAG,EAAE,IAAI;QACT,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;KACnB,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,MAAM,CAAC;AACxB,CAAC;AAED,KAAK,UAAU,KAAK,CAAC,OAAe,EAAE,OAAe;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,SAAS,CAAC,OAAe,EAAE,KAAc;IAC9C,OAAO,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,IAAI,CAAC,OAAe;IACzB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,OAAe;IACjC,IAAI,CAAC;QACD,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Command } from '../Command.js';
|
|
2
|
+
/** CLI command that compiles .loc.yaml translation files into TypeScript modules. */
|
|
3
|
+
export declare class LocaliseCommand extends Command {
|
|
4
|
+
static paths: string[][];
|
|
5
|
+
static usage: import("clipanion").Usage;
|
|
6
|
+
watch: boolean | undefined;
|
|
7
|
+
cwd: string;
|
|
8
|
+
/**
|
|
9
|
+
* Execute the command.
|
|
10
|
+
*/
|
|
11
|
+
run(): Promise<0 | 1>;
|
|
12
|
+
private startWatcher;
|
|
13
|
+
private onAddFile;
|
|
14
|
+
private onDeleteFile;
|
|
15
|
+
private compileFile;
|
|
16
|
+
/**
|
|
17
|
+
* We use a custom walker to find translation files because glob causes OOM.
|
|
18
|
+
*/
|
|
19
|
+
private findTranslationFiles;
|
|
20
|
+
private walkDirectory;
|
|
21
|
+
private toAbsolute;
|
|
22
|
+
private toTypesScriptPath;
|
|
23
|
+
}
|