refactor: use immutable data in a pure function (#6)

Author: LayZeeDK

package.json

@@ -32,17 +32,21 @@
   "author": "Nacho Vazquez",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.6"
+    "@actions/core": "^1.2.6",
+    "lodash-es": "^4.17.15",
+    "object.fromentries": "^2.0.2"
   },
   "devDependencies": {
     "@commitlint/cli": "11.0.0",
     "@commitlint/config-angular": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
-    "all-contributors-cli": "^6.18.0",
     "@types/jest": "^26.0.14",
+    "@types/lodash-es": "^4.17.3",
     "@types/node": "^14.11.7",
+    "@types/object.fromentries": "^2.0.0",
     "@typescript-eslint/parser": "^4.4.0",
     "@vercel/ncc": "^0.24.1",
+    "all-contributors-cli": "^6.18.0",
     "eslint": "^7.10.0",
     "eslint-plugin-github": "^4.1.1",
     "eslint-plugin-jest": "^24.1.0",

src/get-angular-versions.ts

@@ -1,7 +1,7 @@
 import {versions} from './angular-versions';
 import {PackageJsonVersion} from './types/package-json-version';
 
-export async function getAngularVersion(
+export async function getAngularVersions(
   angularVersion: string
 ): Promise<PackageJsonVersion> {
   if (versions.has(angularVersion)) {

src/main.ts

@@ -1,29 +1,41 @@
 import * as core from '@actions/core';
-import {getAngularVersion} from './get-angular-versions';
+import * as fs from 'fs';
+
+import {getAngularVersions} from './get-angular-versions';
 import {overrideAngularVersions} from './override-angular-versions';
+import {PackageJsonVersion} from './types/package-json-version';
 
 async function run(): Promise<void> {
   try {
     const angularVersion: string = core.getInput('angular_version');
-    core.debug(`Finding dependencies for angular version ${angularVersion}`);
+    core.debug(`Finding dependencies for Angular version ${angularVersion}`);
 
-    const versions = await getAngularVersion(angularVersion);
-    core.debug(`Depedencies found: \n ${JSON.stringify(versions, null, 2)}`);
+    const angularVersions = await getAngularVersions(angularVersion);
+    core.debug(
+      `Depedencies found: \n ${JSON.stringify(angularVersions, null, 2)}`
+    );
 
     const filePath: string = core.getInput('file_path');
     core.debug(`merging found dependencies with file ${filePath}`);
 
-    const modified = overrideAngularVersions(versions, filePath);
+    const projectVersions: PackageJsonVersion = JSON.parse(
+      fs.readFileSync(filePath).toString()
+    );
+    const mergedVersions = overrideAngularVersions({
+      angularVersions,
+      projectVersions
+    });
+    fs.writeFileSync(filePath, JSON.stringify(mergedVersions, null, 2));
 
     core.debug(
       `Depedencies merge in package.json: \n ${JSON.stringify(
-        modified,
+        mergedVersions,
         null,
         2
       )}`
     );
 
-    core.debug(new Date().toTimeString());
+    core.debug(new Date().toISOString());
   } catch (error) {
     core.setFailed(error.message);
   }

src/override-angular-versions.ts

@@ -1,26 +1,39 @@
-import {PackageJsonVersion} from './types/package-json-version';
-import * as fs from 'fs';
+import {intersection} from 'lodash-es';
+import fromEntries from 'object.fromentries';
 
-export function overrideAngularVersions(
-  angularVersions: PackageJsonVersion,
-  path: string
-): PackageJsonVersion {
-  const rawData = fs.readFileSync(path);
-  const packageJson: PackageJsonVersion = JSON.parse(rawData.toString());
+import {PackageJsonVersion} from './types/package-json-version';
 
-  for (const prop in angularVersions.dependencies) {
-    if (packageJson.dependencies.hasOwnProperty(prop)) {
-      packageJson.dependencies[prop] = angularVersions.dependencies[prop];
-    }
-  }
+export function overrideAngularVersions({
+  angularVersions,
+  projectVersions
+}: {
+  angularVersions: PackageJsonVersion;
+  projectVersions: PackageJsonVersion;
+}): PackageJsonVersion {
+  const dependenciesReplacements = fromEntries<string>(
+    intersection(
+      Object.keys(projectVersions.dependencies),
+      Object.keys(angularVersions.dependencies)
+    ).map(dependency => [dependency, angularVersions.dependencies[dependency]])
+  );
+  const devDependenciesReplacements = fromEntries<string>(
+    intersection(
+      Object.keys(projectVersions.devDependencies),
+      Object.keys(angularVersions.devDependencies)
+    ).map(devDependency => [
+      devDependency,
+      angularVersions.devDependencies[devDependency]
+    ])
+  );
 
-  for (const prop in angularVersions.devDependencies) {
-    if (packageJson.devDependencies.hasOwnProperty(prop)) {
-      packageJson.devDependencies[prop] = angularVersions.devDependencies[prop];
+  return {
+    dependencies: {
+      ...projectVersions.dependencies,
+      ...dependenciesReplacements
+    },
+    devDependencies: {
+      ...projectVersions.devDependencies,
+      ...devDependenciesReplacements
     }
-  }
-
-  fs.writeFileSync(path, JSON.stringify(packageJson));
-
-  return packageJson;
+  };
 }

tsconfig.json

@@ -1,12 +1,13 @@
 {
   "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    "outDir": "./lib",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "target": "es2017" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "lib": ["es2017"] /* Supported by Node.js >=8.10.0 */,
+    "outDir": "./lib" /* Redirect output structure to the directory. */,
+    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
   },
   "exclude": ["node_modules", "**/*.test.ts"]
 }