Merge pull request #201 from rwjblue/migrate-to-npm

Author: rwjblue

.github/workflows/ci.yml

@@ -22,9 +22,9 @@ jobs:
       with:
         node-version: 14.x
     - name: install dependencies
-      run: yarn install
+      run: npm ci
     - name: linting
-      run: yarn lint
+      run: npm run lint
 
   test:
     name: Tests
@@ -41,9 +41,9 @@ jobs:
       with:
         node-version: ${{ matrix.node }}
     - name: install dependencies
-      run: yarn
+      run: npm ci
     - name: test
-      run: yarn test
+      run: npm test
 
   floating-test:
     name: Floating dependencies
@@ -55,6 +55,6 @@ jobs:
       with:
         node-version: '14.x'
     - name: install dependencies
-      run: yarn install --no-lockfile
+      run: npm install --no-shrinkwrap
     - name: test
-      run: yarn test
+      run: npm test

README.md

@@ -2,24 +2,14 @@
 
 codemod-cli is a command line tool for generating, testing, and publishing codemods.
 
-## Installation
-
-```
-npm install --global codemod-cli
-
-# OR
-
-yarn global add codemod-cli
-```
-
 ## Usage
 
 The `codemod-cli` workflow is focused on managing a group of codemods.
 
 To get started you first need a project. You can generate a new codemod-cli project via:
 
 ```
-codemod-cli new <project-name>
+npx codemod-cli new <project-name>
 ```
 
 This will create a small project structure (`README.md`, `package.json`, etc) which is
@@ -28,8 +18,8 @@ ready to help you manage your codemods.
 Once you have a project, you can generate a new codemod:
 
 ```
-codemod-cli generate codemod <name of codemod> // jscodeshift js codemod
-codemod-cli generate codemod <name of codemod> -t=hbs // ember-template-recast hbs codemod
+npx codemod-cli generate codemod <name of codemod> // jscodeshift js codemod
+npx codemod-cli generate codemod <name of codemod> -t=hbs // ember-template-recast hbs codemod
 ```
 
 This will setup a new codemod within your project at `transforms/<name of codemod>/index.js`
@@ -38,14 +28,14 @@ along with a test harness, README, fixture directory, and an initial set of inpu
 Once you have tweaked your codemod and its fixtures to your liking, it is time to run your tests:
 
 ```
-codemod-cli test
+npx codemod-cli test
 ```
 
 As you develop your codemod you may need additional fixtures (e.g. to test various combinations of
 inputs). To generate a new fixture, run the following:
 
 ```
-codemod-cli generate fixture <name of codemod> <name of fixture>
+npx codemod-cli generate fixture <name of codemod> <name of fixture>
 ```
 
 This sets up two new files in `transforms/<name of codemod>/__testfixtures__/` using the fixture name
@@ -55,7 +45,7 @@ Once you have things just how you like them with your new codemod (and your test
 can update your project's README and your transforms README via:
 
 ```
-codemod-cli update-docs
+npx codemod-cli update-docs
 ```
 
 ### File Types
@@ -134,16 +124,15 @@ Contributing
 
 * `git clone git@github.com:rwjblue/codemod-cli.git`
 * `cd codemod-cli`
-* `yarn`
+* `npm ci`
 
 ### Linting
 
-* `yarn lint:js`
-* `yarn lint:js --fix`
+* `npm run lint`
 
 ### Running tests
 
-* `yarn test`
+* `npm test`
 
 ## License
 

RELEASE.md

@@ -31,7 +31,7 @@ Once the prep work is completed, the actual release is straight forward:
 * First, ensure that you have installed your projects dependencies:
 
 ```sh
-yarn install
+npm ci
 ```
 
 * Second, ensure that you have obtained a

commands/global/new.js

@@ -32,12 +32,6 @@ module.exports.handler = async function handler(options) {
       \`\`\`
       npx ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
 
-      # or
-
-      yarn global add ${projectName}
-      ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
-      \`\`\`
-
       ## Local Usage
       \`\`\`
       node .${cliPath} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
@@ -54,15 +48,15 @@ module.exports.handler = async function handler(options) {
 
       * clone the repo
       * change into the repo directory
-      * \`yarn\`
+      * \`npm ci\`
 
       ### Running tests
 
-      * \`yarn test\`
+      * \`npm test\`
 
       ### Update Documentation
 
-      * \`yarn update-docs\`
+      * \`npm run update-docs\`
     `,
     'utf8'
   );
@@ -173,9 +167,9 @@ module.exports.handler = async function handler(options) {
             with:
               node-version: 12.x
           - name: install dependencies
-            run: yarn install --frozen-lockfile
+            run: npm ci
           - name: linting
-            run: yarn lint
+            run: npm run lint
 
         test:
           name: Tests
@@ -191,9 +185,9 @@ module.exports.handler = async function handler(options) {
             with:
               node-version: \${{ matrix.node }}
           - name: install dependencies
-            run: yarn install --frozen-lockfile
+            run: npm ci
           - name: test
-            run: yarn test
+            run: npm test
 
         floating-test:
           name: Floating dependencies
@@ -205,9 +199,9 @@ module.exports.handler = async function handler(options) {
             with:
               node-version: '12.x'
           - name: install dependencies
-            run: yarn install --no-lockfile
+            run: npm install --no-shrinkwrap
           - name: test
-            run: yarn test
+            run: npm test
     `
   );
   fs.outputFileSync(

commands/local/generate/codemod.js

@@ -79,11 +79,6 @@ function jsHandler(options) {
 
       \`\`\`
       npx ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
-
-      # or
-
-      yarn global add ${projectName}
-      ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
       \`\`\`
 
       ## Local Usage
@@ -163,11 +158,6 @@ function hbsHandler(options) {
 
       \`\`\`
       npx ${projectName} ${codemodName} path/of/files/ or/some**/*glob.hbs
-
-      # or
-
-      yarn global add ${projectName}
-      ${projectName} ${codemodName} path/of/files/ or/some**/*glob.hbs
       \`\`\`
 
       ## Local Usage

commands/local/update-docs.js

@@ -84,7 +84,8 @@ function updateTransformREADME(transformName) {
   let transformREADMEPath = `transforms/${transformName}/README.md`;
 
   let FIXTURES_TOC_PLACE_HOLDER = /<!--FIXTURES_TOC_START-->[\s\S]*<!--FIXTURES_TOC_END-->/;
-  let FIXTURES_CONTENT_PLACE_HOLDER = /<!--FIXTURES_CONTENT_START-->[\s\S]*<!--FIXTURE[S]?_CONTENT_END-->/;
+  let FIXTURES_CONTENT_PLACE_HOLDER =
+    /<!--FIXTURES_CONTENT_START-->[\s\S]*<!--FIXTURE[S]?_CONTENT_END-->/;
 
   fs.writeFileSync(
     transformREADMEPath,