Skip to content

chore: allow un-overwritable scripts and devDependencies in package.json #1207

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 28, 2020
Merged

chore: allow un-overwritable scripts and devDependencies in package.json #1207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79845b7
chore: allow un-overwritable scripts and devdeps in package.json
AllanZhengYP May 27, 2020
290a545
chore: fix copy-to-clients
AllanZhengYP May 28, 2020
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
26 changes: 25 additions & 1 deletion scripts/generate-clients/copy-to-clients.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,17 @@ const getOverwritablePredicate = packageName => pathName => {
* from codegen, but maintain the newer dependency versions
* in existing package.json
*/
const mergeManifest = (fromContent, toContent) => {
const mergeManifest = (fromContent = {}, toContent) => {
const merged = {};
const fromNames = Object.keys(fromContent);
for (const name of fromNames) {
if (typeof toContent[name] === "object") {
merged[name] = mergeManifest(fromContent[name], toContent[name]);
if (name === "scripts" || name === "devDependencies") {
// Allow target package.json(toContent) has its own special script or
// dev dependencies that won't be overwritten in codegen
merged[name] = { ...toContent[name], ...merged[name] };
}
if (name === "dependencies" || name === "devDependencies") {
// Sort dependencies as done by lerna
merged[name] = Object.fromEntries(Object.entries(merged[name]).sort());
Expand All @@ -62,6 +67,24 @@ const mergeManifest = (fromContent, toContent) => {
return merged;
};

/**
* Remove "^" from the the version of dependencies on @aws-sdk packages.
* e.g. "@aws-sdk/config-resolver": "^1.0.0-gamma.0"
* => "@aws-sdk/config-resolver": "1.0.0-gamma.0"
*/
const pinDependencies = manifest => {
const removeRangeVersion = ([name, version]) =>
name.indexOf("@aws-sdk/") === 0
? [name, version.replace("^", "")]
: [name, version];
manifest.dependencies = Object.fromEntries(
Object.entries(manifest.dependencies).map(removeRangeVersion)
);
manifest.devDependencies = Object.fromEntries(
Object.entries(manifest.devDependencies).map(removeRangeVersion)
);
};
Comment on lines +75 to +86
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: use functions all the way to avoid mutating manifest and having small functions

const filterAwsSdkDeps = (name) => name.indexOf("@aws-sdk/") === 0;
const removeCaretFromDepVersion = (version) => version.replace("^", "");

const getPinnedAwsSdkDeps = (deps) => ({
  ...deps,
  ...Object.entries(deps)
    .filter(([name, version]) => filterAwsSdkDeps(name))
    .reduce(
      (acc, [name, version]) => ({
        ...acc,
        [name]: removeCaretFromDepVersion(version),
      }),
      {}
    ),
});

const getManifestWithPinnedAwsSdkDeps = (manifest) => ({
  ...manifest,
  dependencies: getPinnedAwsSdkDeps(manifest.dependencies),
  devDependencies: getPinnedAwsSdkDeps(manifest.devDependencies),
});


const copyToClients = async (sourceDir, destinationDir) => {
for (const modelName of readdirSync(sourceDir)) {
if (modelName === "source") continue;
Expand Down Expand Up @@ -90,6 +113,7 @@ const copyToClients = async (sourceDir, destinationDir) => {
? JSON.parse(readFileSync(destSubPath).toString())
: {};
const mergedManifest = mergeManifest(packageManifest, destManifest);
pinDependencies(mergedManifest);
writeFileSync(
destSubPath,
JSON.stringify(mergedManifest, null, 2).concat(`\n`)
Expand Down