https://github.com/expressjs/codemod
Codemods for updating express servers
https://github.com/expressjs/codemod
Last synced: 6 months ago
JSON representation
Codemods for updating express servers
- Host: GitHub
- URL: https://github.com/expressjs/codemod
- Owner: expressjs
- License: mit
- Created: 2024-11-15T00:33:56.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T23:33:48.000Z (6 months ago)
- Last Synced: 2025-04-02T00:27:12.986Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 353 KB
- Stars: 6
- Watchers: 7
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @expressjs/codemod
[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Express.js provides Codemod transforms to help you upgrade your express server when a feature is deprecated or removed.
Codemods are transformations that run on your codebase programmatically. This allows for a large amount of changes to be applied without having to manually go through every file.
## Installation
You don't need to install this package, run the following command:
```sh
npx @expressjs/codemod # or pnpx, bunx, etc.
```
or install globally:
```sh
npm i -g @expressjs/codemod # or pnpm, bun, etc.
```
## Usage
Use `@expressjs/codemod -h` to explore available command-line options.
```
Usage: @expressjs/codemod [codemod] [source] [options]
Options:
-v, --version Output the current version of @expressjs/codemod.
-d, --dry Dry run (no changes are made to files)
-p, --print Print transformed files to stdout
--verbose Show more information about the transform process
--silent Don't print anything to stdout
-h, --help Display this help message.
Commands:
upgrade [options] [source] Upgrade your express server to the latest
version.
```
## Available Codemods
All the available codemods to update your express server:
### magic redirect (v5.0.0)
Transform the deprecated magic string "back"
### pluralized methods (v5.0.0)
Transform the methods to their pluralized versions
### v4 deprecated signatures (v5.0.0)
Transform the deprecated signatures in Express v4
### req param (v5.0.0)
Change request.param() to dedicated methods
## Contributing
The Express.js project welcomes all constructive contributions. Contributions take many forms,
from code for bug fixes and enhancements, to additions and fixes to documentation, additional
tests, triaging incoming pull requests and issues, and more!
See the [Contributing Guide](https://github.com/expressjs/express/blob/master/Contributing.md) for more technical details on contributing.
## License
[MIT](LICENSE)
[npm-downloads-image]: https://badgen.net/npm/dm/@expressjs/codemod
[npm-downloads-url]: https://npmcharts.com/compare/@expressjs/codemod?minimal=true
[npm-url]: https://npmjs.org/package/@expressjs/codemod
[npm-version-image]: https://badgen.net/npm/v/@expressjs/codemod
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/codemod/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/codemod