Update README (#65)

* start

* update readme and a few rules

Author: redallen

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# pf-codemods
+An eslint plugin (with an extra CLI utility) to help ease products transitioning to our new major @patternfly/react-core 4.0.0 release.
+
+## Usage
+
+```sh
+npx pf-codemods ./path-to-src
+```
+
+## Goals
+- We want to minimize code changes and respect existing code
+- We only want to make safe modifications
+  - Don't touch code that might not be PatternFly
+
+## redallen rationale
+- Most consumers are using JSX, so we can write rules that target JSXElements
+  - When they're using React.createElement or React.cloneElement that introduces unsafe complications
+
+## Design
+- Use a JSX parser that leaves formatting alone as much as possible
+- Add basic ESM import parsing to make sure we're only modifying PatternFly `<Button>`s
+
+## Development
+This is what @redallen does to develop a rule:
+1. ~~Copy a similar rule from `eslint-plugin-pf-codemods/lib/rules/*`~~
+2. ~~Add it to the `rules` object at the top of `eslint-plugin-pf-codemods/index.js`~~
+3. ~~Copy a test at `test/rules/*` and write your test cases.~~
+
+We now have a generator.
+1. Run `node generate new-rule-name` to create the rule files
+2. Run `node test/rules/new-rule-name.js` to test the rule
+
+If you're having trouble writing a rule, you can:
+1. Put code into an AST explorer like https://astexplorer.net/ to inspect all the AST nodes
+2. `console.dir(node, { depth: 5 })` to better inspect a `node` you're dealing with
+3. Write rule targeting an AST node that has all the information you need. Confirm AST node exists in `lib/rules/ast-node-types.d.ts`.
+4. Ask zallen on the RHUX or PatternFly Slack

README.md

@@ -0,0 +1 @@
+packages/pf-codemods/README.md

README.md

@@ -12,7 +12,7 @@ module.exports = {
           const attribute = node.attributes.find(node => node.name && node.name.name === 'variant');
           if (attribute) {
             const attributeValue = context.getSourceCode().getText(attribute.value);
-            if (['"left"', '"right"'].includes(attributeValue))
+            if (/left|right/.test(attributeValue))
               context.report({
                 node,
                 message: `variant ${attributeValue} has been removed from ${node.name.name}`,

packages/eslint-plugin-pf-codemods/lib/rules/pagination-removed-variant.js

@@ -26,6 +26,14 @@ ruleTester.run("pagination-removed-variant", rule, {
         message: `variant "right" has been removed from Pagination`,
         type: "JSXOpeningElement",
       }]
+    },
+    {
+      code:   `import { Pagination, PaginationVariant } from '@patternfly/react-core'; <Pagination variant={PaginationVariant.right} />`,
+      output: `import { Pagination, PaginationVariant } from '@patternfly/react-core'; <Pagination  />`,
+      errors: [{
+        message: `variant {PaginationVariant.right} has been removed from Pagination`,
+        type: "JSXOpeningElement",
+      }]
     }
   ]
 });

packages/eslint-plugin-pf-codemods/test/rules/pagination-removed-variant.js

@@ -20,5 +20,13 @@ ruleTester.run("progress-remove-info-variant", rule, {
         type: "JSXOpeningElement",
       }]
     },
+    {
+      code:   `import { Progress, ProgressVariant } from '@patternfly/react-core'; <Progress variant={ProgressVariant.info} />`,
+      output: `import { Progress, ProgressVariant } from '@patternfly/react-core'; <Progress  />`,
+      errors: [{
+        message: `info variant which adds no styling has been removed for Progress. Don't pass this prop`,
+        type: "JSXOpeningElement",
+      }]
+    },
   ]
 });