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(): treat other bricks as peer dependencies #3656

Merged
merged 1 commit into from
Nov 22, 2023
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
32 changes: 32 additions & 0 deletions packages/build-next-bricks/bin/post-build-next-bricks.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env node
import path from "node:path";
import { existsSync } from "node:fs";
import { copyFile, readdir, rm } from "node:fs/promises";

const bricksDir = path.join(process.cwd(), "bricks");

try {
const dirents = await readdir(bricksDir, { withFileTypes: true });

await Promise.all(
dirents.map(async (item) => {
if (!item.isDirectory()) {
return;
}

const packageDir = path.join(bricksDir, item.name);
const packageJsonPath = path.join(packageDir, "package.json");
const packageJsonBakPath = path.join(packageDir, "package.json.bak");
if (!existsSync(packageJsonBakPath)) {
return;
}

// Resume backed-up package.json.
await copyFile(packageJsonBakPath, packageJsonPath);
await rm(packageJsonBakPath);
})
);
} catch (e) {
console.error(e);
process.exitCode = 1;
}
109 changes: 109 additions & 0 deletions packages/build-next-bricks/bin/pre-build-next-bricks.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
#!/usr/bin/env node
import path from "node:path";
import { copyFile, readFile, readdir, writeFile } from "node:fs/promises";
import { existsSync } from "node:fs";
import * as prettier from "prettier";

const bricksDir = path.join(process.cwd(), "bricks");

const matchBrickPackages = (key) => /^@(?:next-)?bricks\//.test(key);

try {
const dirents = await readdir(bricksDir, { withFileTypes: true });

await Promise.all(
dirents.map(async (item) => {
if (!item.isDirectory()) {
return;
}

const packageDir = path.join(bricksDir, item.name);
const packageJsonPath = path.join(packageDir, "package.json");
if (!existsSync(packageJsonPath)) {
return;
}

const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"));

const dependencies = packageJson.dependencies || {};
const devDependencies = packageJson.devDependencies || {};
const peerDependencies = packageJson.peerDependencies || {};

// If error was thrown when building, thus pre-build was performed but post-build wasn't,
// so we handle this situation: remove deps that is copied when pre-building.
let changed = false;
for (const [dep, version] of Object.entries(peerDependencies)) {
if (dependencies[dep] === version) {
delete dependencies[dep];
changed = true;
}
if (devDependencies[dep] === version) {
delete devDependencies[dep];
changed = true;
}
}
if (changed) {
await writeFile(
packageJsonPath,
await prettier.format(JSON.stringify(packageJson, null, 2), {
filepath: packageJsonPath,
})
);
}

// If there were still "@next-bricks/*" in dependencies or devDependencies,
// throw an error. Should put them into peerDependencies.
if (
Object.keys(dependencies)
.concat(Object.keys(devDependencies))
.some(matchBrickPackages)
) {
throw new Error(
`Please put other "@next-bricks/*" into peerDependencies instead of dependencies or devDependencies for your brick package: ${packageJson.name}`
);
}
})
);

await Promise.all(
dirents.map(async (item) => {
if (!item.isDirectory()) {
return;
}

const packageDir = path.join(bricksDir, item.name);
const packageJsonPath = path.join(packageDir, "package.json");
const packageJsonBakPath = path.join(packageDir, "package.json.bak");
if (!existsSync(packageJsonPath)) {
return;
}

const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"));

const peerDependencies = packageJson.peerDependencies || {};
const bricksPeerDependencies =
Object.keys(peerDependencies).filter(matchBrickPackages);
if (bricksPeerDependencies.length === 0) {
return;
}
// Make a copy as backup file.
await copyFile(packageJsonPath, packageJsonBakPath);

// Copy "@next-bricks/*" from peerDependencies to devDependencies.
const devDependencies = (packageJson.devDependencies ??= {});
for (const dep of bricksPeerDependencies) {
devDependencies[dep] = peerDependencies[dep];
}

await writeFile(
packageJsonPath,
await prettier.format(JSON.stringify(packageJson, null, 2), {
filepath: packageJsonPath,
})
);
})
);
} catch (e) {
console.error(e);
process.exitCode = 1;
}
5 changes: 4 additions & 1 deletion packages/build-next-bricks/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
"type": "module",
"typings": "./index.d.ts",
"bin": {
"build-next-bricks": "./bin/build-next-bricks.js"
"build-next-bricks": "./bin/build-next-bricks.js",
"pre-build-next-bricks": "./bin/pre-build-next-bricks.js",
"post-build-next-bricks": "./bin/post-build-next-bricks.js"
},
"files": [
"bin",
Expand Down Expand Up @@ -46,6 +48,7 @@
"postcss": "^8.4.31",
"postcss-loader": "^7.3.3",
"postcss-preset-env": "^9.3.0",
"prettier": "^3.0.3",
"style-loader": "^3.3.3",
"typescript": "^5.2.2",
"webpack": "^5.89.0"
Expand Down