use the ignore npm package

Author: GrantBirki

__tests__/fixtures/exclude/exclude.txt

@@ -17,4 +17,4 @@ dog.txt
 !dog.txt
 
 # test with a regex pattern match
-/^.*cars.*\.txt$/
+*cars*.txt

__tests__/functions/exclude.test.js

@@ -1,12 +1,12 @@
 import * as core from '@actions/core'
 import {Exclude} from '../../src/functions/exclude'
 
-const debugMock = jest.spyOn(core, 'debug').mockImplementation(() => {})
 const warningMock = jest.spyOn(core, 'warning').mockImplementation(() => {})
 
 var exclude
 beforeEach(() => {
   jest.clearAllMocks()
+  jest.spyOn(core, 'debug').mockImplementation(() => {})
   process.env.INPUT_EXCLUDE_FILE = '__tests__/fixtures/exclude/exclude.txt'
   process.env.INPUT_GIT_IGNORE_PATH = '.gitignore'
   process.env.INPUT_USE_GITIGNORE = 'true'
@@ -15,60 +15,28 @@ beforeEach(() => {
 
 test('successfully excludes a file', () => {
   expect(exclude.isExcluded('exclude-me.json')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file exactly matches exclude pattern: exclude-me.json`
-  )
 })
 
 test('successfully excludes a with a glob match', () => {
   expect(exclude.isExcluded('src/dev/app/nope.exclude')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file matches exclude glob pattern: *.exclude`
-  )
-})
-
-test('successfully does not exclude a negate pattern match', () => {
-  expect(exclude.isExcluded('cat.txt')).toBe(false)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file matches exclude negation pattern: !cat.txt`
-  )
-})
-
-test('successfully excludes a file where the negate pattern matches after', () => {
-  expect(exclude.isExcluded('dog.txt')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file exactly matches exclude pattern: dog.txt`
-  )
 })
 
 test('successfully excludes with a regex pattern match', () => {
   expect(exclude.isExcluded('src/app/cars-and-a-bus.txt')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file matches exclude regex pattern: /^.*cars.*\\.txt$/`
-  )
 })
 
 test('successfully excludes a file in a dir one level down', () => {
-  expect(exclude.isExcluded('./evil-base-dir/exclude-me.json')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file is in exclude directory: evil-base-dir/`
-  )
+  expect(exclude.isExcluded('evil-base-dir/exclude-me.json')).toBe(true)
 })
 
 test('successfully excludes a file in a dir two levels down', () => {
-  expect(exclude.isExcluded('./evil-base-dir/sub-dir/exclude-me.json')).toBe(
+  expect(exclude.isExcluded('evil-base-dir/sub-dir/exclude-me.json')).toBe(
     true
   )
-  expect(debugMock).toHaveBeenCalledWith(
-    `file is in exclude directory: evil-base-dir/`
-  )
 })
 
 test('successfully checks a file and finds that it is not excluded', () => {
   expect(exclude.isExcluded('exclude-me-nope.json')).toBe(false)
-  expect(debugMock).toHaveBeenCalledWith(
-    `file 'exclude-me-nope.json' did not match any exclude patterns`
-  )
 })
 
 test('does not exclude any files when no exclude file is used', () => {
@@ -82,7 +50,6 @@ test('excludes a file that is not tracked by git', () => {
   process.env.INPUT_EXCLUDE_FILE = ''
   const exclude = new Exclude()
   expect(exclude.isExcluded('tmp/test.json')).toBe(true)
-  expect(debugMock).toHaveBeenCalledWith(`file is in exclude directory: tmp/`)
 })
 
 test('fails to read the .gitignore file', () => {

src/functions/exclude.js

@@ -1,50 +1,33 @@
 import * as core from '@actions/core'
 import {readFileSync} from 'fs'
+import ignore from 'ignore'
 
 export class Exclude {
   constructor() {
     this.path = core.getInput('exclude_file')
     this.gitTrackedOnly = core.getBooleanInput('use_gitignore')
 
     // initialize the exclude array
-    this.exclude = []
+    this.ignore = ignore()
 
     // read the exclude file if it was used
     if (this.path && this.path !== '') {
       core.debug(`loading exclude_file: ${this.path}`)
-
-      this.exclude = readFileSync(this.path, 'utf8')
-      // split the exclude file into an array of strings and trim each string
-      this.exclude = this.exclude.split('\n').map(item => item.trim())
-      // remove any empty strings
-      this.exclude = this.exclude.filter(item => item !== '')
-      // remove any comments
-      this.exclude = this.exclude.filter(item => !item.startsWith('#'))
-
-      core.debug(`loaded exclude patterns: ${this.exclude}`)
+      this.ignore.add(readFileSync(this.path, 'utf8').toString())
+      core.debug(`loaded custom exclude patterns`)
     }
 
     // if gitTrackOnly is true, add the git exclude patterns from the .gitignore file if it exists
     if (this.gitTrackedOnly) {
       core.debug(
-        `use_gitignore: ${this.gitTrackedOnly} - only using git tracked files`
+        `use_gitignore: ${this.gitTrackedOnly}`
       )
 
       const gitIgnorePath = core.getInput('git_ignore_path')
-      var gitIgnoreExclude = []
-      try {
-        const gitIgnore = readFileSync(gitIgnorePath, 'utf8')
-        // split the git ignore file into an array of strings and trim each string
-        const gitIgnorePatterns = gitIgnore.split('\n').map(item => item.trim())
-        // remove any empty strings
-        gitIgnoreExclude = gitIgnorePatterns.filter(item => item !== '')
-        // remove any comments
-        gitIgnoreExclude = gitIgnoreExclude.filter(
-          item => !item.startsWith('#')
-        )
+      core.debug(`loading .gitignore file from path: ${gitIgnorePath}`)
 
-        // add the git ignore patterns to the exclude patterns
-        this.exclude = this.exclude.concat(gitIgnoreExclude)
+      try {
+        this.ignore.add(readFileSync(gitIgnorePath).toString())
       } catch (error) {
         core.warning(`error reading .gitignore file: ${error}`)
       }
@@ -54,62 +37,7 @@ export class Exclude {
   isExcluded(file) {
     // use .gitignore style matching
     // https://git-scm.com/docs/gitignore
-
-    if (this.exclude.length === 0) {
-      return false
-    }
-
-    // remove the leading ./ if it exists
-    if (file.startsWith('./')) {
-      file = file.replace('./', '')
-    }
-
-    // loop through each exclude pattern
-    for (const pattern of this.exclude) {
-      // if the file exactly matches the pattern, return true
-      if (file === pattern) {
-        core.debug(`file exactly matches exclude pattern: ${pattern}`)
-        return true
-      }
-
-      // if the pattern is a negation, check if the file matches the negation
-      if (pattern.startsWith('!')) {
-        const regex = new RegExp(pattern.replace(/^!/, ''))
-        if (file.match(regex)) {
-          core.debug(`file matches exclude negation pattern: ${pattern}`)
-          return false
-        }
-      }
-
-      // if the pattern is a directory, check if the file is in that directory
-      if (pattern.endsWith('/')) {
-        if (file.startsWith(pattern)) {
-          core.debug(`file is in exclude directory: ${pattern}`)
-          return true
-        }
-      }
-
-      // if the pattern is a glob, check if the file matches the glob
-      if (pattern.includes('*')) {
-        const regex = new RegExp(pattern.replace(/\*/g, '.*'))
-        if (file.match(regex)) {
-          core.debug(`file matches exclude glob pattern: ${pattern}`)
-          return true
-        }
-      }
-
-      // if the pattern is a regex, check if the file matches the regex
-      if (pattern.startsWith('/') && pattern.endsWith('/')) {
-        const regex = new RegExp(pattern.replace(/\//g, ''))
-        if (file.match(regex)) {
-          core.debug(`file matches exclude regex pattern: ${pattern}`)
-          return true
-        }
-      }
-    }
-
-    // if the file did not match any exclude patterns, return false
-    core.debug(`file '${file}' did not match any exclude patterns`)
-    return false
+    // https://github.com/kaelzhang/node-ignore
+    return this.ignore.ignores(file)
   }
 }