build(npm): move from yarn to npm (#146)

cdcabrera · Apr 21, 2024 · bdb21de · bdb21de
1 parent b85ffcb
commit bdb21de
Show file tree

Hide file tree

Showing 12 changed files with 12,789 additions and 6,679 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,13 +9,15 @@
 <!-- Are there directions to test/review? -->
 <!--
 ### Coverage and basic unit test check
-1. update the NPM packages with `$ yarn`
-1. `$ yarn test`
+1. update the NPM packages with `$ npm install`
+1. `$ npm test`
+-->
+
+<!--
 ### Interactive unit test check
-1. update the NPM packages with `$ yarn`
-1. `$ yarn test:dev`
+1. update the NPM packages with `$ npm install`
+1. `$ npm run test:dev`
 -->
-...
 
 ## Example
 <!-- Append a demo/screenshot/animated gif, or a link to the aforementioned, of the cli output -->

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -33,20 +33,20 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: yarn
+          cache: npm
       - name: Node.js modules cache
         uses: actions/cache@v4
         id: modules-cache
         with:
           path: ${{ github.workspace }}/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.node-version }}-modules
       - name: Install Node.js packages
         if: ${{ steps.modules-cache.outputs.cache-hit != 'true' }}
-        run: yarn install
+        run: npm install
       - name: Setup coverage report
-        run: yarn test:coverage
+        run: npm run test:coverage
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

diff --git a/.github/workflows/documentation_lint.yml b/.github/workflows/documentation_lint.yml
@@ -16,20 +16,20 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: yarn
+          cache: npm
       - name: Node.js modules cache
         uses: actions/cache@v4
         id: modules-cache
         with:
           path: ${{ github.workspace }}/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.node-version }}-modules
       - name: Install Node.js packages
         if: ${{ steps.modules-cache.outputs.cache-hit != 'true' }}
-        run: yarn install
+        run: npm install
       - name: Build
-        run: yarn build:docs
+        run: npm run build:docs
       - name: Git modified files
         if: ${{ success() }}
         run: |

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -16,20 +16,20 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: yarn
+          cache: npm
       - name: Node.js modules cache
         uses: actions/cache@v4
         id: modules-cache
         with:
           path: ${{ github.workspace }}/node_modules
-          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-${{ matrix.node-version }}-modules-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.node-version }}-modules
       - name: Install Node.js packages
         if: ${{ steps.modules-cache.outputs.cache-hit != 'true' }}
-        run: yarn install
+        run: npm install
       - name: Lint and test
-        run: yarn test
+        run: npm test
       - name: Confirm integration
         if: ${{ success() }}
-        run: yarn test:integration
+        run: npm run test:integration
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
 # dependencies
 node_modules
-package-lock.json
 .yarn-integrity
 
 # coverage

diff --git a/.npmrc b/.npmrc
diff --git a/README.md b/README.md
@@ -8,9 +8,7 @@ Generate a changelog with [conventional commit types](https://www.conventionalco
 ## Requirements
 The basic requirements:
  * [NodeJS version 16+](https://nodejs.org/)
- * Optionally your system could be running
-    - [Yarn](https://yarnpkg.com), otherwise NPM should be adequate.
-
+ * NPM
 
 ## Use
 
@@ -21,12 +19,6 @@ NPM install...
   ```shell
     $ npm i changelog-light
   ```
-
-or Yarn
-
-  ```shell
-    $ yarn add changelog-light
-  ```
 
 #### CLI Usage
 ```