feat: finalizes interface for consuming codebases (#4)

Author: andrialexandrou

index.js

@@ -1,22 +1,20 @@
 const _ = require('lodash')
 
+const accessibilityRules = require('./style/accessibility.json')
+const base = require('./style/base.json')
 const noDefaultAltText = require('./no-default-alt-text')
 
-const customRules = [noDefaultAltText]
+const customRules = [
+    noDefaultAltText
+]
 
-const base = {
-    config: {},
-    customRules
-}
+module.exports = [...customRules]
 
 customRules.forEach(rule => {
-    base.config[rule.names[1]] = true
+    base[rule.names[1]] = true
 })
 
-module.exports.overwriteWith = function overwriteWith(consumerConfig) {
-    // defaults are right-most
-    return _.defaultsDeep(consumerConfig, base)
+module.exports.init = function init(consumerConfig) {
+    // left overwrites right
+    return _.defaultsDeep(consumerConfig, accessibilityRules, base)
 }
-
-
-module.exports = [...customRules]

no-default-alt-text.js

@@ -1,15 +1,16 @@
 // Regex to match alt text that is the same as the default image filename 
 // e.g. "Screen Shot 2020-10-20 at 2 52 27 PM"
 // e.g. "Screenshot 2020-10-20 at 2 52 27 PM"
-const altTextRegex = /^Screen\s?shot \d{4}-\d{2}-\d{2} at \d \d{2} \d{2} [A|P]M$/gi
-const altTextTagRegex = /alt=\"Screen\s?shot \d{4}-\d{2}-\d{2} at \d \d{2} \d{2} [A|P]M\"/gi
+const altTextRegex = /^Screen ?[S|s]hot \d{4}-\d{2}-\d{2} at \d \d{2} \d{2} [A|P]M$/gi
+const altTextTagRegex = /alt=\"Screen ?[S|s]hot \d{4}-\d{2}-\d{2} at \d \d{2} \d{2} [A|P]M\"/gi
 
 module.exports = {
-    "names": ["GH001", "no-default-alt-text"],
-    "description": "Images should not use the MacOS default screenshot filename as alternate text (alt text). For more information see: https://primer.style/design/accessibility/alternative-text-for-images",
+    "names": [ "GH001", "no-default-alt-text" ],
+    "description": "Images should not use the MacOS default screenshot filename as alternate text (alt text). If you have not changed this file, try merging main with your branch. For more information see: https://primer.style/design/accessibility/alternative-text-for-images",
     "information": new URL("https://primer.style/design/accessibility/alternative-text-for-images"),
-    "tags": ["accessibility", "images"],
+    "tags": [ "accessibility", "images" ],
     "function": function GH001(params, onError) {
+        // markdown syntax
         params.tokens.filter(t => t.type === "inline").forEach(token => {
             token.children.filter(t => t.type === "image").forEach(image => {
                 if (image.content.match(altTextRegex)) {
@@ -21,6 +22,7 @@ module.exports = {
             })
         })
 
+        // html syntax
         let lineNumber = 1
         params.lines.forEach(line => {
             if (line.match(altTextTagRegex)) {
@@ -32,4 +34,4 @@ module.exports = {
             lineNumber++
         })
     }
-}
+}