Add linting (#9)

* Add linting and prettier, address all issues except foreach

* fix foreach lint issue

* update script

* fix package.json

* update workflow title

* regenerate package-lock

* Don't download self in package.json

Author: khiga8

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  env: {
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  plugins: ["github"],
+  extends: ["plugin:github/recommended"],
+  rules: {
+    "import/no-commonjs": "off",
+    "filenames/match-regex": "off",
+  },
+};

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Lint markdown files
+name: Run linter and tests
 on:
   push:
     branches:

index.js

@@ -1,20 +1,18 @@
-const _ = require('lodash')
+const _ = require("lodash");
 
-const accessibilityRules = require('./style/accessibility.json')
-const base = require('./style/base.json')
-const noDefaultAltText = require('./no-default-alt-text')
+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];
 
-module.exports = [...customRules]
+module.exports = [...customRules];
 
-customRules.forEach(rule => {
-    base[rule.names[1]] = true
-})
+for (const rule of customRules) {
+  base[rule.names[1]] = true;
+}
 
 module.exports.init = function init(consumerConfig) {
-    // left overwrites right
-    return _.defaultsDeep(consumerConfig, accessibilityRules, base)
-}
+  // left overwrites right
+  return _.defaultsDeep(consumerConfig, accessibilityRules, base);
+};

no-default-alt-text.js

@@ -1,37 +1,44 @@
-// Regex to match alt text that is the same as the default image filename 
+// 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|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
+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). 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" ],
-    "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)) {
-                    onError({
-                        lineNumber: image.lineNumber,
-                        details: `For image: ${image.content}`
-                    })
-                }
-            })
-        })
+  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"],
+  function: function GH001(params, onError) {
+    // markdown syntax
+    const inlineTokens = params.tokens.filter((t) => t.type === "inline");
+    for (const token of inlineTokens) {
+      const imageTokens = token.children.filter((t) => t.type === "image");
+      for (const image of imageTokens) {
+        if (image.content.match(altTextRegex)) {
+          onError({
+            lineNumber: image.lineNumber,
+            details: `For image: ${image.content}`,
+          });
+        }
+      }
+    }
 
-        // html syntax
-        let lineNumber = 1
-        params.lines.forEach(line => {
-            if (line.match(altTextTagRegex)) {
-                onError({
-                    lineNumber: lineNumber,
-                    details: `For line: ${line}`
-                })
-            }
-            lineNumber++
-        })
+    // html syntax
+    let lineNumber = 1;
+    for (const line of params.lines) {
+      if (line.match(altTextTagRegex)) {
+        onError({
+          lineNumber,
+          details: `For image: ${line}`,
+        });
+      }
+      lineNumber++;
     }
-}
+  },
+};