Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scalvert/generator-jscodeshift
A yeoman generator for a jscodeshift codemod.
https://github.com/scalvert/generator-jscodeshift
Last synced: 2 months ago
JSON representation
A yeoman generator for a jscodeshift codemod.
- Host: GitHub
- URL: https://github.com/scalvert/generator-jscodeshift
- Owner: scalvert
- License: mit
- Created: 2017-11-28T19:55:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-14T22:26:47.000Z (over 6 years ago)
- Last Synced: 2024-10-19T17:57:38.164Z (2 months ago)
- Language: JavaScript
- Size: 94.7 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-codemods - generator-jscodeshif - A yeoman generator for a jscodeshift codemod. (Misc / ant-design)
README
# generator-jscodeshift
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
An opinionated [yeoman](http://yeoman.io) generator for a jscodeshift codemod. This generator scaffolds out a project to get you started writing your codemod in minutes. It handily includes some nice features, such as
1. Jest testing using input/output files
1. Automatic tests for idempotency, to ensure your codemod will not bork your source files if run > 1 time
1. Eslint with prettier plugin to standardize source files
## Installation
First, install [Yeoman](http://yeoman.io) and generator-jscodeshift using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-jscodeshift
```
or [yarn](https://yarnpkg.com/)
```bash
yarn global add yo
yarn global add generator-jscodeshift
```
Then generate your new project:
```bash
yo jscodeshift
```
## Getting To Know Yeoman
* Yeoman has a heart of gold.
* Yeoman is a person with feelings and opinions, but is very easy to work with.
* Yeoman can be too opinionated at times but is easily convinced not to be.
* Feel free to [learn more about Yeoman](http://yeoman.io/).
## Credits
This generator was largely made possible by the excellent work of [Robert Jackson](https://github.com/rwjblue) when building [ember-qunit-codemod](https://github.com/rwjblue/ember-qunit-codemod).
## License
MIT © [Steve Calvert]()
[npm-image]: https://badge.fury.io/js/generator-jscodeshift.svg
[npm-url]: https://npmjs.org/package/generator-jscodeshift
[travis-image]: https://travis-ci.org/scalvert/generator-jscodeshift.svg?branch=master
[travis-url]: https://travis-ci.org/scalvert/generator-jscodeshift
[daviddm-image]: https://david-dm.org/scalvert/generator-jscodeshift.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/scalvert/generator-jscodeshift