chore: support checking dependencies consistance across packages

and fix related dependencies

Author: e-cloud

packages/@ngtools/webpack/package.json

@@ -31,11 +31,11 @@
     "source-map": "^0.5.6"
   },
   "peerDependencies": {
-    "@angular/compiler": "^2.3.1",
-    "@angular/compiler-cli": "^2.3.1",
-    "@angular/core": "^2.3.1",
+    "@angular/compiler": "~2.3.1",
+    "@angular/compiler-cli": "~2.3.1",
+    "@angular/core": "~2.3.1",
     "@angular/tsc-wrapped": "^0.5.0",
-    "typescript": "^2.0.2",
+    "typescript": "^2.0.3",
     "reflect-metadata": "^0.1.8",
     "webpack": "2.2.0-rc.3"
   }

scripts/publish/validate_dependencies.js

@@ -7,6 +7,7 @@ const fs = require('fs');
 const glob = require('glob');
 const packages = require('../../lib/packages');
 const path = require('path');
+const _ = require('lodash');
 
 
 const IMPORT_RE = /(^|\n)\s*import\b(?:.|\n)*?\'[^\']*\'/g;
@@ -28,6 +29,18 @@ const ANGULAR_PACKAGES = [
   '@angular/core'
 ];
 
+let exitCode = 0;
+
+const depsInfo = validateDependenciesPerPackage(packages);
+
+validateRootPackageJson(depsInfo.allSourceDeps);
+
+checkDependenciesConflictAcrossPackages(depsInfo.allDeclaredDepsMap);
+
+process.exit(exitCode);
+
+
+// utils
 
 function listImportedModules(source) {
   const imports = source.match(IMPORT_RE);
@@ -40,7 +53,7 @@ function listImportedModules(source) {
     .filter(x => !!x)
     .filter(modulePath => modulePath[0] != '.')
     .map(fullImportPath => {
-      if (fullImportPath[0] == '@') {
+      if (fullImportPath[0] === '@') {
         // Need to get the scope as well.
         return fullImportPath.split('/').slice(0, 2).join('/');
       } else {
@@ -60,7 +73,7 @@ function listRequiredModules(source) {
     .filter(x => !!x)
     .filter(modulePath => modulePath[0] != '.')
     .map(fullImportPath => {
-      if (fullImportPath[0] == '@') {
+      if (fullImportPath[0] === '@') {
         // Need to get the scope as well.
         return fullImportPath.split('/').slice(0, 2).join('/');
       } else {
@@ -70,7 +83,7 @@ function listRequiredModules(source) {
 }
 
 function reportMissingDependencies(missingDeps) {
-  if (missingDeps.length == 0) {
+  if (missingDeps.length === 0) {
     console.log(chalk.green('  no dependency missing from package.json.'));
   } else {
     console.log(chalk.yellow(`  ${missingDeps.length} missing from package.json:`));
@@ -80,7 +93,7 @@ function reportMissingDependencies(missingDeps) {
 }
 
 function reportExcessiveDependencies(overDeps) {
-  if (overDeps.length == 0) {
+  if (overDeps.length === 0) {
     console.log(chalk.green('  no excessive dependencies in package.json.'));
   } else {
     console.log(chalk.yellow(`  ${overDeps.length} excessive dependencies in package.json:`));
@@ -89,63 +102,114 @@ function reportExcessiveDependencies(overDeps) {
   }
 }
 
-let exitCode = 0;
-const overallDeps = [];
-for (const packageName of Object.keys(packages)) {
-  console.log(chalk.green(`Reading dependencies of "${packageName}".`));
+function reportInconsistentDepsDependencies(inconsistentDeps) {
+  if (inconsistentDeps.length === 0) {
+    console.log(chalk.green('  no inconsistentDeps dependencies across packages.'));
+  } else {
+    console.log(chalk.yellow(`  ${inconsistentDeps.length} inconsistent dependencies found:`));
+    inconsistentDeps.forEach(arr => console.log(`    ${arr.join(' vs ')}`));
+    exitCode = 0;
+  }
+}
 
+function retrieveDependencyMapFromPackageSource(packageName) {
   const allSources = glob.sync(path.join(__dirname, '../../packages/', packageName, '**/*'))
     .filter(p => p.match(/\.(js|ts)$/))
     .filter(p => !p.match(/\.spec\./))
     .filter(p => !p.match(/\/blueprints\//));
 
-  const importMap = {};
-  allSources.forEach(function(filePath) {
+  return allSources.reduce(function (importMap, filePath) {
     const source = fs.readFileSync(filePath, 'utf8');
 
     listImportedModules(source)
       .forEach(modulePath => importMap[modulePath] = true);
     listRequiredModules(source)
       .forEach(modulePath => importMap[modulePath] = true);
-  });
 
-  const dependencies = Object.keys(importMap)
-    // Filter out the node packages that should not be depended on.
-    .filter(x => NODE_PACKAGES.indexOf(x) == -1);
-  overallDeps.push(...dependencies);
+    return importMap;
+  }, {});
+}
+
+function validateDependenciesPerPackage(packages) {
+  const allSourceDeps = [];
+  const allDeclaredDepsMap = {};
+
+  for (const packageName of Object.keys(packages)) {
+    console.log(chalk.blue(`Reading dependencies of "${packageName}".`));
 
-  console.log(chalk.green(`  found ${dependencies.length} dependencies...`));
-  const packageJson = JSON.parse(fs.readFileSync(packages[packageName].packageJson, 'utf8'));
-  const allDeps = []
-    .concat(Object.keys(packageJson['dependencies'] || {}))
-    .concat(Object.keys(packageJson['devDependencies'] || {}))
-    .concat(Object.keys(packageJson['peerDependencies'] || {}));
+    const importMap = retrieveDependencyMapFromPackageSource(packageName)
 
-  const missingDeps = dependencies.filter(d => allDeps.indexOf(d) == -1);
-  reportMissingDependencies(missingDeps);
+    const dependencies = Object.keys(importMap)
+      // Filter out the node packages that should not be depended on.
+      .filter(x => NODE_PACKAGES.indexOf(x) == -1);
+    allSourceDeps.push(...dependencies);
 
-  const overDeps = allDeps.filter(d => dependencies.indexOf(d) == -1)
-    .filter(x => ANGULAR_PACKAGES.indexOf(x) == -1);
-  reportExcessiveDependencies(overDeps);
+    console.log(chalk.green(`  found ${dependencies.length} dependencies...`));
 
-  console.log('');
+    const packageJson = JSON.parse(fs.readFileSync(packages[packageName].packageJson, 'utf8'));
+
+    const DeclaredDepsMap = Object.assign(
+      {},
+      packageJson['dependencies'] || {},
+      packageJson['devDependencies'] || {},
+      packageJson['peerDependencies'] || {}
+    );
+    allDeclaredDepsMap[packageName] = DeclaredDepsMap;
+    const declaredDeps = Object.keys(DeclaredDepsMap);
+
+    const missingDeps = dependencies.filter(d => declaredDeps.indexOf(d) === -1);
+    reportMissingDependencies(missingDeps);
+
+    const excessiveDeps = declaredDeps.filter(d => dependencies.indexOf(d) === -1)
+      .filter(x => ANGULAR_PACKAGES.indexOf(x) === -1);
+    reportExcessiveDependencies(excessiveDeps);
+  }
+
+  return {
+    allDeclaredDepsMap,
+    allSourceDeps
+  };
 }
 
-console.log(chalk.green('Validating root package. [devDependencies ignored]'));
-const rootPackagePath = path.join(__dirname, '../../package.json');
-const rootPackageJson = JSON.parse(fs.readFileSync(rootPackagePath, 'utf8'));
-// devDependencies are ignored
-const allRootDeps = []
+function validateRootPackageJson(overallDeps) {
+  console.log(chalk.blue('Validating root package. [devDependencies ignored]'));
+
+  const rootPackagePath = path.join(__dirname, '../../package.json');
+  const rootPackageJson = JSON.parse(fs.readFileSync(rootPackagePath, 'utf8'));
+
+  // devDependencies are ignored
+  const allRootDeps = []
     .concat(Object.keys(rootPackageJson['dependencies'] || {}))
     .concat(Object.keys(rootPackageJson['peerDependencies'] || {}));
 
-const internalPackages = Object.keys(packages);
-const missingRootDeps = overallDeps.filter(d => allRootDeps.indexOf(d) == -1)
-  .filter(d => internalPackages.indexOf(d) == -1);
-reportMissingDependencies(missingRootDeps);
+  const internalPackages = Object.keys(packages);
+  const missingRootDeps = overallDeps.filter(d => allRootDeps.indexOf(d) === -1)
+    .filter(d => internalPackages.indexOf(d) === -1);
+  reportMissingDependencies(missingRootDeps);
 
-const overRootDeps = allRootDeps.filter(d => overallDeps.indexOf(d) == -1)
-  .filter(x => ANGULAR_PACKAGES.indexOf(x) == -1);
-reportExcessiveDependencies(overRootDeps);
+  const overRootDeps = allRootDeps.filter(d => overallDeps.indexOf(d) === -1)
+    .filter(x => ANGULAR_PACKAGES.indexOf(x) === -1);
+  reportExcessiveDependencies(overRootDeps);
+}
 
-process.exit(exitCode);
+function checkDependenciesConflictAcrossPackages(allDeclaredDepsMap) {
+  console.log(chalk.blue('Validating packages\' dependencies conflict.'));
+
+  const allDeclaredDeps = Object.keys(allDeclaredDepsMap)
+    .reduce((collect, packageName) => collect.concat(Object.keys(allDeclaredDepsMap[packageName])), []);
+
+  const inconsistentDeps = _.uniq(allDeclaredDeps).reduce(function (collect, dep) {
+    const test = _(allDeclaredDepsMap)
+      .map((map, name) => map[dep] ? [name, `${dep}@${map[dep]}`] : null)
+      .compact()
+      .uniqBy(1)
+      .value();
+    if (test.length > 1) {
+      collect.push(test.map(pair =>`[${pair[0]}]: ${pair[1]}`));
+    }
+
+    return collect;
+  }, []);
+
+  reportInconsistentDepsDependencies(inconsistentDeps);
+}