Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add cli #7

Merged
merged 4 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,42 @@ import { getDebugIdForUrl } from "debug-id/node";
const debugId = await getDebugIdForUrl("./path/to/main.js");
```

### CLI

The CLI can be used to add Debug IDs to source files and corresponding source-maps.

```
> debugids ./dist

Adding debug IDs: 22.86ms
21 source files modified
┌─────────┬────────────────────────┬────────────────────────────┬────────────────────────────────────────┐
│ (index) │ source │ map │ debugId │
├─────────┼────────────────────────┼────────────────────────────┼────────────────────────────────────────┤
│ 0 │ 'dist/cjs/browser.js' │ 'dist/cjs/browser.js.map' │ '5d789753-09fa-477c-80f6-6cfe447c9d9c' │
│ 1 │ 'dist/cjs/cli.js' │ 'dist/cjs/cli.js.map' │ '9e422107-9efe-43e9-b689-2a4ab4b433fd' │
│ 2 │ 'dist/cjs/common.js' │ 'dist/cjs/common.js.map' │ 'edbf08d3-65e4-4ba4-bc1e-89dad07dee83' │
│ 3 │ 'dist/cjs/esbuild.js' │ 'dist/cjs/esbuild.js.map' │ 'ba079d7a-bf61-4d37-b0b8-d9a4b6a78b25' │
│ 4 │ 'dist/cjs/node.js' │ 'dist/cjs/node.js.map' │ '8afaca7e-2109-4c76-9f06-aa4aaf838038' │
│ 5 │ 'dist/cjs/parcel.js' │ 'dist/cjs/parcel.js.map' │ 'fcf05632-597b-4c44-8399-2de02a2dc8cc' │
│ 6 │ 'dist/cjs/rolldown.js' │ 'dist/cjs/rolldown.js.map' │ '8186821c-f0ae-4fc2-8f58-d293f543b912' │
│ 7 │ 'dist/cjs/rollup.js' │ 'dist/cjs/rollup.js.map' │ 'b10c5745-792b-4791-9053-f29f891bcd2a' │
│ 8 │ 'dist/cjs/rspack.js' │ 'dist/cjs/rspack.js.map' │ 'c86a146b-13c9-42f9-8ce7-022b6a14041e' │
│ 9 │ 'dist/cjs/vite.js' │ 'dist/cjs/vite.js.map' │ '01a2e113-63e4-4cfe-8e28-ab7b1c9ad4da' │
│ 10 │ 'dist/cjs/webpack.js' │ 'dist/cjs/webpack.js.map' │ '76e02ae5-b2f5-4b86-a8aa-b10c8fe22cae' │
│ 11 │ 'dist/esm/browser.js' │ 'dist/esm/browser.js.map' │ '1132afdb-5d3e-4306-a152-d944227e6c0b' │
│ 12 │ 'dist/esm/common.js' │ 'dist/esm/common.js.map' │ '33975f78-e815-499d-b1c7-30d30a5dadff' │
│ 13 │ 'dist/esm/esbuild.js' │ 'dist/esm/esbuild.js.map' │ '1ee53fe8-75d8-4d2d-a42c-cdd797b9938c' │
│ 14 │ 'dist/esm/node.js' │ 'dist/esm/node.js.map' │ '36afeb8e-347d-47d4-9090-86c49677f099' │
│ 15 │ 'dist/esm/parcel.js' │ 'dist/esm/parcel.js.map' │ '34de941f-bbe1-462b-a12a-d127492ff33b' │
│ 16 │ 'dist/esm/rolldown.js' │ 'dist/esm/rolldown.js.map' │ 'f907c9c7-e5f6-4e9c-ae16-e1910b5f5f22' │
│ 17 │ 'dist/esm/rollup.js' │ 'dist/esm/rollup.js.map' │ '2e809256-e2d2-4ab7-a9d1-f8a0ef960196' │
│ 18 │ 'dist/esm/rspack.js' │ 'dist/esm/rspack.js.map' │ '390da573-a94d-46fc-a005-90680847e7c4' │
│ 19 │ 'dist/esm/vite.js' │ 'dist/esm/vite.js.map' │ 'b1c9503c-b550-4528-9927-4a51e4968bea' │
│ 20 │ 'dist/esm/webpack.js' │ 'dist/esm/webpack.js.map' │ '760e8f6b-b7d6-4775-819c-91804cb035cb' │
└─────────┴────────────────────────┴────────────────────────────┴────────────────────────────────────────┘
```

## Bundler Plugins

Bundler plugins to inject Debug IDs into both source and source-maps.
Expand Down
3 changes: 3 additions & 0 deletions cli.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env node

require('./dist/cjs/cli.js');
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,12 @@
"import": "./dist/esm/browser.js"
}
},
"bin": {
"debugids": "cli.js"
},
"scripts": {
"build": "rollup --config rollup.config.mjs",
"postbuild": "node cli.js ./dist",
"test": "vitest run ./test/**/*.test.ts",
"lint": "prettier --check \"{src,test}/**/*.{ts,js}\"",
"fix": "prettier --write \"{src,test}/**/*.{ts,js}\""
Expand Down
2 changes: 1 addition & 1 deletion rollup.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const nodeInputs = [
];

export default [
transpile('cjs', nodeInputs, 'dist/cjs'),
transpile('cjs', [...nodeInputs, 'src/cli.ts'], 'dist/cjs'),
transpile('esm', nodeInputs, 'dist/esm'),
transpile('cjs', ['src/browser.ts'], 'dist/cjs', false),
transpile('esm', ['src/browser.ts'], 'dist/esm', false),
Expand Down
72 changes: 72 additions & 0 deletions src/cli.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import { opendir, readFile, writeFile } from 'fs/promises';
import { join } from 'path';
import { addDebugIdToSource, stringToUUID, DEFAULT_EXTENSIONS, addDebugIdToSourcemap } from './common';

async function walk(path: string, extensions = DEFAULT_EXTENSIONS): Promise<string[]> {
const extensionsAndMaps = [...extensions, ...extensions.map((e) => `${e}.map`)];
let files = [];

for await (const file of await opendir(path)) {
if (file.isDirectory()) {
files.push(...(await walk(join(path, file.name))));
} else {
if (extensionsAndMaps.some((ext) => file.name.endsWith(ext))) {
files.push(join(path, file.name));
}
}
}

return files;
}

async function groupSourceAndMapFiles(files: string[]): Promise<Array<[string, string | undefined]>> {
const sourceFiles = files.filter((f) => !f.endsWith('.map'));
const mapFiles = files.filter((f) => f.endsWith('.map'));

return sourceFiles.map((sourceFile) => {
const mapFile = mapFiles.find((f) => f === `${sourceFile}.map`);
return [sourceFile, mapFile];
});
}

(async () => {
console.time('Adding debug IDs');
if (!process.argv[2]) {
console.error('Usage: debugids <dir>');
process.exit(1);
}

const results = await walk(process.argv[2]);
const groupedResults = await groupSourceAndMapFiles(results);
let modifiedFiles: Array<{ source: string; map: string; debugId: string }> = [];
let missingMaps = new Set<string>();
let addedDebugIds = 0;

const promises = groupedResults.map(async ([source, map]) => {
if (!map) {
missingMaps.add(source);
return;
}

const [sourceContent, mapContent] = await Promise.all([readFile(source, 'utf-8'), readFile(map, 'utf-8')]);

const debugId = stringToUUID(sourceContent);
const newSourceContent = addDebugIdToSource(sourceContent, debugId);
const newMapContent = addDebugIdToSourcemap(mapContent, debugId);

modifiedFiles.push({ source, map, debugId });

await Promise.all([writeFile(source, newSourceContent), writeFile(map, newMapContent)]);
addedDebugIds++;
});

await Promise.all(promises);

console.timeEnd('Adding debug IDs');
console.log(`${addedDebugIds} source files modified`);
console.table(modifiedFiles.sort((a, b) => a.source.localeCompare(b.source)));

if (missingMaps.size > 0) {
console.log(`The following files were missing sourcemaps: ${[...missingMaps].join(', ')}`);
}
})();