feat(npmrc): automatically manage pnpm and node versions [INFRA-33946] (

#313) * feat(npmrc): automatically manage pnpm and node versions [INFRA-33946] * cdk is a subclass of ts * maybe leave the package-manager-strict=false ? --------- Co-authored-by: Andrew Hammond <[email protected]>
time-loop · Feb 6, 2025 · 8aa1502 · 8aa1502
1 parent 76a46f4
commit 8aa1502
Show file tree

Hide file tree

Showing 5 changed files with 225 additions and 6 deletions.
diff --git a/src/clickup-cdk.ts b/src/clickup-cdk.ts
@@ -1,4 +1,4 @@
-import { awscdk, Component, JsonPatch, SampleDir, SampleReadme } from 'projen';
+import { awscdk, Component, javascript, JsonPatch, SampleDir, SampleReadme } from 'projen';
 import * as semver from 'semver';
 import merge from 'ts-deepmerge';
 
@@ -14,6 +14,7 @@ import { nodeVersion } from './node-version';
 import { renovateWorkflow } from './renovate-workflow';
 import { slackAlert } from './slack-alert';
 import { updateProjen } from './update-projen';
+import { parameters } from './utils/parameters';
 
 export module clickupCdk {
   const minCdkVersion = '2.138.0'; // https://github.com/aws/aws-cdk/issues/29746
@@ -174,6 +175,19 @@ export module clickupCdk {
       if (options.sendSlackWebhookOnRelease !== false) {
         slackAlert.addReleaseEvent(this, options.sendSlackWebhookOnReleaseOpts);
       }
+
+      if (this.package.packageManager === javascript.NodePackageManager.PNPM) {
+        // Automate part of https://app.clickup-stg.com/333/v/dc/ad-757629/ad-3577645
+        this.package.addField('packageManager', `pnpm@${parameters.PROJEN_PNPM_VERSION}`);
+        // necessary to allow minor/patch version updates of pnpm on dev boxes
+        this.npmrc.addConfig('package-manager-strict', 'false');
+        // pnpm will manage the version of the package manager (pnpm)
+        this.npmrc.addConfig('manage-package-manager-versions', 'true');
+        // pnpm checks this value before running commands and will use (and install if missing) the specified version
+        this.npmrc.addConfig('use-node-version', parameters.PROJEN_NODE_VERSION);
+        // PNPM support for bundledDeps https://pnpm.io/npmrc#node-linker
+        this.npmrc.addConfig('node-linker', 'hoisted');
+      }
     }
   }
 
@@ -270,6 +284,17 @@ export module clickupCdk {
       if (options.serviceCatalogOptions) {
         datadogServiceCatalog.addServiceCatalogEvent(this, options.serviceCatalogOptions);
       }
+
+      // While this is a subclass of AwsCdkTypeScriptApp,
+      // it doesn't seem to be inheriting this stuff
+      if (this.package.packageManager === javascript.NodePackageManager.PNPM) {
+        // Automate part of https://app.clickup-stg.com/333/v/dc/ad-757629/ad-3577645
+        this.package.addField('packageManager', `pnpm@${parameters.PROJEN_PNPM_VERSION}`);
+        // pnpm will manage the version of the package manager (pnpm)
+        this.npmrc.addConfig('manage-package-manager-versions', 'true');
+        // pnpm checks this value before running commands and will use (and install if missing) the specified version
+        this.npmrc.addConfig('use-node-version', parameters.PROJEN_NODE_VERSION);
+      }
     }
   }
 

