Add the new rule to the index

Author: jessebeach

package.json

@@ -38,6 +38,7 @@
     "eslint-config-airbnb-base": "^11.0.0",
     "eslint-plugin-import": "^2.2.0",
     "jest": "^18.1.0",
+    "jscodeshift": "^0.3.30",
     "minimist": "^1.2.0",
     "rimraf": "^2.5.2",
     "to-ast": "^1.0.0"

scripts/addRuleToIndex.js

@@ -0,0 +1,68 @@
+export const parser = 'flow';
+
+export default function transformer(file, api, options) {
+  const j = api.jscodeshift;
+  const s = j(file.source);
+  const {
+    ruleName,
+    rulePath,
+  } = options || {};
+
+  const nameSort = (a, b) => {
+    const aName = a.key.value;
+    const bName = b.key.value;
+    if (aName < bName) {
+      return -1;
+    }
+    if (bName < aName) {
+      return 1;
+    }
+    return 0;
+  };
+
+  let changesMade = 0;
+
+  const rulePathInSrc = './' + rulePath.match(/src\/(.*)\.js/)[1];
+
+  changesMade += s.find(j.Identifier, {
+    name: 'rules'
+  }).forEach((path, index) => {
+    // Add rule path.
+    if (index === 0) {
+      path.parentPath.value.value.properties.unshift(
+        j.property(
+          'init',
+          j.literal(ruleName),
+          j.callExpression(
+            j.identifier('require'),
+            [
+              j.literal(rulePathInSrc),
+            ]
+          ),
+        )
+      );
+      path.parentPath.value.value.properties.sort(nameSort);
+    }
+    // Set default reporting to error.
+    if (index === 1) {
+      path.parentPath.value.value.properties.unshift(
+        j.property(
+          'init',
+          j.literal('jsx-a11y/' + ruleName),
+          j.literal('error'),
+        )
+      );
+      path.parentPath.value.value.properties.sort(nameSort);
+    }
+  }).length;
+
+
+  if (changesMade === 0) {
+    return null;
+  }
+
+  return s.toSource({
+    quote: 'single',
+    trailingComma: true,
+  });
+}

scripts/create-rule.js

@@ -4,6 +4,7 @@ const argv = require('minimist')(process.argv.slice(2)); // eslint-disable-line
 const ruleBoilerplateGenerator = require('./boilerplate/rule');
 const testBoilerplateGenerator = require('./boilerplate/test');
 const docBoilerplateGenerator = require('./boilerplate/doc');
+const exec = require('child_process').exec;
 
 const ruleName = argv._[0];
 const author = argv.author || '$AUTHOR';
@@ -29,3 +30,24 @@ const docBoilerplate = docBoilerplateGenerator(ruleName);
 fs.writeFileSync(rulePath, ruleBoilerplate);
 fs.writeFileSync(testPath, testBoilerplate);
 fs.writeFileSync(docsPath, docBoilerplate);
+
+// Add the rule to the index
+exec([
+  './node_modules/jscodeshift/bin/jscodeshift.sh',
+  './src/index.js',
+  '-t ./scripts/addRuleToIndex.js',
+  '-p',
+  '--extensions js',
+  '--parser flow',
+  `--ruleName=${ruleName}`,
+  `--rulePath=${rulePath}`,
+  ].join(' '),
+  (error, stdout, stderr) => {
+    if (error) {
+      console.error(`exec error: ${error}`);
+      return;
+    }
+    console.log(`stdout: ${stdout}`);
+    console.log(`stderr: ${stderr}`);
+  }
+);

src/index.js

@@ -17,7 +17,7 @@ module.exports = {
     'img-has-alt': require('./rules/img-has-alt'),
     'img-redundant-alt': require('./rules/img-redundant-alt'),
     'label-has-for': require('./rules/label-has-for'),
-    lang: require('./rules/lang'),
+    'lang': require('./rules/lang'),
     'mouse-events-have-key-events': require('./rules/mouse-events-have-key-events'),
     'no-access-key': require('./rules/no-access-key'),
     'no-autofocus': require('./rules/no-autofocus'),
@@ -28,7 +28,7 @@ module.exports = {
     'onclick-has-role': require('./rules/onclick-has-role'),
     'role-has-required-aria-props': require('./rules/role-has-required-aria-props'),
     'role-supports-aria-props': require('./rules/role-supports-aria-props'),
-    scope: require('./rules/scope'),
+    'scope': require('./rules/scope'),
     'tabindex-no-positive': require('./rules/tabindex-no-positive'),
   },
   configs: {