refactor(@schematics/angular): sync schematics dependencies using Renovate

alan-agius4 · alan-agius4 · commit 14df2aaef992 · 2021-07-20T18:58:29.000+02:00
With this change we sync workspace and library schematic dependencies using Renovate. We do this to avoid having to keep these in sync by hand.

We could have used TypeScripts' `resolveJsonModule` to make the `latestVersion` object typesafe. But `ts_library` doesn't support JSON inputs.
diff --git a/packages/schematics/angular/BUILD.bazel b/packages/schematics/angular/BUILD.bazel
@@ -64,6 +64,7 @@ ts_library(
         include = [
             "collection.json",
             "package.json",
+            "utility/latest-versions/package.json",
             "migrations/migration-collection.json",
             "*/schema.json",
             "*/files/**/*",
diff --git a/packages/schematics/angular/application/index.ts b/packages/schematics/angular/application/index.ts
@@ -50,7 +50,7 @@ function addDependenciesToPackageJson(options: ApplicationOptions) {
       {
         type: NodeDependencyType.Dev,
         name: 'typescript',
-        version: latestVersions.TypeScript,
+        version: latestVersions['typescript'],
       },
     ].forEach((dependency) => addPackageJsonDependency(host, dependency));
 
diff --git a/packages/schematics/angular/application/index_spec.ts b/packages/schematics/angular/application/index_spec.ts
@@ -341,15 +341,15 @@ describe('Application Schematic', () => {
         .toPromise();
       const pkg = JSON.parse(tree.readContent('/package.json'));
       expect(pkg.devDependencies['@angular/compiler-cli']).toEqual(latestVersions.Angular);
-      expect(pkg.devDependencies['typescript']).toEqual(latestVersions.TypeScript);
+      expect(pkg.devDependencies['typescript']).toEqual(latestVersions['typescript']);
     });
 
     it(`should not override existing users dependencies`, async () => {
       const oldPackageJson = workspaceTree.readContent('package.json');
       workspaceTree.overwrite(
         'package.json',
         oldPackageJson.replace(
-          `"typescript": "${latestVersions.TypeScript}"`,
+          `"typescript": "${latestVersions['typescript']}"`,
           `"typescript": "~2.5.2"`,
         ),
       );
diff --git a/packages/schematics/angular/library/index.ts b/packages/schematics/angular/library/index.ts
@@ -61,17 +61,17 @@ function addDependenciesToPackageJson() {
       {
         type: NodeDependencyType.Dev,
         name: 'ng-packagr',
-        version: latestVersions.ngPackagr,
+        version: latestVersions['ng-packagr'],
       },
       {
         type: NodeDependencyType.Default,
         name: 'tslib',
-        version: latestVersions.TsLib,
+        version: latestVersions['tslib'],
       },
       {
         type: NodeDependencyType.Dev,
         name: 'typescript',
-        version: latestVersions.TypeScript,
+        version: latestVersions['typescript'],
       },
     ].forEach((dependency) => addPackageJsonDependency(host, dependency));
 
@@ -162,8 +162,8 @@ export default function (options: LibraryOptions): Rule {
         distRoot,
         relativePathToWorkspaceRoot: relativePathToWorkspaceRoot(projectRoot),
         prefix,
-        angularLatestVersion: latestVersions.Angular.replace('~', '').replace('^', ''),
-        tsLibLatestVersion: latestVersions.TsLib.replace('~', '').replace('^', ''),
+        angularLatestVersion: latestVersions.Angular.replace(/\~|\^/, ''),
+        tsLibLatestVersion: latestVersions['tslib'].replace(/\~|\^/, ''),
         folderName,
       }),
       move(projectRoot),
diff --git a/packages/schematics/angular/library/index_spec.ts b/packages/schematics/angular/library/index_spec.ts
@@ -183,7 +183,7 @@ describe('Library Schematic', () => {
         .toPromise();
 
       const packageJson = getJsonFileContent(tree, 'package.json');
-      expect(packageJson.devDependencies['ng-packagr']).toEqual(latestVersions.ngPackagr);
+      expect(packageJson.devDependencies['ng-packagr']).toEqual(latestVersions['ng-packagr']);
     });
 
     it('should use the latest known versions in package.json', async () => {
@@ -192,15 +192,15 @@ describe('Library Schematic', () => {
         .toPromise();
       const pkg = JSON.parse(tree.readContent('/package.json'));
       expect(pkg.devDependencies['@angular/compiler-cli']).toEqual(latestVersions.Angular);
-      expect(pkg.devDependencies['typescript']).toEqual(latestVersions.TypeScript);
+      expect(pkg.devDependencies['typescript']).toEqual(latestVersions['typescript']);
     });
 
     it(`should not override existing users dependencies`, async () => {
       const oldPackageJson = workspaceTree.readContent('package.json');
       workspaceTree.overwrite(
         'package.json',
         oldPackageJson.replace(
-          `"typescript": "${latestVersions.TypeScript}"`,
+          `"typescript": "${latestVersions['typescript']}"`,
           `"typescript": "~2.5.2"`,
         ),
       );
diff --git a/packages/schematics/angular/migrations/update-10/update-dependencies.ts b/packages/schematics/angular/migrations/update-10/update-dependencies.ts
@@ -22,7 +22,7 @@ export default function (): Rule {
       'karma-jasmine': '~4.0.0',
       'karma-jasmine-html-reporter': '^1.5.0',
       'protractor': '~7.0.0',
-      'ng-packagr': latestVersions.ngPackagr,
+      'ng-packagr': latestVersions['ng-packagr'],
       'tslib': '^2.0.0',
     };
 
diff --git a/packages/schematics/angular/migrations/update-11/update-dependencies.ts b/packages/schematics/angular/migrations/update-11/update-dependencies.ts
@@ -9,7 +9,6 @@
 import { Rule } from '@angular-devkit/schematics';
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
 import { addPackageJsonDependency, getPackageJsonDependency } from '../../utility/dependencies';
-import { latestVersions } from '../../utility/latest-versions';
 
 export default function (): Rule {
   return (host, context) => {
diff --git a/packages/schematics/angular/migrations/update-9/add-tslib.ts b/packages/schematics/angular/migrations/update-9/add-tslib.ts
@@ -25,7 +25,7 @@ export function addTsLib(): Rule {
 
     addPackageJsonDependency(host, {
       name: 'tslib',
-      version: latestVersions.TsLib,
+      version: latestVersions['tslib'],
       type: NodeDependencyType.Default,
       overwrite: true,
     });
diff --git a/packages/schematics/angular/migrations/update-9/update-dependencies.ts b/packages/schematics/angular/migrations/update-9/update-dependencies.ts
@@ -12,7 +12,6 @@ import {
   getPackageJsonDependency,
   removePackageJsonDependency,
 } from '../../utility/dependencies';
-import { latestVersions } from '../../utility/latest-versions';
 
 export function updateDependencies(): Rule {
   return (host, context) => {
diff --git a/packages/schematics/angular/utility/latest-versions.ts b/packages/schematics/angular/utility/latest-versions.ts
@@ -6,18 +6,19 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-export const latestVersions = {
+export const latestVersions: Record<string, string> & {
+  Angular: string;
+  DevkitBuildAngular: string;
+} = {
+  // We could have used TypeScripts' `resolveJsonModule` to make the `latestVersion` object typesafe,
+  // but ts_library doesn't support JSON inputs.
+  ...require('./latest-versions/package.json')['dependencies'],
+
   // These versions should be kept up to date with latest Angular peer dependencies.
   Angular: '~12.2.0-next.2',
-  RxJs: '~6.6.0',
-  ZoneJs: '~0.11.4',
-  TypeScript: '~4.3.2',
-  TsLib: '^2.2.0',
 
   // Since @angular-devkit/build-angular and @schematics/angular are always
   // published together from the same monorepo, and they are both
   // non-experimental, they will always have the same version.
   DevkitBuildAngular: '~' + require('../package.json')['version'],
-
-  ngPackagr: '^12.1.0',
 };
diff --git a/packages/schematics/angular/utility/latest-versions/package.json b/packages/schematics/angular/utility/latest-versions/package.json
@@ -0,0 +1,20 @@
+{
+  "description": "Package versions used by schematics in @schematics/angular.",
+  "comment": "This file is needed so that depedencies are synced by Renovate.",
+  "private": true,
+  "dependencies": {
+    "@types/jasmine": "~3.8.0",
+    "@types/node": "^12.11.1",
+    "jasmine-core": "~3.8.0",
+    "karma-chrome-launcher": "~3.1.0",
+    "karma-coverage": "~2.0.3",
+    "karma-jasmine-html-reporter": "~1.7.0",
+    "karma-jasmine": "~4.0.0",
+    "karma": "~6.3.0",
+    "ng-packagr": "^12.1.1",
+    "rxjs": "~6.6.0",
+    "tslib": "^2.3.0",
+    "typescript": "~4.3.5",
+    "zone.js": "~0.11.4"
+  }
+}
diff --git a/packages/schematics/angular/workspace/files/package.json.template b/packages/schematics/angular/workspace/files/package.json.template
@@ -18,21 +18,21 @@
     "@angular/platform-browser": "<%= latestVersions.Angular %>",
     "@angular/platform-browser-dynamic": "<%= latestVersions.Angular %>",
     "@angular/router": "<%= latestVersions.Angular %>",
-    "rxjs": "<%= latestVersions.RxJs %>",
-    "tslib": "<%= latestVersions.TsLib %>",
-    "zone.js": "<%= latestVersions.ZoneJs %>"
+    "rxjs": "<%= latestVersions['rxjs'] %>",
+    "tslib": "<%= latestVersions['tslib'] %>",
+    "zone.js": "<%= latestVersions['zone.js'] %>"
   },
   "devDependencies": {
     "@angular/cli": "<%= '~' + version %>",
     "@angular/compiler-cli": "<%= latestVersions.Angular %>",<% if (!minimal) { %>
-    "@types/jasmine": "~3.8.0",<% } %>
-    "@types/node": "^12.11.1",<% if (!minimal) { %>
-    "jasmine-core": "~3.8.0",
-    "karma": "~6.3.0",
-    "karma-chrome-launcher": "~3.1.0",
-    "karma-coverage": "~2.0.3",
-    "karma-jasmine": "~4.0.0",
-    "karma-jasmine-html-reporter": "~1.7.0",<% } %>
-    "typescript": "<%= latestVersions.TypeScript %>"
+    "@types/jasmine": "<%= latestVersions['@types/jasmine'] %>",<% } %>
+    "@types/node": "<%= latestVersions['@types/node'] %>",<% if (!minimal) { %>
+    "jasmine-core": "<%= latestVersions['jasmine-core'] %>",
+    "karma": "<%= latestVersions['karma'] %>",
+    "karma-chrome-launcher": "<%= latestVersions['karma-chrome-launcher'] %>",
+    "karma-coverage": "<%= latestVersions['karma-coverage'] %>",
+    "karma-jasmine": "<%= latestVersions['karma-jasmine'] %>",
+    "karma-jasmine-html-reporter": "<%= latestVersions['karma-jasmine-html-reporter'] %>",<% } %>
+    "typescript": "<%= latestVersions['typescript'] %>"
   }
 }
diff --git a/packages/schematics/angular/workspace/index_spec.ts b/packages/schematics/angular/workspace/index_spec.ts
@@ -54,9 +54,9 @@ describe('Workspace Schematic', () => {
     const tree = await schematicRunner.runSchematicAsync('workspace', defaultOptions).toPromise();
     const pkg = JSON.parse(tree.readContent('/package.json'));
     expect(pkg.dependencies['@angular/core']).toEqual(latestVersions.Angular);
-    expect(pkg.dependencies['rxjs']).toEqual(latestVersions.RxJs);
-    expect(pkg.dependencies['zone.js']).toEqual(latestVersions.ZoneJs);
-    expect(pkg.devDependencies['typescript']).toEqual(latestVersions.TypeScript);
+    expect(pkg.dependencies['rxjs']).toEqual(latestVersions['rxjs']);
+    expect(pkg.dependencies['zone.js']).toEqual(latestVersions['zone.js']);
+    expect(pkg.devDependencies['typescript']).toEqual(latestVersions['typescript']);
   });
 
   it('should create correct files when using minimal', async () => {
diff --git a/renovate.json b/renovate.json
@@ -44,7 +44,15 @@
       "enabled": false
     },
     {
-      "excludePackagePatterns": ["^@angular/.*"],
+      "matchPaths": ["packages/schematics/angular/utility/latest-versions/package.json"],
+      "matchPackagePatterns": ["*"],
+      "groupName": "schematics dependencies",
+      "groupSlug": "all-schematics-ependencies"
+    },
+    {
+      "excludePackagePatterns": [
+        "!packages/schematics/angular/utility/latest-versions/package.json"
+      ],
       "matchPackagePatterns": ["*"],
       "matchUpdateTypes": ["minor", "patch"],
       "groupName": "all non-major dependencies",

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ function addDependenciesToPackageJson(options: ApplicationOptions) {`
`50`	`50`	`{`
`51`	`51`	`type: NodeDependencyType.Dev,`
`52`	`52`	`name: 'typescript',`
`53`		`- version: latestVersions.TypeScript,`
	`53`	`+ version: latestVersions['typescript'],`
`54`	`54`	`},`
`55`	`55`	`].forEach((dependency) => addPackageJsonDependency(host, dependency));`
`56`	`56`