feat: add .reference-ignore file support (#41)

This also fixes a small regex error where `-` in the repo name was not matched. Further, the output markdown of the opened issue got improved.

Author: zepatrik

.github/workflows/release-tagger.yml

@@ -103,3 +103,5 @@ typings/
 
 # TernJS port file
 .tern-port
+
+dist

.gitignore

@@ -0,0 +1,2 @@
+dist*
+src/*.test.ts

.reference-ignore

@@ -48,6 +48,9 @@ All other inputs are optional.
 | issueLabels | the labels to create issues with, comma seperated list         | closed reference |
 | issueLimit  | the maximum number of issues to create, supposed to catch bugs | 5                |
 
+Additionally to setting `ignore` as an input, you can also place a `.reference-ignore` file in the root of your repo (entries should be `\n` separated).
+Both, the input and the file will be concatenated.
+
 Note that the action fails when there are more issues to be created than the limit allows. This is because GitHub Actions
 do not have manual approval.
 

README.md

@@ -3,15 +3,16 @@
   "version": "1.1.0",
   "description": "A GitHub action to open an issue when GitHub references in your code are closed.",
   "bin": "distCli/index.js",
+  "prettier": "ory-prettier-styles",
   "scripts": {
     "build": "npm-run-all build:*",
     "build:cli": "ncc build src/runInCli.ts -o distCli && echo -e \"#!/usr/bin/env node\\n$(cat distCli/index.js)\" > distCli/index.js",
     "build:action": "ncc build src/runInAction.ts -o distAction",
     "watch": "tsc -w",
     "test": "jest",
     "test:watch": "jest --watch",
-    "format": "prettier --single-quote --no-semi --trailing-comma none --write '{src/*.ts,*.md}'",
-    "format:check": "prettier --check --single-quote --no-semi --trailing-comma none '{src/*.ts,*.md}'"
+    "format": "prettier --write '{src/*.ts,*.md}'",
+    "format:check": "prettier --check '{src/*.ts,*.md}'"
   },
   "repository": {
     "type": "git",
@@ -36,6 +37,7 @@
     "@actions/core": "^1.2.6",
     "@actions/github": "^2.1.1",
     "ignore": "^5.1.4",
+    "ory-prettier-styles": "^1.0.1",
     "walkdir": "^0.4.1"
   }
 }

package-lock.json

@@ -17,6 +17,8 @@ import { GitHub } from '@actions/github'
 import { Octokit } from '@octokit/rest'
 import ignore, { Ignore } from 'ignore'
 import { Reference } from './mainRunner'
+import * as fs from 'fs'
+import * as path from 'path'
 
 let client: GitHub
 const getClient = () => client || (client = new GitHub(getInput('token')))
@@ -31,10 +33,13 @@ export const issueBody = (
   thisRepo: string,
   foundIn: Reference['foundIn']
 ) =>
-  `The upstream [${type}](https://${upstreamReference}) got closed. It is referenced in: ${foundIn.map(
-    ([file, line]) =>
-      `[${file}#L${line}](https://github.com/${thisOwner}/${thisRepo}/blob/master/${file}#L${line})`
-  )}`
+  `The upstream [${type}](https://${upstreamReference}) got closed. It is referenced in:
+- [ ] ${foundIn
+    .map(
+      ([file, line]) =>
+        `[${file}#L${line}](https://github.com/${thisOwner}/${thisRepo}/blob/master/${file}#L${line})`
+    )
+    .join('\n- [ ] ')}`
 
 export const createIssue = (params: Octokit.IssuesCreateParams) =>
   getClient()
@@ -88,6 +93,21 @@ export const issueIsClosed = (reference: Reference): Promise<boolean> => {
     .then((issue) => issue.data.state === 'closed')
 }
 
+export const readIgnoreFiles = (dir: string = '.'): Promise<string[]> =>
+  Promise.allSettled(
+    ['.reference-ignore', '.gitignore'].map((fn) =>
+      fs.promises.readFile(path.join(dir, fn))
+    )
+  ).then((files) =>
+    files
+      .filter<PromiseFulfilledResult<Buffer>>(
+        (file): file is PromiseFulfilledResult<Buffer> =>
+          file.status === 'fulfilled'
+      )
+      .map((fulFilled) => fulFilled.value.toString().split('\n'))
+      .flat(1)
+  )
+
 export default {
   issueExists,
   exitWithReason,

package.json

@@ -39,19 +39,20 @@ const mockDependencies = ({
 })
 
 const createFiles = (dirPath: string, files: { [path: string]: string }) =>
-  Promise.all(
-    Object.entries(files).map(([name, data]) =>
-      fs.promises
-        .mkdir(path.dirname(path.join(dirPath, name)), { recursive: true })
-        .then(() => fs.promises.writeFile(path.join(dirPath, name), data))
-    )
-  )
+  Object.entries(files).forEach(([name, data]) => {
+    const filePath = path.join(dirPath, name)
+    fs.mkdirSync(path.dirname(filePath), { recursive: true })
+    fs.writeFileSync(filePath, data)
+  })
 
 const expectCreated = (
   deps: ReturnType<typeof mockDependencies>,
   created: string[],
   notCreated: string[]
 ) => {
+  if (deps.exitWithReason.mock.calls.length != 0) {
+    console.log(deps.exitWithReason.mock.calls)
+  }
   expect(deps.exitWithReason).toBeCalledTimes(0)
   expect(deps.createIssue).toBeCalledTimes(created.length)
   expect(deps.issueIsClosed).toBeCalledTimes(created.length + notCreated.length)
@@ -90,16 +91,16 @@ const expectFail = (
 describe('mainRunner works', () => {
   let dir: string
 
-  beforeEach(async () => {
-    await fs.promises.mkdtemp('test').then((path) => (dir = path))
-    await createFiles(dir, {
+  beforeEach(() => {
+    dir = fs.mkdtempSync('test')
+    createFiles(dir, {
       'src/index.js': 'github.com/testUser/testRepo/issues/1337',
       'foo.txt': 'github.com/testUser/testRepo/pull/42'
     })
   })
 
-  afterEach(async () => {
-    await fs.promises.rmdir(dir, { recursive: true })
+  afterEach(() => {
+    fs.rmdirSync(dir, { recursive: true })
   })
 
   it('should create issues for closed references', async () => {
@@ -212,7 +213,7 @@ describe('mainRunner works', () => {
       path: dir,
       issueLimit: 2
     })
-    await createFiles(dir, {
+    createFiles(dir, {
       'bar.txt': 'github.com/testUser/testRepo/pull/42'
     })
     await mainRunner(deps)
@@ -231,4 +232,29 @@ describe('mainRunner works', () => {
       ['foo.txt', 1]
     ])
   })
+
+  it('should find multiple references in one file', async () => {
+    const deps = mockDependencies({
+      issueExists: false,
+      referenceClosed: true,
+      path: dir,
+      issueLimit: 4
+    })
+    createFiles(dir, {
+      'bar.txt':
+        'github.com/testUser/testRepo/pull/420\ngithub.com/ory/closed-reference-notifier/issues/13'
+    })
+    await mainRunner(deps)
+
+    expectCreated(
+      deps,
+      [
+        'github.com/testUser/testRepo/pull/42',
+        'github.com/testUser/testRepo/issues/1337',
+        'github.com/testUser/testRepo/pull/420',
+        'github.com/ory/closed-reference-notifier/issues/13'
+      ],
+      []
+    )
+  })
 })

src/helpers.ts

@@ -17,7 +17,7 @@ import fs from 'fs'
 import walkdir from 'walkdir'
 import path from 'path'
 
-const referenceRegex = /github\.com\/([a-zA-Z\d-]+)\/([a-zA-Z\d.-_]+)\/(pull|issues)\/(\d+)/gm
+const referenceRegex = /github\.com\/([a-zA-Z\d-]+)\/([a-zA-Z\d._-]+)\/(pull|issues)\/(\d+)/gm
 
 export type Dependencies = typeof helpers & {
   labels: Array<string>

src/mainRunner.test.ts

@@ -14,8 +14,7 @@
 
 import { getInput } from '@actions/core'
 import fs from 'fs'
-import nodePath from 'path'
-import helpers from './helpers'
+import helpers, { readIgnoreFiles } from './helpers'
 import mainRunner from './mainRunner'
 
 const [thisOwner, thisRepo] = process.env.GITHUB_REPOSITORY.split('/', 2)
@@ -27,7 +26,10 @@ const [thisOwner, thisRepo] = process.env.GITHUB_REPOSITORY.split('/', 2)
     thisOwner,
     thisRepo,
     labels: getInput('issueLabels').split(','),
-    ignorePaths: getInput('ignore').split(','),
+    ignorePaths: [
+      ...getInput('ignore').split(','),
+      ...(await readIgnoreFiles())
+    ],
     directory: '.',
     issueLimit: parseInt(getInput('issueLimit')) || 5
   })

src/mainRunner.ts

@@ -1,16 +1,18 @@
 import mainRunner from './mainRunner'
-import { shouldIgnore } from './helpers'
-import * as fs from 'fs'
+import { readIgnoreFiles, shouldIgnore } from './helpers'
+import fs from 'fs'
 
-switch (process.argv[2]) {
+const [dir = '-h', ignore = '.git'] = process.argv.slice(2)
+
+switch (dir) {
   case '-help':
   case '-h':
   case '--help':
     console.log(`Usage:
 npx closed-reference-notifier <dir> <ignore>
 
 <dir>:    the directory to traverse
-<ignore>: comma separated list of gitignore style entries to ignore
+<ignore>: comma separated list of gitignore style entries to ignore, defaults to '.git'
 `)
     process.exit(0)
 }
@@ -21,16 +23,17 @@ npx closed-reference-notifier <dir> <ignore>
     thisOwner: '',
     issueExists: () => Promise.resolve(false),
     issueTitle: () => '',
-    issueBody: (ref, type, thisOwner, thisRepo, file) =>
-      `Found reference "${ref}" in file ${file}`,
+    issueBody: (ref, type, thisOwner, thisRepo, files) =>
+      `Found reference "${ref}" in files
+  ${files.map((file) => file.join('#')).join('\n  ')}`,
     issueIsClosed: () => Promise.resolve(true),
-    ignorePaths: process.argv[3] ? process.argv[3].split(',') : [],
+    ignorePaths: [...ignore.split(','), ...(await readIgnoreFiles(dir))],
     createIssue: (issue) => {
       console.log(issue.body)
       return Promise.resolve()
     },
     shouldIgnore,
-    directory: process.argv[2],
+    directory: dir,
     exitWithReason: (err: any) => {
       console.log('unexpected error:', err)
       process.exit(1)