New: WIP add eslintIgnore support to package.json (fixes #8458)

Added tests for when eslintignore file exists and doesn't exist Abstracted the findFile function for finding ignore file and package.json
eslint · Jun 7, 2017 · e0a0368 · e0a0368
1 parent 42cc83a
commit e0a0368
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 13 deletions.
diff --git a/lib/ignored-paths.js b/lib/ignored-paths.js
@@ -48,31 +48,36 @@ const DEFAULT_OPTIONS = {
 // Helpers
 //------------------------------------------------------------------------------
 
-
 /**
- * Find an ignore file in the current directory.
+ * Find a file in the current directory.
  * @param {string} cwd Current working directory
+ * @param {string} name File name
  * @returns {string} Path of ignore file or an empty string.
  */
-function findIgnoreFile(cwd) {
+function findFile(cwd, name) {
     cwd = cwd || DEFAULT_OPTIONS.cwd;
 
-    const ignoreFilePath = path.resolve(cwd, ESLINT_IGNORE_FILENAME);
+    const ignoreFilePath = path.resolve(cwd, name);
 
     return fs.existsSync(ignoreFilePath) && fs.statSync(ignoreFilePath).isFile() ? ignoreFilePath : "";
 }
 
+/**
+ * Find an ignore file in the current directory.
+ * @param {string} cwd Current working directory
+ * @returns {string} Path of ignore file or an empty string.
+ */
+function findIgnoreFile(cwd) {
+    return findFile(cwd, ESLINT_IGNORE_FILENAME);
+}
+
 /**
  * Find an package.json file in the current directory.
  * @param {string} cwd Current working directory
  * @returns {string} Path of package.json file or an empty string.
  */
 function findPackageJSONFile(cwd) {
-    cwd = cwd || DEFAULT_OPTIONS.cwd;
-
-    const ignoreFilePath = path.resolve(cwd, ESLINT_PACKAGE_JSON);
-
-    return fs.existsSync(ignoreFilePath) && fs.statSync(ignoreFilePath).isFile() ? ignoreFilePath : "";
+    return findFile(cwd, ESLINT_PACKAGE_JSON);
 }
 
 /**
@@ -146,7 +151,7 @@ class IgnoredPaths {
         addPattern(this.ig.default, this.defaultPatterns);
 
         if (options.ignore !== false) {
-            let ignorePath, packageJSONPath;
+            let ignorePath;
 
             if (options.ignorePath) {
                 debug("Using specific ignore file");
@@ -180,7 +185,8 @@ class IgnoredPaths {
                 try {
 
                     // if the ignoreFile does not exist, check package.json for eslintIgnore
-                    packageJSONPath = findPackageJSONFile(options.cwd);
+                    const packageJSONPath = findPackageJSONFile(options.cwd);
+
                     if (packageJSONPath) {
                         const configOptions = config.load(packageJSONPath, configContext);
 
@@ -192,7 +198,7 @@ class IgnoredPaths {
                         }
                     }
                 } catch (e) {
-                    debug("Could not find eslintIgnore in package.json");
+                    debug("Could not find package.json to check eslintIgnore property");
                 }
             }
 

diff --git a/tests/fixtures/ignored-paths/package.json b/tests/fixtures/ignored-paths/package.json
@@ -0,0 +1,11 @@
+{
+    "name": "mypackage",
+    "version": "0.0.1",
+    "eslintConfig": {
+        "env": {
+            "browser": true,
+            "node": true
+        },
+        "eslintIgnore": ["hello.js", "world.js"]
+    }
+}
diff --git a/tests/lib/ignored-paths.js b/tests/lib/ignored-paths.js
@@ -165,12 +165,19 @@ describe("IgnoredPaths", () => {
             );
         });
 
-        it("should load package.json's array of files to ignore in eslintIgnore", () => {
+        it("should load package.json's eslintIgnore files if no specified ignore file", () => {
             const ignoredPaths = new IgnoredPaths({ ignore: true, cwd: getFixturePath("package-json-ignore") });
 
             assert.isTrue(ignoredPaths.contains("hello.js"));
             assert.isTrue(ignoredPaths.contains("world.js"));
         });
+
+        it("should not load package.json's eslintIgnore files if specified ignore file", () => {
+            const ignoredPaths = new IgnoredPaths({ ignore: true, cwd: getFixturePath() });
+
+            assert.isFalse(ignoredPaths.contains("hello.js"));
+            assert.isFalse(ignoredPaths.contains("world.js"));
+        });
     });
 
     describe("initialization with ignorePattern", () => {