allow explicitly ignoring directories

jhackshaw · jhackshaw · commit 5d05752da912 · 2020-05-05T21:54:53.000-04:00
diff --git a/README.md b/README.md
@@ -44,6 +44,8 @@ package = "netlify-plugin-a11y"
   ]
   
   # # optional config
+  # ignoreDirectories = ['/admin']  # explicitly ignore these directories
+
   # resultMode = "warn" # is "error" by default
 
   # # Developer only
diff --git a/manifest.yml b/manifest.yml
@@ -2,6 +2,8 @@ name: netlify-plugin-a11y
 inputs:
   - name: checkPaths
     required: true
+  - name: ignoreDirectories
+    required: false
   - name: resultMode
     default: error
   - name: debugMode
diff --git a/plugin/index.js b/plugin/index.js
@@ -9,12 +9,13 @@ const pluginCore = require('./pluginCore');
 
 module.exports = {
     async onPostBuild({
-      inputs: { checkPaths, resultMode, debugMode },
+      inputs: { checkPaths, ignoreDirectories, resultMode, debugMode },
       constants: { PUBLISH_DIR },
       utils: { build }
     }) {
       const htmlFilePaths = await pluginCore.generateFilePaths({
         fileAndDirPaths: checkPaths,
+        ignoreDirectories: ignoreDirectories || [],
         PUBLISH_DIR
       });
       if (debugMode) {
diff --git a/plugin/pluginCore.js b/plugin/pluginCore.js
@@ -27,19 +27,29 @@ exports.runPa11y = async function({ htmlFilePaths, testMode, debugMode }) {
 
 exports.generateFilePaths = async function({
   fileAndDirPaths, // array, mix of html and directories
+  ignoreDirectories = [],
   PUBLISH_DIR,
   testMode,
   debugMode
 }) {
+  const excludeDirGlobs = ignoreDirectories.map(
+    // add ! and strip leading slash
+    (dir) => `!${dir.replace(/^\/+/, "")}`
+  );
   const htmlFilePaths = await Promise.all(
-    fileAndDirPaths.map(fileAndDirPath => findHtmlFiles(`${PUBLISH_DIR}/${fileAndDirPath}`))
+    fileAndDirPaths.map(fileAndDirPath =>
+      findHtmlFiles(`${PUBLISH_DIR}${fileAndDirPath}`, excludeDirGlobs)
+    )
   )
   return [].concat(...htmlFilePaths)
 };
 
-const findHtmlFiles = async function(fileAndDirPath) {
+const findHtmlFiles = async function (fileAndDirPath, directoryFilter) {
   if (await isDirectory(fileAndDirPath)) {
-    const fileInfos = await readdirp.promise(fileAndDirPath, { fileFilter: '*.html' })
+    const fileInfos = await readdirp.promise(fileAndDirPath, {
+      fileFilter: '*.html',
+      directoryFilter
+    })
     return fileInfos.map(({ fullPath }) => fullPath)
   }
 
diff --git a/tests/generateFilePaths/publishDir/admin/index.html b/tests/generateFilePaths/publishDir/admin/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
+    <title>Document</title>
+  </head>
+  <body></body>
+</html>
diff --git a/tests/generateFilePaths/this.test.js b/tests/generateFilePaths/this.test.js
@@ -11,3 +11,31 @@ test('generateFilePaths works', async () => {
   });
   expect(results).toMatchSnapshot();
 });
+
+const pathInResults = (expectedPath, results) => {
+  return results.findIndex((r) => r.endsWith(expectedPath)) != -1;
+};
+
+test("ignoreDirectories works including leading slash", async () => {
+  const results = await pluginCore.generateFilePaths({
+    fileAndDirPaths: ["/"],
+    ignoreDirectories: ["/admin"],
+    PUBLISH_DIR,
+  });
+  expect(pathInResults("publishDir/blog/post1.html", results)).toBe(true);
+  expect(pathInResults("publishDir/about.html", results)).toBe(true);
+  expect(pathInResults("publishDir/index.html", results)).toBe(true);
+  expect(pathInResults("publishDir/admin/index.html", results)).toBe(false);
+});
+
+test("ignoreDirectories works without leading slash", async () => {
+  const results = await pluginCore.generateFilePaths({
+    fileAndDirPaths: ["/"],
+    ignoreDirectories: ["admin"],
+    PUBLISH_DIR,
+  });
+  expect(pathInResults("publishDir/blog/post1.html", results)).toBe(true);
+  expect(pathInResults("publishDir/about.html", results)).toBe(true);
+  expect(pathInResults("publishDir/index.html", results)).toBe(true);
+  expect(pathInResults("publishDir/admin/index.html", results)).toBe(false);
+});

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,8 @@ package = "netlify-plugin-a11y"`
`44`	`44`	`]`
`45`	`45`
`46`	`46`	`# # optional config`
	`47`	`+ # ignoreDirectories = ['/admin'] # explicitly ignore these directories`
	`48`	`+`
`47`	`49`	`# resultMode = "warn" # is "error" by default`
`48`	`50`
`49`	`51`	`# # Developer only`