Add remark-autolink-references

https://github.com/vweevers/remark-autolink-references

README.md

@@ -21,6 +21,7 @@
 - [Usage](#usage)
 - [Package Options](#package-options)
   - [`ignore`](#ignore)
+  - [`autolinkReferences`](#autolinkreferences)
   - [`changelog`](#changelog)
   - [`validateLinks`](#validatelinks)
   - [`paddedTable`](#paddedtable)
@@ -180,6 +181,37 @@ Alternatively, for use in non-node projects, place a `.hallmarkrc` file in the w
 
 A string or array of files to ignore. Merged with `--ignore / -i` if any.
 
+### `autolinkReferences`
+
+Autolink custom references [like GitHub Pro](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuring-autolinks-to-reference-external-resources) does. Must be an object with a `prefix` and `url` (if `autolinkReferences` is not set, this feature does nothing). For example, given:
+
+```json
+{
+  "autolinkReferences": {
+    "prefix": "JIRA-",
+    "url": "https://example.atlassian.net/browse/JIRA-<num>"
+  }
+}
+```
+
+Then `hallmark fix` will transform:
+
+```md
+### Fixed
+
+- Prevent infinite loop (JIRA-4275)
+```
+
+To:
+
+```md
+### Fixed
+
+- Prevent infinite loop ([JIRA-4275](https://example.atlassian.net/browse/JIRA-4275))
+```
+
+While `hallmark lint` will warn about unlinked references.
+
 ### `changelog`
 
 An object containing options to be passed to [`remark-changelog`](https://github.com/vweevers/remark-changelog):

index.js

@@ -78,6 +78,14 @@ function hallmark (options, callback) {
         [require('remark-changelog'), { cwd, fix, pkg, repository, ...changelog }],
         [require('remark-github'), { repository }],
 
+        // Does nothing unless configured
+        rc.autolinkReferences
+          ? [require('remark-autolink-references'), {
+              ...rc.autolinkReferences,
+              fix
+            }]
+          : null,
+
         // TODO: https://github.com/vweevers/hallmark/issues/36
         toc ? [require('remark-toc'), { tight: true }] : null,
         toc ? [require('remark-collapse'), collapseToc()] : null,

package.json

@@ -24,6 +24,7 @@
     "find-file-up": "^2.0.1",
     "github-url-from-git": "^1.5.0",
     "remark": "^12.0.1",
+    "remark-autolink-references": "^1.0.0",
     "remark-changelog": "^1.2.0",
     "remark-collapse": "~0.1.2",
     "remark-git-contributors": "^3.0.0",