Merge pull request #25 from GrantBirki/debug-improvements

debug improvements

Author: GrantBirki

__tests__/functions/exclude.test.js

@@ -76,7 +76,6 @@ test('does not exclude any files when no exclude file is used', () => {
   process.env.INPUT_USE_GITIGNORE = 'false'
   const exclude = new Exclude()
   expect(exclude.isExcluded('exclude-me.json')).toBe(false)
-  expect(debugMock).not.toHaveBeenCalled()
 })
 
 test('excludes a file that is not tracked by git', () => {

dist/index.js

@@ -11,17 +11,25 @@ export class Exclude {
 
     // 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}`)
     }
 
     // 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`
+      )
+
       const gitIgnorePath = core.getInput('git_ignore_path')
       var gitIgnoreExclude = []
       try {

dist/index.js.map

@@ -76,10 +76,14 @@ export async function jsonValidator(exclude) {
     ? `**/*{${jsonExtension},${yamlGlob}}`
     : `**/*${jsonExtension}`
 
+  core.debug(`using baseDir: ${baseDirSanitized}`)
+  core.debug(`using glob: ${glob}`)
+
   const files = globSync(glob, {cwd: baseDirSanitized, dot: useDotMatch})
   for (const file of files) {
     // construct the full path to the file
     const fullPath = `${baseDirSanitized}/${file}`
+    core.debug(`found file: ${fullPath}`)
 
     if (jsonSchema !== '' && fullPath.includes(jsonSchema)) {
       // skip the jsonSchema file and don't count it as a skipped file
@@ -103,7 +107,6 @@ export async function jsonValidator(exclude) {
     }
 
     var data
-
     try {
       // try to parse the file
       if (fullPath.endsWith('.yaml')) {

src/functions/exclude.js

@@ -31,16 +31,20 @@ export async function yamlValidator(exclude) {
     skipped: 0,
     violations: []
   }
-  const files = globSync(
-    `**/*.{${yamlExtension.replace('.', '')},${yamlExtensionShort.replace(
-      '.',
-      ''
-    )}}`,
-    {cwd: baseDirSanitized, dot: useDotMatch}
-  )
+
+  const glob = `**/*.{${yamlExtension.replace(
+    '.',
+    ''
+  )},${yamlExtensionShort.replace('.', '')}}`
+
+  core.debug(`using baseDir: ${baseDirSanitized}`)
+  core.debug(`using glob: ${glob}`)
+
+  const files = globSync(glob, {cwd: baseDirSanitized, dot: useDotMatch})
   for (const file of files) {
     // construct the full path to the file
     const fullPath = `${baseDirSanitized}/${file}`
+    core.debug(`found file: ${fullPath}`)
 
     if (yamlSchema !== '' && fullPath.includes(yamlSchema)) {
       core.debug(`skipping yaml schema file: ${fullPath}`)