Update package meta info

Author: mxmason

lib/config.js

@@ -0,0 +1,30 @@
+const DEFAULT_CHECK_PATHS = ['/'];
+const DEFAULT_FAIL_WITH_ISSUES = true;
+const DEFAULT_IGNORE_DIRECTORIES = [];
+const PA11Y_DEFAULT_STANDARD = 'WCAG2AA';
+const PA11Y_RUNNERS = ['axe'];
+const PA11Y_USER_AGENT = 'netlify-plugin-a11y';
+
+const DEFAULT_INPUTS = {
+    checkPaths: DEFAULT_CHECK_PATHS,
+    
+}
+const getConfiguration = ({ constants: { PUBLISH_DIR }, inputs: { checkPaths, debugMode, ignoreDirectories, failWithIssues, standard } = {
+
+}, }) => {
+    return {
+        absolutePublishDir: PUBLISH_DIR || process.env.PUBLISH_DIR,
+        checkPaths: checkPaths || DEFAULT_CHECK_PATHS,
+        debugMode: debugMode || false,
+        ignoreDirectories: ignoreDirectories || DEFAULT_IGNORE_DIRECTORIES,
+        failWithIssues: failWithIssues !== undefined ? failWithIssues : DEFAULT_FAIL_WITH_ISSUES,
+        pa11yOpts: {
+            runners: PA11Y_RUNNERS,
+            userAgent: PA11Y_USER_AGENT,
+            standard: standard || PA11Y_DEFAULT_STANDARD,
+        },
+    };
+};
+module.exports = {
+    getConfiguration,
+};

lib/index.js

@@ -0,0 +1,35 @@
+const { getConfiguration } = require('./config');
+const pluginCore = require('./pluginCore');
+module.exports = {
+    async onPostBuild({ constants, inputs, utils: { build } }) {
+        try {
+            const { absolutePublishDir, checkPaths, debugMode, ignoreDirectories, pa11yOpts, failWithIssues } = getConfiguration({ constants, inputs });
+            const htmlFilePaths = await pluginCore.generateFilePaths({
+                absolutePublishDir,
+                ignoreDirectories,
+                fileAndDirPaths: checkPaths,
+            });
+            if (debugMode) {
+                console.log({ htmlFilePaths });
+            }
+            const { report, issueCount } = await pluginCore.runPa11y({
+                build,
+                htmlFilePaths,
+                pa11yOpts,
+            });
+            if (issueCount > 0) {
+                const postRunMsg = `Pa11y found ${issueCount} accessibility violations on your site! Check the logs above for more information.`;
+                console.log(report);
+                if (failWithIssues) {
+                    build.failBuild(postRunMsg);
+                }
+                else {
+                    console.warn(postRunMsg);
+                }
+            }
+        }
+        catch (err) {
+            build.failBuild(err.message);
+        }
+    },
+};

lib/pluginCore.js

@@ -0,0 +1,54 @@
+const pa11y = require('pa11y');
+const { extname } = require('path');
+const { isDirectory, isFile } = require('path-type');
+const { results: cliReporter } = require('pa11y/lib/reporters/cli');
+const readdirp = require('readdirp');
+const EMPTY_ARRAY = [];
+const ASTERISK = '*';
+const HTML_EXT = '.html';
+const GLOB_HTML = '*.html';
+exports.runPa11y = async function ({ htmlFilePaths, pa11yOpts, build }) {
+    let issueCount = 0;
+    const results = await Promise.all(htmlFilePaths.map(async (path) => {
+        try {
+            const res = await pa11y(path, pa11yOpts);
+            if (res.issues && res.issues.length) {
+                issueCount += res.issues.length;
+                return cliReporter(res);
+            }
+        }
+        catch (error) {
+            build.failBuild('pa11y failed', { error });
+        }
+    }));
+    return {
+        issueCount,
+        report: results.join(''),
+    };
+};
+exports.generateFilePaths = async function ({ fileAndDirPaths, ignoreDirectories, absolutePublishDir, }) {
+    const excludeDirGlobs = ignoreDirectories.map((dir) => `!${dir.replace(/^\/+/, '')}`);
+    const htmlFilePaths = await Promise.all(fileAndDirPaths.map((fileAndDirPath) => findHtmlFiles(`${absolutePublishDir}${fileAndDirPath}`, excludeDirGlobs)));
+    return [].concat(...htmlFilePaths);
+};
+const findHtmlFiles = async function (fileAndDirPath, directoryFilter) {
+    if (await isDirectory(fileAndDirPath)) {
+        const filePaths = [];
+        const stream = readdirp(fileAndDirPath, {
+            fileFilter: GLOB_HTML,
+            directoryFilter: !!directoryFilter.length ? directoryFilter : ASTERISK,
+        });
+        for await (const { fullPath } of stream) {
+            filePaths.push(fullPath);
+        }
+        return filePaths;
+    }
+    if (!(await isFile(fileAndDirPath))) {
+        console.warn(`Folder ${fileAndDirPath} was provided in "checkPaths", but does not exist - it either indicates something went wrong with your build, or you can simply delete this folder from your "checkPaths" in netlify.toml`);
+        return EMPTY_ARRAY;
+    }
+    if (extname(fileAndDirPath) !== HTML_EXT) {
+        return EMPTY_ARRAY;
+    }
+    return [fileAndDirPath];
+};

package.json

@@ -21,6 +21,9 @@
     "a11y"
   ],
   "author": "swyx <swyx@dontemail.me>",
+  "contributors": [
+    "EJ Mason <ej.mason@dontemail.me>"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">=12.13.0"
@@ -30,8 +33,8 @@
     "gh-release": "^6.0.1",
     "jest": "^27.3.1"
   },
-  "repository": "https://github.com/sw-yx/netlify-plugin-a11y",
+  "repository": "https://github.com/netlify-labs/netlify-plugin-a11y",
   "bugs": {
-    "url": "https://github.com/sw-yx/netlify-plugin-a11y/issues"
+    "url": "https://github.com/netlify-labs/netlify-plugin-a11y/issues"
   }
-}
+}