fix: relative module with ../ (#34)

* fix: relative module with ../

* feat: formatter module not found separate dependencies and relative modules

Author: christophehurpeau

src/formatters/moduleNotFound.js

@@ -1,14 +1,22 @@
 'use strict';
 const concat = require('../utils').concat;
 
-function moduleNotFound (count) {
-  if (count === 1) {
-    return 'This module was not found:';
-  }
+function isRelative (module) {
+  return module.startsWith('./') || module.startsWith('../');
+}
 
-  return 'These modules were not found:';
+function formatFileList (files) {
+  const length = files.length;
+  if (!length) return '';
+  return ` in ${files[0]}${files[1] ? `, ${files[1]}` : ''}${length > 2 ? ` and ${length - 2} other${length === 3 ? '' : 's'}` : ''}`;
 }
 
+function formatGroup (group) {
+  const files = group.errors.map(e => e.file).filter(Boolean);
+  return `* ${group.module}${formatFileList(files)}`;
+}
+
+
 function forgetToInstall (missingDependencies) {
   const moduleNames = missingDependencies.map(missingDependency => missingDependency.module);
 
@@ -19,8 +27,26 @@ function forgetToInstall (missingDependencies) {
   return `To install them, you can run: npm install --save ${moduleNames.join(' ')}`;
 }
 
-function isRelative (module) {
-  return module.startsWith('./');
+function dependenciesNotFound (dependencies) {
+  if (dependencies.length === 0) return;
+
+  return concat(
+    dependencies.length === 1 ? 'This dependency was not found:' : 'These dependencies were not found:',
+    '',
+    dependencies.map(formatGroup),
+    '',
+    forgetToInstall(dependencies),
+  );
+}
+
+function relativeModulesNotFound (modules) {
+  if (modules.length === 0) return;
+
+  return concat(
+    modules.length === 1 ? 'This relative module was not found:' : 'These relative modules were not found:',
+    '',
+    modules.map(formatGroup),
+  );
 }
 
 function groupModules (errors) {
@@ -40,33 +66,20 @@ function groupModules (errors) {
   }));
 }
 
-function formatFileList (files) {
-  const length = files.length;
-  if (!length) return '';
-  return ` in ${files[0]}${files[1] ? `, ${files[1]}` : ''}${length > 2 ? ` and ${length - 2} other${length === 3 ? '' : 's'}` : ''}`;
-}
-
-function formatGroup (group) {
-  const files = group.errors.map(e => e.file).filter(Boolean);
-  return `* ${group.module}${formatFileList(files)}`;
-}
-
 function formatErrors (errors) {
   if (errors.length === 0) {
     return [];
   }
 
   const groups = groupModules(errors);
-  const missingDependencies = groups.filter(group => !group.relative);
+
+  const dependencies = groups.filter(group => !group.relative);
+  const relativeModules = groups.filter(group => group.relative);
 
   return concat(
-    moduleNotFound(errors.length),
-    '',
-    groups.map(formatGroup),
-    missingDependencies.length === 0 ? undefined : [
-      '',
-      forgetToInstall(missingDependencies)
-    ]
+    dependenciesNotFound(dependencies),
+    dependencies.length && relativeModules.length ? ['', ''] : null,
+    relativeModulesNotFound(relativeModules),
   );
 }
 

test/fixtures/module-errors/index.js

@@ -1,2 +1,3 @@
 require('not-found');
-require('./non-existing');
+require('./non-existing');
+require('../non-existing');

test/integration.spec.js

@@ -45,14 +45,19 @@ it('integration : module-errors', async() => {
   const logs = await executeAndGetLogs('./fixtures/module-errors/webpack.config.js');
 
   expect(logs).toEqual([
-    'ERROR  Failed to compile with 2 errors',
+    'ERROR  Failed to compile with 3 errors',
     '',
-    'These modules were not found:',
+    'This dependency was not found:',
     '',
-    '* ./non-existing in ./test/fixtures/module-errors/index.js',
     '* not-found in ./test/fixtures/module-errors/index.js',
     '',
-    'To install it, you can run: npm install --save not-found'
+    'To install it, you can run: npm install --save not-found',
+    '',
+    '',
+    'These relative modules were not found:',
+    '',
+    '* ./non-existing in ./test/fixtures/module-errors/index.js',
+    '* ../non-existing in ./test/fixtures/module-errors/index.js',
   ]);
 });
 
@@ -123,11 +128,15 @@ it('integration : webpack multi compiler : module-errors', async() => {
   expect(logs).toEqual([
     'ERROR  Failed to compile with 2 errors',
     '',
-    'These modules were not found:',
+    'This dependency was not found:',
     '',
-    '* ./non-existing in ./test/fixtures/multi-compiler-module-errors/index.js',
     '* not-found in ./test/fixtures/multi-compiler-module-errors/index2.js',
     '',
-    'To install it, you can run: npm install --save not-found'
+    'To install it, you can run: npm install --save not-found',
+    '',
+    '',
+    'This relative module was not found:',
+    '',
+    '* ./non-existing in ./test/fixtures/multi-compiler-module-errors/index.js',
   ]);
 });

test/unit/formatters/moduleNotFound.spec.js

@@ -4,7 +4,7 @@ const expect = require('expect');
 it('Formats module-not-found errors', () => {
   const error = { type: 'module-not-found', module: 'redux' };
   expect(moduleNotFound([error])).toEqual([
-    'This module was not found:',
+    'This dependency was not found:',
     '',
     '* redux',
     '',
@@ -16,7 +16,7 @@ it('Groups all module-not-found into one', () => {
   const reduxError = { type: 'module-not-found', module: 'redux' };
   const reactError = { type: 'module-not-found', module: 'react' };
   expect(moduleNotFound([reduxError, reactError])).toEqual([
-    'These modules were not found:',
+    'These dependencies were not found:',
     '',
     '* redux',
     '* react',
@@ -28,12 +28,12 @@ it('Groups all module-not-found into one', () => {
 it('Groups same module in module-not-found with 2 files', () => {
   const reduxError = { type: 'module-not-found', module: 'redux' };
   const reactError1 = { type: 'module-not-found', module: 'react', file: './src/file1.js' };
-  const reactError2 = { type: 'module-not-found', module: 'react', file: './src/file2.js' };
+  const reactError2 = { type: 'module-not-found', module: 'react', file: '../src/file2.js' };
   expect(moduleNotFound([reduxError, reactError1, reactError2])).toEqual([
-    'These modules were not found:',
+    'These dependencies were not found:',
     '',
     '* redux',
-    '* react in ./src/file1.js, ./src/file2.js',
+    '* react in ./src/file1.js, ../src/file2.js',
     '',
     'To install them, you can run: npm install --save redux react'
   ]);
@@ -45,7 +45,7 @@ it('Groups same module in module-not-found with 3 files', () => {
   const reactError2 = { type: 'module-not-found', module: 'react', file: './src/file2.js' };
   const reactError3 = { type: 'module-not-found', module: 'react', file: './src/file3.js' };
   expect(moduleNotFound([reduxError, reactError1, reactError2, reactError3])).toEqual([
-    'These modules were not found:',
+    'These dependencies were not found:',
     '',
     '* redux',
     '* react in ./src/file1.js, ./src/file2.js and 1 other',
@@ -61,7 +61,7 @@ it('Groups same module in module-not-found with 4 files', () => {
   const reactError3 = { type: 'module-not-found', module: 'react', file: './src/file3.js' };
   const reactError4 = { type: 'module-not-found', module: 'react', file: './src/file4.js' };
   expect(moduleNotFound([reduxError, reactError1, reactError2, reactError3, reactError4])).toEqual([
-    'These modules were not found:',
+    'These dependencies were not found:',
     '',
     '* redux',
     '* react in ./src/file1.js, ./src/file2.js and 2 others',