Merge pull request #95 from bmish/type-fest-package-json

Add real package.json types from type-fest

Author: bmish

.eslintrc.js

@@ -11,7 +11,7 @@ module.exports = {
   },
   settings: {
     node: {
-      tryExtensions: ['.js', '.json', '.node', '.ts'],
+      tryExtensions: ['.js', '.json', '.node', '.ts', '.d.ts'],
     },
   },
   overrides: [

bin/check-dependency-version-consistency.ts

@@ -10,11 +10,16 @@ import {
 } from '../lib/dependency-versions';
 import { mismatchingVersionsToOutputLines } from '../lib/output';
 import { join } from 'path';
+import type { PackageJson } from 'type-fest';
 
 function getCurrentPackageVersion(): string {
-  return JSON.parse(
+  const packageJson: PackageJson = JSON.parse(
     readFileSync(join(__dirname, '..', '..', 'package.json'), 'utf-8') // Relative to compiled version of this file in dist/bin
-  ).version;
+  );
+  if (!packageJson.version) {
+    throw new Error('Could not find package.json `version`');
+  }
+  return packageJson.version;
 }
 
 // Used for collecting repeated CLI options into an array.

lib/dependency-versions.ts

@@ -1,4 +1,5 @@
 import { readFileSync, existsSync } from 'fs';
+import type { PackageJson } from 'type-fest';
 import { getPackageJsonPaths } from './workspace';
 
 export type DependenciesToVersionsSeen = Map<
@@ -58,28 +59,34 @@ function recordDependencyVersionsForPackageJson(
   }
 
   const title = packageJsonPath.replace(`${root}/`, '');
-  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+  const packageJson: PackageJson = JSON.parse(
+    readFileSync(packageJsonPath, 'utf-8')
+  );
 
   if (packageJson.dependencies) {
-    Object.keys(packageJson.dependencies).forEach((dependency) => {
+    for (const [dependency, dependencyVersion] of Object.entries(
+      packageJson.dependencies
+    )) {
       recordDependencyVersion(
         dependenciesToVersionsSeen,
         dependency,
         title,
-        packageJson.dependencies[dependency]
+        dependencyVersion
       );
-    });
+    }
   }
 
   if (packageJson.devDependencies) {
-    Object.keys(packageJson.devDependencies).forEach((dependency) => {
+    for (const [dependency, dependencyVersion] of Object.entries(
+      packageJson.devDependencies
+    )) {
       recordDependencyVersion(
         dependenciesToVersionsSeen,
         dependency,
         title,
-        packageJson.devDependencies[dependency]
+        dependencyVersion
       );
-    });
+    }
   }
 }
 

lib/workspace.ts

@@ -2,6 +2,7 @@ import { join } from 'path';
 import { existsSync, readFileSync } from 'fs';
 import { getDirectoriesInPath } from './fs';
 import { flatMap } from './js';
+import type { PackageJson } from 'type-fest';
 
 export function getPackageJsonPaths(root: string): string[] {
   return getPackages(root).map((pkg: string) =>
@@ -28,7 +29,7 @@ export function getWorkspaces(root: string): string[] {
     throw new Error('No package.json found at provided path.');
   }
 
-  const workspacePackageJson = JSON.parse(
+  const workspacePackageJson: PackageJson = JSON.parse(
     readFileSync(join(root, 'package.json'), 'utf-8')
   );
 
@@ -38,5 +39,9 @@ export function getWorkspaces(root: string): string[] {
     );
   }
 
+  if (!Array.isArray(workspacePackageJson.workspaces)) {
+    throw new TypeError('package.json `workspaces` is not a string array.');
+  }
+
   return workspacePackageJson.workspaces;
 }

package.json

@@ -37,7 +37,8 @@
   },
   "dependencies": {
     "commander": "^7.0.0",
-    "globby": "^11.0.0"
+    "globby": "^11.0.0",
+    "type-fest": "^1.0.2"
   },
   "devDependencies": {
     "@types/mocha": "^8.2.0",

yarn.lock

@@ -5173,6 +5173,11 @@ type-fest@^0.8.0, type-fest@^0.8.1:
   resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d"
   integrity sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==
 
+type-fest@^1.0.2:
+  version "1.1.1"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.1.1.tgz#210251e7f57357a1457269e6b34837fed067ac2c"
+  integrity sha512-RPDKc5KrIyKTP7Fk75LruUagqG6b+OTgXlCR2Z0aQDJFeIvL4/mhahSEtHmmVzXu4gmA0srkF/8FCH3WOWxTWA==
+
 typedarray-to-buffer@^3.1.5:
   version "3.1.5"
   resolved "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080"