-
Notifications
You must be signed in to change notification settings - Fork 1
/
commonify.mjs
198 lines (156 loc) · 7.21 KB
/
commonify.mjs
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
#!/usr/bin/env node
import { execa } from 'execa';
import { mkdirp, pathExists } from 'fs-extra';
import { readFile, writeFile } from 'fs/promises';
import { join, resolve } from 'path';
import assert from 'assert';
import semver from 'semver';
import pMap from 'p-map';
async function getNpmPackageJson(query) {
try {
const { stdout } = await execa('npm', ['view', query, '--json']);
if (!stdout) return undefined;
const packageJson = JSON.parse(stdout);
if (Array.isArray(packageJson)) return packageJson[packageJson.length - 1]; // latest matching version
return packageJson;
} catch (err) {
// wow what an ugly hack
// https://github.com/npm/cli/issues/2740
if (err.stdout.includes('"code": "E404",')) {
return undefined;
}
}
}
export async function commonify({ packageName, version: versionIn, scopeName, depth = 0, maxDepth = 3, publishNewIfExists = true, ignoreDeps = [], publishCommands = [] }) {
if (depth > maxDepth) throw new Error('max recursion depth reached');
assert(!scopeName.includes('@'), 'Do not include @ in the scope name');
console.log('commonify', packageName, versionIn, scopeName);
let version = versionIn;
if (!semver.valid(version)) {
console.log('Resolving version', packageName, version);
const resolvedPackage = await getNpmPackageJson(`${packageName}@${version.replace(/\s/g, '')}`);
assert(resolvedPackage, `Failed to resolve ${packageName} ${version}`);
version = resolvedPackage.version;
}
const getNewPackageName = (p) => `@${scopeName}/${p}`;
const newPackageName = getNewPackageName(packageName);
let newPackageVersion;
// already have a version published?
const existingCommonifiedPackage = await getNpmPackageJson(`${newPackageName}@^${version}`);
if (existingCommonifiedPackage) {
if (!publishNewIfExists) {
return {
newPackageName,
newPackageVersion: existingCommonifiedPackage.version,
};
}
const incrementedVersion = semver.inc(existingCommonifiedPackage.version, 'patch');
console.log('Upgrading existing version', existingCommonifiedPackage.version, '->', incrementedVersion);
assert(incrementedVersion !== null);
newPackageVersion = incrementedVersion;
} else {
const pkg = await getNpmPackageJson(`${packageName}@${version}`);
assert(pkg, `Cannot find package ${packageName} in npm`);
if (pkg.type !== 'module' || pkg.main) {
console.log(packageName, 'is not a module, skippiung');
return undefined;
}
console.log('Creating initial (or new major) version based on source package', pkg.version);
newPackageVersion = pkg.version;
}
let mappedDependencies = [];
async function mapPackage(sourcePackage, sourceVersion) {
const npmViewQuery = `${getNewPackageName(sourcePackage)}@${sourceVersion.replace(/\s/g, '')}`; // todo may need to add ^ or ~
const actualDepPackage = await getNpmPackageJson(npmViewQuery);
let commonifiedDependencyName;
let commonifiedDependencyVersion;
if (ignoreDeps.includes(sourcePackage)) {
console.log('dep ignore', sourcePackage, sourceVersion);
return {
pkg: sourcePackage,
version: sourceVersion,
};
}
if (actualDepPackage) {
commonifiedDependencyName = getNewPackageName(sourcePackage);
commonifiedDependencyVersion = actualDepPackage.version;
assert(semver.valid(actualDepPackage.version), `Invalid ${actualDepPackage.version}`);
} else {
console.log(`Cannot find commonified dependency matching ${npmViewQuery}. Will recursively commonify it`);
const resp = await commonify({ packageName: sourcePackage, version: sourceVersion, scopeName, depth: depth + 1, maxDepth, publishNewIfExists: false, publishCommands });
if (!resp) {
console.log('dep pass thru', sourcePackage, sourceVersion);
return {
pkg: sourcePackage,
version: sourceVersion,
};
}
const { newPackageName: depNewPackageName, newPackageVersion: depNewPackageVersion } = resp;
commonifiedDependencyName = depNewPackageName;
commonifiedDependencyVersion = depNewPackageVersion;
}
mappedDependencies.push({ from: sourcePackage, to: commonifiedDependencyName });
return {
pkg: commonifiedDependencyName,
version: commonifiedDependencyVersion, // todo improve?
};
}
const packageFullName = `${packageName}@${version}`;
const archiveName = `${packageName}-${version}`;
const archivePath = `${archiveName}.tgz`;
const extractedPath = join(archiveName, 'package');
const transpiledPath = join(archiveName, 'transpiled')
await execa('mv', [archiveName, `${archiveName}-${new Date().getTime()}`]).catch(() => {});
if (!(await pathExists(archivePath))) await execa('npm', ['pack', packageFullName]);
await execa('tar', ['xf', archivePath]);
await mkdirp(archiveName);
await execa('mv', ['package', archiveName]);
const packageJsonOriginal = JSON.parse(await readFile(join(archiveName, 'package', 'package.json'), 'utf-8'));
// console.log(packageJsonOriginal);
assert(packageJsonOriginal.exports); // todo validate more?
async function convertDependencies(sourceDependencies) {
if (!sourceDependencies) return sourceDependencies;
return Object.fromEntries(await pMap(Object.entries(sourceDependencies), async ([sourcePackage, sourceVersion]) => {
const { pkg, version } = await mapPackage(sourcePackage, sourceVersion);
return [pkg, version];
}, { concurrency: 1 }));
}
const newPackageJson = {
name: newPackageName, // todo handle already scoped packages
version: newPackageVersion,
description: `CommonJS version of ${packageName} ${version}. See https://github.com/mifi/commonify`,
keywords: packageJsonOriginal.keywords,
homepage: packageJsonOriginal.homepage,
repository: packageJsonOriginal.repository,
license: packageJsonOriginal.license,
author: packageJsonOriginal.author,
main: packageJsonOriginal.exports,
files: packageJsonOriginal.files, // todo what if .mjs
directories: packageJsonOriginal.directories, // todo what if .mjs
scripts: {}, // don't need?
engines: packageJsonOriginal.engines,
dependencies: await convertDependencies(packageJsonOriginal.dependencies),
devDependencies: packageJsonOriginal.devDependencies,
optionalDependencies: packageJsonOriginal.optionalDependencies, // todo?
// todo more?
};
console.log('new package.json', newPackageJson);
const babelRcPath = resolve(`babelrc-${new Date().getTime()}.json`);
await writeFile(babelRcPath, JSON.stringify({
plugins: [
['module-resolver', {
alias: Object.fromEntries(mappedDependencies.map(({ from, to }) => [from, to])),
}],
'@babel/plugin-transform-modules-commonjs',
],
}, null, 2));
await execa('npx', ['babel', `${extractedPath}`, '-d', transpiledPath, '--config-file', babelRcPath]);
await execa('cp', ['-r', `${transpiledPath}/`, `${join(archiveName, 'package')}/`]);
await writeFile(join(archiveName, 'package', 'package.json'), JSON.stringify(newPackageJson, null, 2));
console.log('ready to publish');
publishCommands.push(`(cd ${join(archiveName, 'package')} && npm publish --access=public)`);
return {
newPackageName,
newPackageVersion,
};
}