diff --git a/src/clickup-ts.ts b/src/clickup-ts.ts
@@ -240,9 +240,13 @@ export module clickupTs {
 
       if (this.package.packageManager === javascript.NodePackageManager.PNPM) {
         // Automate part of https://app.clickup-stg.com/333/v/dc/ad-757629/ad-3577645
-        this.package.addField('packageManager', 'pnpm@9.15.4');
+        this.package.addField('packageManager', `pnpm@${parameters.PROJEN_PNPM_VERSION}`);
         // necessary to allow minor/patch version updates of pnpm on dev boxes
         this.npmrc.addConfig('package-manager-strict', 'false');
+        // pnpm will manage the version of the package manager (pnpm)
+        this.npmrc.addConfig('manage-package-manager-versions', 'true');
+        // pnpm checks this value before running commands and will use (and install if missing) the specified version
+        this.npmrc.addConfig('use-node-version', parameters.PROJEN_NODE_VERSION);
       }
     }
   }

diff --git a/test/__snapshots__/clickup-cdk.test.ts.snap b/test/__snapshots__/clickup-cdk.test.ts.snap
diff --git a/test/clickup-cdk.test.ts b/test/clickup-cdk.test.ts
@@ -1,5 +1,5 @@
 import path from 'path';
-import { Testing } from 'projen';
+import { javascript, Testing } from 'projen';
 import { requiredParams } from './requiredParams';
 import { clickupCdk } from '../src';
 import { datadogServiceCatalog } from '../src/datadog-service-catalog';
@@ -51,6 +51,32 @@ describe('ClickUpCdkTypeScriptApp', () => {
         });
       });
     });
+
+    describe('pnpm', () => {
+      p = new clickupCdk.ClickUpCdkTypeScriptApp({
+        ...requiredParams,
+        packageManager: javascript.NodePackageManager.PNPM,
+      });
+      const synth = Testing.synth(p);
+      it('packageManager', () => {
+        expect(synth['package.json'].packageManager).toBe('[email protected]');
+      });
+
+      const npmrcEntries = [
+        // 'package-manager-strict=false',
+        'manage-package-manager-versions=true',
+        'use-node-version=22.13.1',
+      ];
+      it.each(npmrcEntries)('%s', (npmrcEntry) => {
+        expect(synth['.npmrc']).toContain(npmrcEntry);
+      });
+
+      ['.npmrc', 'package.json'].forEach((file) => {
+        test(file, () => {
+          expect(synth[file]).toMatchSnapshot();
+        });
+      });
+    });
   });
 });
 
@@ -93,6 +119,27 @@ describe('ClickUpCdkConstructLibrary', () => {
       const releaseFile = synth['.github/workflows/release.yml'];
       expect(releaseFile).toMatchSnapshot();
     });
+
+    describe('pnpm', () => {
+      p = new clickupCdk.ClickUpCdkConstructLibrary({
+        ...commonProps,
+        packageManager: javascript.NodePackageManager.PNPM,
+      });
+      const synth = Testing.synth(p);
+      it('packageManager', () => {
+        expect(synth['package.json'].packageManager).toBe('[email protected]');
+      });
+
+      const npmrcEntries = [
+        'package-manager-strict=false',
+        'manage-package-manager-versions=true',
+        'use-node-version=22.13.1',
+        'node-linker=hoisted',
+      ];
+      it.each(npmrcEntries)('%s', (npmrcEntry) => {
+        expect(synth['.npmrc']).toContain(npmrcEntry);
+      });
+    });
   });
 });
 

diff --git a/test/clickup-ts.test.ts b/test/clickup-ts.test.ts
@@ -120,10 +120,16 @@ describe('ClickUpTypeScriptProject', () => {
     });
     const synth = Testing.synth(p);
     it('packageManager', () => {
-      expect(synth['package.json'].packageManager).toBe('[email protected].4');
+      expect(synth['package.json'].packageManager).toBe('[email protected].5');
     });
-    it('package-manager-strict=false', () => {
-      expect(synth['.npmrc']).toMatch(/package-manager-strict=false/);
+
+    const npmrcEntries = [
+      'package-manager-strict=false',
+      'manage-package-manager-versions=true',
+      'use-node-version=22.13.1',
+    ];
+    it.each(npmrcEntries)('%s', (npmrcEntry) => {
+      expect(synth['.npmrc']).toContain(npmrcEntry);
     });
   });
 });