Much of the prelude of the Babel contribution guide also applies for this project, since it operates on and with Babel plugins. In particular:
- AST Explorer is a very useful tool for examining ASTs and prototyping plugins.
- The Babel Plugin handbook is a great resource for understanding Babel plugins.
This project is written with TypeScript, a superset of JavaScript that allows explicit type annotations and includes a type checker.
codemod expects at least node 16 and pnpm. You can check each of these with node -v and pnpm -v. Look for instructions on installing node here and pnpm here.
$ git clone https://github.com/codemod-js/codemod
$ cd codemod
$ pnpm installThen make sure the tests pass:
$ pnpm testWe use ESLint. To run ESLint on the project, run:
$ pnpm lintTo automatically fix some of the issues ESLint finds:
$ pnpm lint:fixThe tests in this project are written using Jest and, like the non-test code, are also written in TypeScript. To run the tests:
$ pnpm testWe accept pull requests for bug fixes and improvements. For non-trivial changes it's usually a good idea to open an issue first to track the bug you'd like to fix or discuss the improvement you'd like to contribute.
- Is tested. Any bugs fixed should have a test that fails without the fix. Any features added should have tests covering the expected usage and expected failures.
- Is documented. Reference any existing issues that your pull request addresses. Provide a reasonable description in the pull request body. Documentation of expected usage for new features is required. Documentation is generally not needed for bug-fix pull requests, but sometimes a bug happened because an API was poorly understood. Consider improving the documentation such that a similar bug would not be introduced in the future.
- Is narrow in scope. Pull requests that make broad, sweeping changes are generally a bad idea. Instead, larger refactors or improvements should be broken down into multiple smaller pull requests.