-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added script to check version-sync between workspace (#3486)
* ✨ Added script for verifying dep-versions across workspace * ✨ Added script for verifying dep-versions across workspace * ✨ Added script for verifying dep-versions across workspace * ✨ Added script for verifying dep-versions across workspace * ✨ Added script for verifying dep-versions across workspace * 📝 Better texts * 📝 Better texts * 📝 Added comments * 📝 Updated minoer package-differences * 📝 Upgraded stylelint * 📝 Upgraded babel-loader * 📝 Add ^ to ds-css versionsing across repo * ♻️ Small refactor to reduce use of forEach
- Loading branch information
Showing
13 changed files
with
158 additions
and
184 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| #!/bin/sh | ||
| . "$(dirname $0)/_/husky.sh" | ||
|
|
||
| yarn lint-staged | ||
| yarn lint-staged && yarn tsx ./scripts/in-sync-versions.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| import { execSync } from "child_process"; | ||
| import { readFileSync } from "fs"; | ||
| import { join } from "path"; | ||
|
|
||
| validateVersions(); | ||
|
|
||
| function validateVersions() { | ||
| const workspaces = getYarnWorkspacesList(); | ||
|
|
||
| if (workspaces.length === 0) { | ||
| console.error("No workspaces found"); | ||
| return; | ||
| } | ||
|
|
||
| const dependencies = new Map<string, string[]>(); | ||
|
|
||
| for (const { location } of workspaces) { | ||
| const packageJson = JSON.parse( | ||
| readFileSync(join(location, "./package.json"), { encoding: "utf-8" }), | ||
| ); | ||
|
|
||
| for (const localDependency of [ | ||
| packageJson.dependencies, | ||
| packageJson.devDependencies, | ||
| packageJson.peerDependencies, | ||
| ]) { | ||
| if (!localDependency) { | ||
| continue; | ||
| } | ||
|
|
||
| for (const [dependency, version] of Object.entries(localDependency)) { | ||
| if (!dependencies.has(dependency)) { | ||
| dependencies.set(dependency, []); | ||
| } | ||
| dependencies.get(dependency)?.push(version as string); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const warnings: { dependency: string; filteredVersions: string[] }[] = []; | ||
|
|
||
| for (const [dependency, versions] of dependencies) { | ||
| /** | ||
| * While we could resolve these cases using "semver" or other packages, | ||
| * we are going to keep it simple and just check "regular" cases. | ||
| */ | ||
| const filteredVersions = versions.filter( | ||
| (version) => version !== "*" && !version.includes(">="), | ||
| ); | ||
|
|
||
| const versionsAreEqual = filteredVersions.every( | ||
| (version) => version === filteredVersions[0], | ||
| ); | ||
|
|
||
| if (!versionsAreEqual) { | ||
| warnings.push({ | ||
| dependency, | ||
| /* To keep console simple, we hide duplicates */ | ||
| filteredVersions: [...new Set(filteredVersions)], | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| if (warnings.length > 0) { | ||
| console.warn( | ||
| "\nWorkspaces local dependency versions not synced across repository:", | ||
| ); | ||
|
|
||
| for (const { dependency, filteredVersions } of warnings) { | ||
| logWarning(dependency, filteredVersions); | ||
| } | ||
|
|
||
| console.warn( | ||
| "\nPlease make sure all workspaces have the same version for each dependency.\n\n", | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the list of workspaces in the repository by using the `yarn workspaces list` command | ||
| */ | ||
| function getYarnWorkspacesList(): { location: string; name: string }[] { | ||
| try { | ||
| const execCommand = execSync("yarn workspaces list --json", { | ||
| encoding: "utf-8", | ||
| }); | ||
|
|
||
| const workspaces = execCommand | ||
| .split("\n") | ||
| .filter(Boolean) | ||
| .map((line) => { | ||
| const { location, name } = JSON.parse(line); | ||
| return { location, name }; | ||
| }); | ||
|
|
||
| return workspaces; | ||
| } catch { | ||
| console.error("Failed to get workspaces list"); | ||
| } | ||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * Adds some colors to better highlight the warning | ||
| */ | ||
| function logWarning(dependency: string, filteredVersions: string[]) { | ||
| const colors = { | ||
| reset: "\x1b[0m", | ||
| red: "\x1b[31m", | ||
| yellow: "\x1b[33m", | ||
| }; | ||
|
|
||
| const coloredDependency = `${colors.yellow}${dependency}${colors.reset}`; | ||
| const coloredVersions = `${colors.red}${filteredVersions.join(", ")}${ | ||
| colors.reset | ||
| }`; | ||
|
|
||
| console.warn(`- ${coloredDependency}: ${coloredVersions}`); | ||
| } |
Oops, something went wrong.