forked from FlamingTempura/bibtex-tidy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.ts
253 lines (226 loc) · 6.16 KB
/
build.ts
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
import { version, author, homepage } from './package.json';
import { writeFile, mkdir, chmod, readFile } from 'fs/promises';
import { join } from 'path';
import { build, buildSync } from 'esbuild';
import { transform as babel } from '@babel/core';
import { optionDefinitions } from './src/optionDefinitions';
import { wrapText } from './src/utils';
const SRC_PATH = join(__dirname, 'src');
const BUILD_PATH = join(SRC_PATH, '__generated__');
const WEB_PATH = join(__dirname, 'docs');
const CLI_BIN = join(__dirname, 'bin', 'bibtex-tidy');
// For BigInt support:
// * No IE version supports BigInt
// * Edge 79+
// * Firefox 68+
// * Safari 14+
// * Chrome 67+
// All tested on browserstack. Bibtext tidy looks and works correctly.
const BROWSER_TARGETS = {
edge: '79',
firefox: '68',
chrome: '67',
safari: '14',
};
const NODE_TARGET: string[] = ['node12'];
const banner: string[] = [
`bibtex-tidy v${version}`,
'https://github.com/FlamingTempura/bibtex-tidy',
'',
'DO NOT EDIT THIS FILE. This file is automatically generated',
"using `npm run build`. Edit files in './src' then rebuild.",
];
const jsBanner: string[] = [
'/**',
...banner.map((line) => ` * ${line}`.trimEnd()),
' **/',
'',
];
const manpageBanner: string[] = banner.map((line) => `.\\ ${line}`.trimEnd());
async function generateOptionTypes() {
const { outputFiles } = await build({
entryPoints: [join(SRC_PATH, 'optionDefinitions.ts')],
write: false,
format: 'esm',
});
const bundle = new TextDecoder().decode(outputFiles[0].contents);
// Bundle creates an export which eval doesn't know what to do with. Assign to
// var instead.
const options = eval(bundle.replace(/^export/m, 'const res = ') + '; res');
const ts: string[] = [];
ts.push(...jsBanner);
ts.push('export type BibTeXTidyOptions = {');
for (const opt of options.optionDefinitions) {
ts.push('\t/**');
ts.push(`\t * ${opt.title}`);
if (opt.description) {
ts.push('\t *');
for (const line of opt.description) {
ts.push(`\t * ${line}`);
}
}
ts.push('\t */');
ts.push(`\t${opt.key}?: ${opt.type};`);
}
ts.push('};');
ts.push('');
await writeFile(join(BUILD_PATH, 'optionsType.ts'), ts.join('\n'));
}
async function generateVersionFile() {
await writeFile(
join(BUILD_PATH, 'version.ts'),
`export const version = "${version}";`
);
}
const NAME = `BibTeX Tidy v${version}`;
const DESCRIPTION = 'Cleaner and formatter for BibTeX files.';
const SYNOPSIS = 'bibtex-tidy [OPTION]... FILE.BIB';
async function generateCLIHelp() {
const help: string[] = [
`Usage: ${SYNOPSIS}`,
`${NAME} - ${DESCRIPTION}`,
'',
'Options:',
...formatOptions(2, 84),
`Full documentation <${homepage}>`,
];
await writeFile(
join(BUILD_PATH, 'manPage.ts'),
jsBanner.join('\n') +
`export const manPage = ${JSON.stringify(help, null, '\t')};`
);
}
async function generateManPage() {
await writeFile(
'bibtex-tidy.0',
[
'NAME',
` ${NAME}`,
'',
'SYNOPSIS',
` ${SYNOPSIS}`,
'',
'DESCRIPTION',
` ${DESCRIPTION}`,
'',
'OPTIONS',
...formatOptions(4, 65),
'BUGS',
` ${homepage}`,
'',
'AUTHOR',
` ${author}`,
].join('\n')
);
}
async function generateReadme() {
const readme = await readFile(join(__dirname, 'README.md'), 'utf8');
await writeFile(
join(__dirname, 'README.md'),
readme.replace(
/```manpage.*?```/s,
'```manpage\n' + formatOptions(2, 84).join('\n') + '\n```'
)
);
}
function formatOptions(indent: number, lineWidth: number): string[] {
return optionDefinitions.flatMap((opt) => {
if (opt.deprecated) return [];
const description: string[] = [];
if (opt.description) {
description.push(...opt.description.flatMap((line) => [line, '\n']));
}
if (opt.examples && opt.examples.length > 0) {
description.push(
'Examples:',
opt.examples.filter((example) => example).join(', '),
''
);
}
return [
Object.keys(opt.cli).join(', '),
...description.flatMap((line) =>
wrapText(line, lineWidth - indent - 4).map((line) => ` ${line}`)
),
].map((line) => `${' '.repeat(indent)}${line}`);
});
}
async function buildJSBundle() {
console.time('JS bundle built');
const { outputFiles } = buildSync({
entryPoints: ['./src/index.ts'],
bundle: true,
write: false,
format: 'esm',
banner: { js: jsBanner.join('\n') },
});
const bundle = outputFiles[0];
const result = babel(bundle.text, {
presets: [['@babel/env', { targets: BROWSER_TARGETS }]],
compact: false,
});
if (!result?.code) throw new Error('Expected babel output');
await writeFile(
'bibtex-tidy.js',
result.code + `\nmodule.exports = exports.default;`
);
console.timeEnd('JS bundle built');
}
import { generateDtsBundle } from 'dts-bundle-generator';
async function buildTypeDeclarations() {
console.time('Type declarations');
const typeFiles = generateDtsBundle([
{ filePath: './src/index.ts', output: { noBanner: true } },
]);
await writeFile('bibtex-tidy.d.ts', typeFiles[0]);
console.timeEnd('Type declarations');
}
async function buildCLI() {
console.time('CLI built');
await build({
bundle: true,
platform: 'node',
banner: { js: '#!/usr/bin/env node\n' + jsBanner.join('\n') },
outfile: CLI_BIN,
target: NODE_TARGET,
entryPoints: [join(SRC_PATH, 'cli.ts')],
});
await chmod(CLI_BIN, 0o755); // rwxr-xr-x
console.timeEnd('CLI built');
}
async function buildWebBundle() {
console.time('Web bundle built');
const { outputFiles } = await build({
platform: 'browser',
entryPoints: ['./docs/index.ts'],
bundle: true,
write: false,
banner: { js: jsBanner.join('\n') },
});
const bundle = outputFiles[0];
const result = babel(bundle.text, {
presets: [['@babel/env', { targets: BROWSER_TARGETS }]],
compact: false,
});
if (!result?.code) throw new Error('Expected babel output');
await writeFile(join(WEB_PATH, 'bundle.js'), result.code);
console.timeEnd('Web bundle built');
}
mkdir(BUILD_PATH, { recursive: true })
.then(() =>
Promise.all([
generateOptionTypes(),
generateVersionFile(),
generateManPage(),
generateCLIHelp(),
generateReadme(),
])
)
.then(() =>
Promise.all([
!process.argv.includes('--no-defs') ? buildTypeDeclarations() : undefined,
buildJSBundle(),
buildCLI(),
buildWebBundle(),
])
);