Merge pull request #142 from jessebeach/ethanc/create-rule-script

[new][dev] Add the new rule to the index, extends #139

Author: jessebeach

README.md

@@ -111,6 +111,15 @@ You can also enable all the recommended rules at once. Add `plugin:jsx-a11y/reco
 - [scope](docs/rules/scope.md): Enforce `scope` prop is only used on `<th>` elements.
 - [tabindex-no-positive](docs/rules/tabindex-no-positive.md): Enforce `tabIndex` value is not greater than zero.
 
+## Creating a new rule
+
+If you are developing new rules for this project, you can use the `create-rule`
+script to scaffold the new files.
+
+```
+$ ./scripts/create-rule.js my-new-rule
+```
+
 ## License
 
 eslint-plugin-jsx-a11y is licensed under the [MIT License](LICENSE.md).

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.type === 'Literal') ? a.key.value : a.key.name;
+    const bName = (b.key.type === 'Literal') ? b.key.value : b.key.name;
+    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

@@ -1,9 +1,11 @@
+#!/usr/bin/env node --harmony
 const path = require('path');
 const fs = require('fs');
 const argv = require('minimist')(process.argv.slice(2)); // eslint-disable-line import/no-extraneous-dependencies
 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';
@@ -13,6 +15,14 @@ const rulePath = path.resolve(`src/rules/${ruleName}.js`);
 const testPath = path.resolve(`__tests__/src/rules/${ruleName}-test.js`);
 const docsPath = path.resolve(`docs/rules/${ruleName}.md`);
 
+const jscodeshiftJSON = require('jscodeshift/package.json');
+const jscodeshiftMain = jscodeshiftJSON.main;
+const jscodeshiftPath = require.resolve('jscodeshift');
+const jscodeshiftRoot = jscodeshiftPath.slice(
+  0,
+  jscodeshiftPath.indexOf(jscodeshiftMain)
+);
+
 // Validate
 if (!ruleName) {
   throw new Error('Rule name is required');
@@ -29,3 +39,24 @@ const docBoilerplate = docBoilerplateGenerator(ruleName);
 fs.writeFileSync(rulePath, ruleBoilerplate);
 fs.writeFileSync(testPath, testBoilerplate);
 fs.writeFileSync(docsPath, docBoilerplate);
+
+// Add the rule to the index
+exec([
+  path.join(
+    jscodeshiftRoot,
+    jscodeshiftJSON.bin.jscodeshift
+  ),
+  './src/index.js',
+  '-t ./scripts/addRuleToIndex.js',
+  '--extensions js',
+  '--parser flow',
+  `--ruleName=${ruleName}`,
+  `--rulePath=${rulePath}`,
+  ].join(' '),
+  (error, stdout, stderr) => {
+    if (error) {
+      console.error(`exec error: ${error}`);
+      return;
+    }
+  }
+);