feat(ignorefiles): add consistency to the ignorefiles that are respected

dhis2 · Dec 16, 2019 · fdba06e · fdba06e
1 parent 7a3d12d
commit fdba06e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/src/tools/eslint.js b/src/tools/eslint.js
@@ -1,13 +1,16 @@
 const { run } = require('../utils/run.js')
+const { resolveIgnoreFile } = require('../utils/files.js')
 
 exports.eslint = ({ files = [], apply = false, config }) => {
+    const ignoreFile = resolveIgnoreFile()
     const cmd = 'npx'
     const args = [
         '--no-install',
         'eslint',
         '--no-color',
         '--report-unused-disable-directives',
         '--ignore',
+        ...(ignoreFile ? ['--ignore-path', ignoreFile] : []),
         ...(config ? ['--config', config] : []),
         ...(apply ? ['--fix'] : []),
         ...files,

diff --git a/src/tools/prettier.js b/src/tools/prettier.js
@@ -1,13 +1,17 @@
-const { run } = require('../utils/run.js')
 const log = require('@dhis2/cli-helpers-engine').reporter
 
+const { run } = require('../utils/run.js')
+const { resolveIgnoreFile } = require('../utils/files.js')
+
 exports.prettier = ({ files = [], apply = false, config }) => {
+    const ignoreFile = resolveIgnoreFile()
     const cmd = 'npx'
     const args = [
         '--no-install',
         'prettier',
         '--list-different',
         ...(config ? ['--config', config] : []),
+        ...(ignoreFile ? ['--ignore-path', ignoreFile] : []),
         ...(apply ? ['--write'] : []),
         ...files,
     ]

diff --git a/src/utils/files.js b/src/utils/files.js
@@ -1,10 +1,11 @@
 const fg = require('fast-glob')
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 
 const log = require('@dhis2/cli-helpers-engine').reporter
 
 const { spawn } = require('./run.js')
+const { CONSUMING_ROOT } = require('./paths.js')
 
 // blacklists for files
 const blacklist = [
@@ -151,6 +152,30 @@ const stagedFiles = (files = []) => {
     return []
 }
 
+const pickFirstExists = (files = [], root) => {
+    for (const file of files) {
+        const fp = root
+            ? path.join(root, file)
+            : path.join(CONSUMING_ROOT, file)
+
+        if (fs.existsSync(fp)) {
+            log.debug(`Using ${fp} as the common ignore file.`)
+            return fp
+        }
+    }
+
+    return null
+}
+
+const resolveIgnoreFile = () => {
+    return pickFirstExists([
+        '.d2styleignore',
+        '.eslintignore',
+        '.prettierignore',
+        '.gitignore',
+    ])
+}
+
 module.exports = {
     collectFiles,
     collectAllFiles,
@@ -166,4 +191,6 @@ module.exports = {
     whitelisted,
     whitelists,
     blacklist,
+    pickFirstExists,
+    resolveIgnoreFile,
 }