Merge pull request #2768 from reduxjs/feature/rtk-reducer-codemods

Author: markerikson

.prettierignore

@@ -1,3 +1,4 @@
 **/dist/**
 **/etc/**
-**/temp/**
+**/temp/**
+**/__testfixtures__/**

package.json

@@ -37,11 +37,20 @@
     "release-it": "^14.12.5"
   },
   "resolutions": {
+    "@babel/core": "7.19.3",
+    "@babel/code-frame": "7.18.6",
+    "@babel/generator": "7.19.3",
+    "@babel/helper-compilation-targets": "7.19.3",
+    "@babel/traverse": "7.19.3",
+    "@babel/types": "7.19.3",
     "console-testing-library": "patch:console-testing-library@npm:0.3.1#.yarn/patches/console-testing-library__npm_0.3.1.patch",
     "msw": "patch:msw@npm:0.40.2#.yarn/patches/msw-npm-0.40.2-2107d48752",
+    "jscodeshift": "0.13.1",
     "react-redux": "npm:8.0.2",
     "react": "npm:18.1.0",
     "react-dom": "npm:18.1.0",
+    "resolve": "1.22.1",
+    "ts-node": "10.4.0",
     "@types/react": "npm:18.0.12",
     "@types/react-dom": "npm:18.0.5",
     "@types/inquirer": "npm:8.2.1",

packages/rtk-codemods/.eslintignore

@@ -0,0 +1,2 @@
+!.*
+__testfixtures__

packages/rtk-codemods/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+
+  plugins: ['prettier', 'node'],
+  extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+  env: {
+    node: true,
+  },
+  rules: {},
+  overrides: [
+    {
+      files: ['__tests__/**/*.js'],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+};

packages/rtk-codemods/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - main
+      - 'v*' # older version branches
+    tags:
+      - '*'
+  pull_request: {}
+  schedule:
+  - cron:  '0 6 * * 0' # weekly, on sundays
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+    - name: install dependencies
+      run: yarn install --frozen-lockfile
+    - name: linting
+      run: yarn lint
+
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: ['10', '12', '14']
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node }}
+    - name: install dependencies
+      run: yarn install --frozen-lockfile
+    - name: test
+      run: yarn test
+
+  floating-test:
+    name: Floating dependencies
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - name: install dependencies
+      run: yarn install --no-lockfile
+    - name: test
+      run: yarn test

packages/rtk-codemods/.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+/.eslintcache

packages/rtk-codemods/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

packages/rtk-codemods/.release-it.json

@@ -0,0 +1,9 @@
+{
+  "hooks": {
+    "after:bump": "yarn && git add -u"
+  },
+  "git": {
+    "commitMessage": "Release @reduxjs/rtk-codemods ${version}",
+    "tagName": "@reduxjs/rtk-codemods@${version}"
+  }
+}

packages/rtk-codemods/README.md

@@ -1,3 +1,46 @@
 # RTK Codemods
 
-This needs some actual content and needs to be an actual package.
+A collection of codemods for updating legacy Redux Toolkit API usage patterns to modern patterns.
+
+## Usage
+
+To run a specific codemod from this project, you would run the following:
+
+```bash
+npx @reduxjs/rtk-codemods <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add @reduxjs/rtk-codemods
+rtk-codemods <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+```
+
+## Local Usage
+
+```
+node ./bin/cli.js <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+```
+
+## Transforms
+
+<!--TRANSFORMS_START-->
+
+- [createReducerBuilder](transforms/createReducerBuilder/README.md)
+- [createSliceBuilder](transforms/createSliceBuilder/README.md)
+<!--TRANSFORMS_END-->
+
+## Contributing
+
+### Installation
+
+- clone the repo
+- change into the repo directory
+- `yarn`
+
+### Running tests
+
+- `yarn test`
+
+### Update Documentation
+
+- `yarn update-docs`

packages/rtk-codemods/bin/cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+const path = require('path');
+
+require('ts-node').register({
+  project: path.join(__dirname, './tsconfig.json'),
+});
+
+require('codemod-cli').runTransform(
+  __dirname,
+  process.argv[2] /* transform name */,
+  process.argv.slice(3) /* paths or globs */
+);