refactor: update blacklist to blocklist to remove noninclusive language (#16)

Author: jbkey23

README.md

@@ -64,7 +64,7 @@ Then configure the rules you want to use under the rules section.
         "mocks/*/": "KEBAB_CASE"
       }
     ],
-    "check-file/filename-blacklist": [
+    "check-file/filename-blocklist": [
       "error",
       {
         "**/*.model.ts": "*.models.ts",
@@ -81,7 +81,7 @@ Then configure the rules you want to use under the rules section.
 - [check-file/filename-naming-convention](docs/rules/filename-naming-convention.md): Enforce a consistent naming pattern for the filename of the specified file
 - [check-file/no-index](docs/rules/no-index.md): A file cannot be named "index"
 - [check-file/folder-naming-convention](docs/rules/folder-naming-convention.md): Enforce a consistent naming pattern for the name of the specified folder
-- [check-file/filename-blacklist](docs/rules/filename-blacklist.md): Blacklist file names by pattern
+- [check-file/filename-blocklist](docs/rules/filename-blocklist.md): Blocklist file names by pattern
 
 
 [npm-image]: https://img.shields.io/npm/v/eslint-plugin-check-file.svg

docs/rules/filename-blacklist.md renamed to docs/rules/filename-blocklist.md

@@ -1,6 +1,6 @@
-# The filename should not be blacklisted (filename-blacklist)
+# The filename should be blocklisted (filename-blocklist)
 
-Allows you to blacklist certain file name patterns.
+Allows you to blocklist certain file name patterns.
 
 ## Rule Details
 
@@ -9,7 +9,7 @@ This rule aims to maintain a consistent naming scheme.
 If the rule had been set as follows:
 ```js
 ...
-'check-file/filename-blacklist': ['error', { '**/*.model.ts': '*.models.ts' }],
+'check-file/filename-blocklist': ['error', { '**/*.model.ts': '*.models.ts' }],
 ...
 ```
 
@@ -28,17 +28,17 @@ src/bar.models.ts
 
 ### Options
 
-#### blacklist pattern object
+#### blocklist pattern object
 
-You need to specify a different naming pattern for each filename blacklist. The second pattern is used to hint at the correct file name that should be used instead.
+You need to specify a different naming pattern for each filename blocklist. The second pattern is used to hint at the correct file name that should be used instead.
 
 ```js
 module.exports = {
   plugins: [
     'check-file',
   ],
   rules: {
-    'check-file/filename-blacklist': ['error', {
+    'check-file/filename-blocklist': ['error', {
       '**/*.model.ts': '*.models.ts',
       '**/*.util.ts': '*.utils.ts',
     }],

lib/rules/filename-blacklist.js renamed to lib/rules/filename-blocklist.js

@@ -1,5 +1,5 @@
 /**
- * @file The filename should not be blacklisted.
+ * @file The filename should be blocklisted.
  * @author Florian Ehmke
  */
 'use strict';
@@ -17,10 +17,10 @@ module.exports = {
   meta: {
     type: 'layout',
     docs: {
-      description: 'The filename should not be blacklisted',
+      description: 'The filename should be blocklisted',
       category: 'Layout & Formatting',
       recommended: false,
-      url: getDocUrl('filename-blacklist'),
+      url: getDocUrl('filename-blocklist'),
     },
     fixable: null,
     schema: [
@@ -58,21 +58,21 @@ module.exports = {
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
 
-        for (const [blackListPattern, useInsteadPattern] of Object.entries(
+        for (const [blockListPattern, useInsteadPattern] of Object.entries(
           rules
         )) {
-          const matchResult = matchRule(filename, blackListPattern);
+          const matchResult = matchRule(filename, blockListPattern);
 
           if (matchResult) {
             const { path } = matchResult;
 
             context.report({
               node,
               message:
-                'The filename "{{ path }}" matches the blacklisted "{{ blackListPattern }}" pattern. Use a pattern like "{{ useInsteadPattern }}" instead.',
+                'The filename "{{ path }}" matches the blocklisted "{{ blockListPattern }}" pattern. Use a pattern like "{{ useInsteadPattern }}" instead.',
               data: {
                 path,
-                blackListPattern,
+                blockListPattern,
                 useInsteadPattern,
               },
             });

tests/lib/rules/filename-blacklist.posix.js renamed to tests/lib/rules/filename-blocklist.posix.js

@@ -1,5 +1,5 @@
 /**
- * @file The filename should not be blacklisted
+ * @file The filename should be blocklisted
  * @author Florian Ehmke, Duke Luo
  */
 'use strict';
@@ -8,13 +8,13 @@ const path = require('path');
 const proxyquire = require('proxyquire');
 const RuleTester = require('eslint').RuleTester;
 
-const rule = proxyquire('../../../lib/rules/filename-blacklist', {
+const rule = proxyquire('../../../lib/rules/filename-blocklist', {
   path: { ...path.posix, '@global': true },
 });
 const ruleTester = new RuleTester();
 
 ruleTester.run(
-  "filename-blacklist with option: [{ '*.models.ts': '*.model.ts', '*.utils.ts': '*.util.ts' }]",
+  "filename-blocklist with option: [{ '*.models.ts': '*.model.ts', '*.utils.ts': '*.util.ts' }]",
   rule,
   {
     valid: [
@@ -42,7 +42,7 @@ ruleTester.run(
         errors: [
           {
             message:
-              'The filename "foo.models.ts" matches the blacklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
+              'The filename "foo.models.ts" matches the blocklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
             column: 1,
             line: 1,
           },
@@ -55,7 +55,7 @@ ruleTester.run(
         errors: [
           {
             message:
-              'The filename "foo.utils.ts" matches the blacklisted "*.utils.ts" pattern. Use a pattern like "*.util.ts" instead.',
+              'The filename "foo.utils.ts" matches the blocklisted "*.utils.ts" pattern. Use a pattern like "*.util.ts" instead.',
             column: 1,
             line: 1,
           },
@@ -66,7 +66,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-blacklist with option: [{ '*.models.ts': 'FOO' }]",
+  "filename-blocklist with option: [{ '*.models.ts': 'FOO' }]",
   rule,
   {
     valid: [],
@@ -89,7 +89,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-blacklist with option: [{ 'models.ts': '*.model.ts' }]",
+  "filename-blocklist with option: [{ 'models.ts': '*.model.ts' }]",
   rule,
   {
     valid: [],

tests/lib/rules/filename-blacklist.windows.js renamed to tests/lib/rules/filename-blocklist.windows.js

@@ -1,5 +1,5 @@
 /**
- * @file The filename should not be blacklisted
+ * @file The filename should be blocklisted
  * @author Duke Luo
  */
 'use strict';
@@ -8,13 +8,13 @@ const path = require('path');
 const proxyquire = require('proxyquire');
 const RuleTester = require('eslint').RuleTester;
 
-const rule = proxyquire('../../../lib/rules/filename-blacklist', {
+const rule = proxyquire('../../../lib/rules/filename-blocklist', {
   path: { ...path.win32, '@global': true },
 });
 const ruleTester = new RuleTester();
 
 ruleTester.run(
-  "filename-blacklist with option on Windows: [{ '*.models.ts': '*.model.ts' }]",
+  "filename-blocklist with option on Windows: [{ '*.models.ts': '*.model.ts' }]",
   rule,
   {
     valid: [
@@ -38,7 +38,7 @@ ruleTester.run(
         errors: [
           {
             message:
-              'The filename "foo.models.ts" matches the blacklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
+              'The filename "foo.models.ts" matches the blocklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
             column: 1,
             line: 1,
           },
@@ -51,7 +51,7 @@ ruleTester.run(
         errors: [
           {
             message:
-              'The filename "foo.models.ts" matches the blacklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
+              'The filename "foo.models.ts" matches the blocklisted "*.models.ts" pattern. Use a pattern like "*.model.ts" instead.',
             column: 1,
             line: 1,
           },
@@ -62,7 +62,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-blacklist with option on Windows: [{ '*.models.ts': 'FOO' }]",
+  "filename-blocklist with option on Windows: [{ '*.models.ts': 'FOO' }]",
   rule,
   {
     valid: [],
@@ -85,7 +85,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-blacklist with option on Windows: [{ 'models.ts': '*.model.ts' }]",
+  "filename-blocklist with option on Windows: [{ 'models.ts': '*.model.ts' }]",
   rule,
   {
     valid: [],