-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathesbuild-plugin-add-package.ts
More file actions
129 lines (108 loc) · 3.71 KB
/
esbuild-plugin-add-package.ts
File metadata and controls
129 lines (108 loc) · 3.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
import { existsSync } from 'node:fs';
import { mkdir, readFile, writeFile } from 'node:fs/promises';
import { basename, dirname, join, relative, resolve } from 'node:path';
import { cwd } from 'node:process';
import type { Plugin } from 'esbuild';
import type { package as Package } from './package.d.js';
interface ReadmeTemplateContext {
name: string;
basePath: string;
path: string;
rootPackage: Package;
}
interface PluginOptions {
filter: RegExp;
packageName: string;
addReadme: boolean;
readmeName: string;
readmeTemplate: (context: ReadmeTemplateContext) => string | Promise<string>;
sourceRoot: string;
outdir: string;
}
async function generatePackage(
path: string,
packageName: string,
rootPackage: Package,
src: string,
dist: string,
): Promise<void> {
// resolve paths for package.json
const baseFile = basename(path, '.ts');
const basePath = dirname(relative(src, path));
const baseName = basename(basePath);
const packageDir = join(dist, basePath);
const packagePath = join(packageDir, packageName);
const [scope] = rootPackage.name.split('/');
const name = scope !== undefined ? `${scope}/${baseName}` : baseName;
// create package.json
const packageContent = {
name,
main: `${baseFile}.js`,
module: `${baseFile}.js`,
types: `${baseFile}.d.ts`,
files: [`${baseFile}.*`],
repository: rootPackage.repository,
version: rootPackage.version,
author: rootPackage.author,
license: rootPackage.license,
publishConfig: rootPackage.publishConfig,
type: rootPackage.type,
peerDependencies: rootPackage.peerDependencies,
engines: rootPackage.engines,
};
// write package.json
if (!existsSync(packageDir)) await mkdir(packageDir, { recursive: true });
await writeFile(packagePath, JSON.stringify(packageContent, null, 2), 'utf-8');
}
async function generateReadme(
path: string,
readmeName: PluginOptions['readmeName'],
readmeTemplate: PluginOptions['readmeTemplate'],
rootPackage: Package,
src: string,
dist: string,
): Promise<void> {
// resolve paths for readme
const basePath = dirname(relative(src, path));
const baseName = basename(basePath);
const readmeDir = join(dist, basePath);
const readmePath = join(readmeDir, readmeName);
const [scope] = rootPackage.name.split('/');
const name = scope !== undefined ? `${scope}/${baseName}` : baseName;
// write readme
if (!existsSync(readmeDir)) await mkdir(readmeDir, { recursive: true });
await writeFile(readmePath, await readmeTemplate({ name, basePath, path, rootPackage }), 'utf-8');
}
export function addPackageJson(options?: Partial<PluginOptions>): Plugin {
return {
name: 'add package.json',
async setup(build) {
// receive options, fill in defaults from esbuild, set fallbacks
const {
filter = /\.ts$/,
packageName = 'package.json',
addReadme = false,
readmeName = 'README.md',
readmeTemplate = ({ name }) => `# ${name}`,
outdir = build.initialOptions.outdir ?? 'dist',
sourceRoot = build.initialOptions.sourceRoot ?? 'src',
} = options || {};
// derive paths
const src = resolve(sourceRoot);
const dist = resolve(outdir);
// load root package
const rootPackage = JSON.parse(await readFile(resolve(cwd(), 'package.json'), 'utf-8'));
// intercept plugins that are resolved
build.onLoad({ filter }, async ({ path }) => {
// add package.json
await generatePackage(path, packageName, rootPackage, src, dist);
// add readme
if (addReadme) {
await generateReadme(path, readmeName, readmeTemplate, rootPackage, src, dist);
}
// go on as usual
return undefined;
});
},
};
}