@checkdigit/typescript-config 3.3.0-PR.30-c147 → 3.3.0-PR.30-223a
Sign up to get free protection for your applications and to get access to all the features.
- package/bin/builder.mjs +5 -4
- package/package.json +1 -1
- package/src/builder/builder.mts +8 -4
- package/src/builder/builder.spec.mts +41 -2
- package/src/builder/index.mts +2 -1
package/bin/builder.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
// src/builder/index.mts
|
|
3
3
|
import { strict as assert2 } from "node:assert";
|
|
4
|
+
import path2 from "node:path";
|
|
4
5
|
import { parseArgs } from "node:util";
|
|
5
6
|
|
|
6
7
|
// src/builder/builder.mts
|
|
@@ -35,14 +36,14 @@ function setup(pluginBuild) {
|
|
|
35
36
|
return { path: newPath, external: true };
|
|
36
37
|
});
|
|
37
38
|
}
|
|
38
|
-
async function builder_default(inDir2, outDir2) {
|
|
39
|
-
const sourceDirectory =
|
|
39
|
+
async function builder_default({ inDir: inDir2, outDir: outDir2 }) {
|
|
40
|
+
const sourceDirectory = inDir2;
|
|
40
41
|
const allSourceFiles = await getFiles(sourceDirectory);
|
|
41
42
|
const productionSourceFiles = allSourceFiles.filter(
|
|
42
43
|
// && !file.endsWith('.test.ts') && !file.endsWith('.spec.ts')
|
|
43
44
|
(file) => file.endsWith(".ts")
|
|
44
45
|
);
|
|
45
|
-
const configFile = typescript.readConfigFile("./tsconfig.json", typescript.sys.readFile);
|
|
46
|
+
const configFile = typescript.readConfigFile("./tsconfig.json", (name) => typescript.sys.readFile(name));
|
|
46
47
|
const compilerOptions = typescript.parseJsonConfigFileContent(configFile.config, typescript.sys, "./");
|
|
47
48
|
const program = typescript.createProgram(productionSourceFiles, {
|
|
48
49
|
...compilerOptions.options,
|
|
@@ -95,4 +96,4 @@ var {
|
|
|
95
96
|
});
|
|
96
97
|
assert2.ok(inDir !== void 0, "inDir is required");
|
|
97
98
|
assert2.ok(outDir !== void 0, "outDir is required");
|
|
98
|
-
await builder_default(inDir, outDir);
|
|
99
|
+
await builder_default({ inDir: path2.join(process.cwd(), inDir), outDir: path2.join(process.cwd(), outDir) });
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/typescript-config","version":"3.3.0-PR.30-
|
|
1
|
+
{"name":"@checkdigit/typescript-config","version":"3.3.0-PR.30-223a","description":"Check Digit standard Typescript configuration","prettier":"@checkdigit/prettier-config","engines":{"node":">=16"},"bin":{"builder":"./bin/builder.mjs"},"peerDependencies":{"@types/node":">=16","esbuild":"0.17.18","typescript":">=5.0.4 <5.1"},"repository":{"type":"git","url":"git+https://github.com/checkdigit/typescript-config.git"},"author":"Check Digit, LLC","license":"MIT","bugs":{"url":"https://github.com/checkdigit/typescript-config/issues"},"homepage":"https://github.com/checkdigit/typescript-config#readme","scripts":{"preversion":"npm test","postversion":"git push && git push --tags","prepare":"npm run build-builder","lint:fix":"eslint -f unix --ext .ts,.mts src --fix","lint":"eslint -f unix --ext .ts,.mts src","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style","build-builder":"esbuild src/builder/index.mts --bundle --platform=node --format=esm --external:typescript --external:esbuild --outfile=build-builder/builder.mjs && mkdir -p bin && { echo '#!/usr/bin/env node'; cat build-builder/builder.mjs; } > bin/builder.mjs && chmod +x bin/builder.mjs","build-tsc-cjs":"rimraf build-tsc-cjs && tsc --outDir build-tsc-cjs","build-esbuild-cjs":"rimraf build-esbuild-cjs && esbuild ./src/*.ts ./src/*/*.ts --platform=node --bundle --format=cjs --sourcemap=inline --sources-content=false --outdir=build-esbuild-cjs","build-esbuild-cjs-bundle":"rimraf build-esbuild-cjs-bundle && esbuild src/test/index.test.ts --bundle --platform=node --format=cjs --sourcemap=inline --sources-content=false --outfile=build-esbuild-cjs-bundle/test/index.test.cjs","build-esbuild-esm":"rimraf build-esbuild-esm && node bin/builder.mjs --outDir=build-esbuild-esm","build-esbuild-esm-bundle":"rimraf build-esbuild-esm-bundle && esbuild src/test/index.test.ts --bundle --platform=node --format=esm --sourcemap=inline --sources-content=false --outfile=build-esbuild-esm-bundle/test/index.test.mjs","test-jest-esm":"NODE_OPTIONS=\"--experimental-vm-modules\" jest --coverage=false src/*.mts src/*/*.mts src/*/*/*.mts","test-jest-cjs":"jest --coverage=false src/*.ts src/*/*.ts src/*/*/*.ts","test-tsc-cjs":"node --test build-tsc-cjs/test/index.test.js","test-esbuild-cjs":"node --test build-esbuild-cjs/test/index.test.js","test-esbuild-cjs-bundle":"node --test build-esbuild-cjs-bundle/test/index.test.cjs","test-esbuild-esm":"node --test build-esbuild-esm/test/index.test.mjs","test-esbuild-esm-bundle":"echo 'node -test build-esbuild-esm-bundle/test/index.test.mjs'","ci:test":"npm run test-jest-cjs && npm run test-jest-esm &&npm run test-tsc-cjs && npm run test-esbuild-cjs && npm run test-esbuild-cjs-bundle && npm run test-esbuild-esm && npm run test-esbuild-esm-bundle","ci:compile":"npm run build-builder && npm run build-tsc-cjs && npm run build-esbuild-cjs && npm run build-esbuild-cjs-bundle && npm run build-esbuild-esm && npm run build-esbuild-esm-bundle","ci:lint":"npm run lint","ci:style":"npm run prettier"},"devDependencies":{"@checkdigit/prettier-config":"^3.4.0","@types/debug":"^4.1.7","@types/jest":"^29.5.1","@types/uuid":"^9.0.1","@typescript-eslint/eslint-plugin":"^5.59.5","@typescript-eslint/parser":"^5.59.5","debug":"^4.3.4","eslint":"^8.40.0","eslint-config-prettier":"^8.8.0","get-port":"^6.1.2","got":"^11.8.6","jest":"^29.5.0","rimraf":"^5.0.0","ts-jest":"^29.1.0","uuid":"^9.0.0"},"eslintConfig":{"parser":"@typescript-eslint/parser","plugins":["@typescript-eslint"],"parserOptions":{"project":"./tsconfig.json"},"extends":["eslint:all","plugin:@typescript-eslint/recommended","plugin:@typescript-eslint/recommended-requiring-type-checking","plugin:@typescript-eslint/strict","prettier"],"rules":{"@typescript-eslint/non-nullable-type-assertion-style":"error","capitalized-comments":"off","one-var":"off","sort-keys":"off","sort-imports":"off","func-style":["error","declaration",{"allowArrowFunctions":true}],"no-magic-numbers":["error",{"ignore":[1]}],"no-undefined":"off","no-ternary":"off"},"overrides":[{"files":["*.spec.mts","*.test.mts","*.spec.ts","*.test.ts"],"rules":{"@typescript-eslint/non-nullable-type-assertion-style":"off","@typescript-eslint/ban-types":"off","@typescript-eslint/require-await":"off","@typescript-eslint/consistent-type-definitions":"off","@typescript-eslint/ban-ts-comment":"off","@typescript-eslint/no-unnecessary-condition":"off","@typescript-eslint/consistent-indexed-object-style":"off","@typescript-eslint/no-unused-vars":"off","@typescript-eslint/no-unsafe-member-access":"off","line-comment-position":"off","no-inline-comments":"off","no-param-reassign":"off","id-length":"off","no-magic-numbers":"off","func-names":"off","no-duplicate-imports":"off","symbol-description":"off","no-invalid-this":"off"}}]},"jest":{"moduleFileExtensions":["js","mjs","cjs","ts","mts","json","node"],"extensionsToTreatAsEsm":[".mts"],"transform":{"^.+\\.mts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":true}],"^.+\\.ts$":["ts-jest",{"isolatedModules":true,"diagnostics":false,"useESM":false}]},"collectCoverageFrom":["<rootDir>/src/**","!<rootDir>/src/**/*.spec.mts","!<rootDir>/src/**/*.test.mts","!<rootDir>/src/**/*.spec.ts","!<rootDir>/src/**/*.test.ts"],"testMatch":["<rootDir>/src/**/*.spec.ts","<rootDir>/src/**/*.spec.mts"]},"files":["tsconfig.json","SECURITY.md","/src/"]}
|
package/src/builder/builder.mts
CHANGED
|
@@ -7,6 +7,11 @@ import typescript from 'typescript';
|
|
|
7
7
|
|
|
8
8
|
import { PluginBuild, build } from 'esbuild';
|
|
9
9
|
|
|
10
|
+
export interface BuilderOptions {
|
|
11
|
+
inDir: string;
|
|
12
|
+
outDir: string;
|
|
13
|
+
}
|
|
14
|
+
|
|
10
15
|
/**
|
|
11
16
|
* Recursively obtains all files in a directory
|
|
12
17
|
* @param {string} directory
|
|
@@ -42,19 +47,18 @@ function setup(pluginBuild: PluginBuild) {
|
|
|
42
47
|
}
|
|
43
48
|
|
|
44
49
|
// eslint-disable-next-line func-names,max-lines-per-function,max-statements
|
|
45
|
-
export default async function (inDir
|
|
50
|
+
export default async function ({ inDir, outDir }: BuilderOptions): Promise<void> {
|
|
46
51
|
/**
|
|
47
52
|
* Emit declarations using typescript compiler
|
|
48
53
|
*/
|
|
49
|
-
const sourceDirectory =
|
|
54
|
+
const sourceDirectory = inDir;
|
|
50
55
|
const allSourceFiles = await getFiles(sourceDirectory);
|
|
51
56
|
const productionSourceFiles = allSourceFiles.filter(
|
|
52
57
|
// && !file.endsWith('.test.ts') && !file.endsWith('.spec.ts')
|
|
53
58
|
(file) => file.endsWith('.ts')
|
|
54
59
|
);
|
|
55
60
|
|
|
56
|
-
|
|
57
|
-
const configFile = typescript.readConfigFile('./tsconfig.json', typescript.sys.readFile);
|
|
61
|
+
const configFile = typescript.readConfigFile('./tsconfig.json', (name) => typescript.sys.readFile(name));
|
|
58
62
|
const compilerOptions = typescript.parseJsonConfigFileContent(configFile.config, typescript.sys, './');
|
|
59
63
|
|
|
60
64
|
const program = typescript.createProgram(productionSourceFiles, {
|
|
@@ -1,12 +1,51 @@
|
|
|
1
1
|
// builder/builder.spec.mts
|
|
2
2
|
|
|
3
3
|
import { strict as assert } from 'node:assert';
|
|
4
|
+
import { promises as fs } from 'node:fs';
|
|
5
|
+
import os from 'node:os';
|
|
6
|
+
import path from 'node:path';
|
|
7
|
+
|
|
8
|
+
import { v4 as uuid } from 'uuid';
|
|
4
9
|
|
|
5
10
|
// @ts-expect-error
|
|
6
11
|
import builder from './builder.mts';
|
|
7
12
|
|
|
13
|
+
const singleModule = {
|
|
14
|
+
[`index.ts`]: `export const hello = 'world';`,
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
async function write(dir: string, files: Record<string, string>): Promise<void> {
|
|
18
|
+
await fs.mkdir(dir, { recursive: true });
|
|
19
|
+
await Promise.all(Object.entries(files).map(([name, content]) => fs.writeFile(path.join(dir, name), content)));
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
async function read(dir: string): Promise<Record<string, string>> {
|
|
23
|
+
const files = await fs.readdir(dir);
|
|
24
|
+
return Object.fromEntries(
|
|
25
|
+
await Promise.all(
|
|
26
|
+
files.map(async (name) => [
|
|
27
|
+
name,
|
|
28
|
+
(
|
|
29
|
+
await fs.readFile(path.join(dir, name), 'utf-8')
|
|
30
|
+
)
|
|
31
|
+
.split('\n')
|
|
32
|
+
.filter((line) => !line.startsWith('//'))
|
|
33
|
+
.join('\n'),
|
|
34
|
+
])
|
|
35
|
+
)
|
|
36
|
+
) as Record<string, string>;
|
|
37
|
+
}
|
|
38
|
+
|
|
8
39
|
describe('test builder', () => {
|
|
9
|
-
it('should build', async () => {
|
|
10
|
-
|
|
40
|
+
it('should build a single ESM module', async () => {
|
|
41
|
+
const id = uuid();
|
|
42
|
+
const inDir = path.join(os.tmpdir(), `in-dir-${id}`);
|
|
43
|
+
const outDir = path.join(os.tmpdir(), `out-dir-${id}`);
|
|
44
|
+
await write(inDir, singleModule);
|
|
45
|
+
await builder({ inDir, outDir });
|
|
46
|
+
assert.deepEqual(await read(outDir), {
|
|
47
|
+
'index.d.ts': 'export declare const hello = "world";\n',
|
|
48
|
+
'index.mjs': 'var hello = "world";\nexport {\n hello\n};\n',
|
|
49
|
+
});
|
|
11
50
|
});
|
|
12
51
|
});
|
package/src/builder/index.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// builder/index.mts
|
|
2
2
|
|
|
3
3
|
import { strict as assert } from 'node:assert';
|
|
4
|
+
import path from 'node:path';
|
|
4
5
|
import { parseArgs } from 'node:util';
|
|
5
6
|
|
|
6
7
|
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
@@ -19,4 +20,4 @@ const {
|
|
|
19
20
|
assert.ok(inDir !== undefined, 'inDir is required');
|
|
20
21
|
assert.ok(outDir !== undefined, 'outDir is required');
|
|
21
22
|
|
|
22
|
-
await builder(inDir, outDir);
|
|
23
|
+
await builder({ inDir: path.join(process.cwd(), inDir), outDir: path.join(process.cwd(), outDir) });
|