Merge pull request #21 from homer0/next

Drop Yarn, Node < 18, and update dependences

.eslintrc

@@ -4,5 +4,12 @@
   "extends": [
     "plugin:@homer0/node-with-prettier",
     "plugin:@homer0/jsdoc"
-  ]
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module"
+  },
+  "rules": {
+    "node/no-unsupported-features/es-syntax": "off"
+  }
 }

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,8 +4,6 @@
 
 ```bash
 npm test
-# or
-yarn test
 ```
 
 ### TODOs

.github/workflows/release.yml

@@ -10,25 +10,23 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Read .nvmrc
-        run: echo "::set-output name=NVMRC::$(cat .nvmrc)"
-        id: nvm
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - name: Node.js
+        uses: actions/setup-node@v3
         with:
-          node-version: '${{ steps.nvm.outputs.NVMRC }}'
+          node-version-file: '.nvmrc'
       - name: Install dependencies
         env:
           HUSKY: 0
-        run: yarn --frozen-lockfile
-      - run: yarn semantic-release
+        run: npm ci
+      - run: npx semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Generate documentation
-        run: yarn docs
+        run: npm run docs
       - name: Deploy documentation
-        uses: JamesIves/github-pages-deploy-action@4.1.1
+        uses: JamesIves/github-pages-deploy-action@4
         with:
           BRANCH: gh-pages
           FOLDER: docs

.github/workflows/test.yml

@@ -7,18 +7,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '14', '16' ]
+        node: [ '18', '20' ]
     name: Run jest and ESLint (Node ${{ matrix.node }})
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
-      - run: yarn --frozen-lockfile
-      - run: yarn lint:all
-      - run: yarn test
+      - run: npm ci
+      - run: npm run lint:all
+      - run: npm test
       - name: Coveralls
-        if: ${{ matrix.node == '14' }}
+        if: ${{ matrix.node == '18' }}
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

.husky/commit-msg

@@ -1,9 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-if hash yarn 2>/dev/null; then
-  yarn commitlint --edit $1
-else
-  npx commitlint --edit $1
-fi
+npx commitlint --edit $1
 

.husky/post-merge

@@ -1,9 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-if hash yarn 2>/dev/null; then
-  yarn
-else
-  npm install
-fi
+npm install
 

.husky/pre-commit

@@ -1,8 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-if hash yarn 2>/dev/null; then
-  yarn run lint
-else
-  npm run lint
-fi
+npm run lint

.husky/pre-push

@@ -1,8 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-if hash yarn 2>/dev/null; then
-  yarn test
-else
-  npm test
-fi
+npm test

.npmignore

@@ -4,4 +4,5 @@ docs
 documents
 tests
 utils
+npm-debug.log
 yarn-error.log

.nvmrc

@@ -1 +1 @@
-14
+18

.prettierrc.js

@@ -0,0 +1,6 @@
+const base = require('@homer0/prettier-config');
+
+module.exports = {
+  ...base,
+  plugins: ['@homer0/prettier-plugin-jsdoc'],
+};

README.md

@@ -1,17 +1,16 @@
 # CJS 2 ESM
 
-[![GitHub Workflow Status (main)](https://img.shields.io/github/workflow/status/homer0/cjs2esm/Test/main?style=flat-square)](https://github.com/homer0/cjs2esm/actions?query=workflow%3ATest)
-[![Coveralls github](https://img.shields.io/coveralls/github/homer0/cjs2esm.svg?style=flat-square)](https://coveralls.io/github/homer0/cjs2esm?branch=main)
-[![David](https://img.shields.io/david/homer0/cjs2esm.svg?style=flat-square)](https://david-dm.org/homer0/cjs2esm)
-[![David](https://img.shields.io/david/dev/homer0/cjs2esm.svg?style=flat-square)](https://david-dm.org/homer0/cjs2esm)
+[![GitHub Workflow Status (main)](https://img.shields.io/github/actions/workflow/status/homer0/cjs2esm/test.yml?branch=main&style=flat-square)](https://github.com/homer0/cjs2esm/actions/workflows/test.yml?query=branch%3Amain)
+[![Coveralls GitHub](https://img.shields.io/coveralls/github/homer0/cjs2esm.svg?style=flat-square)](https://coveralls.io/github/homer0/cjs2esm?branch=main)
+![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/cjs2esm?style=flat-square)
 
 Transforms a project that uses CommonJS to ES Modules.
 
 ## 📝 Introduction
 
 > If you are wondering why I built this, go to the [Motivation](#motivation) section.
 
-You can use this tool to transform a project that uses **CommonJS** to **ES Modules** and get it ready for Node `v14`, any module bundler with **ESM** support, or even [`typedef` imports on JSDoc](https://github.com/homer0/jsdoc-ts-utils#import-type-defintions).
+You can use this tool to transform a project that uses **CommonJS** to **ES Modules** and get it ready for an ESM world, any module bundler with **ESM** support, or even [`typedef` imports on JSDoc](https://github.com/homer0/jsdoc-ts-utils#import-type-defintions).
 
 This tool internally uses [`jscodeshift`](https://github.com/facebook/jscodeshift) with the transformations from [`5to6`](https://github.com/5to6/5to6-codemod) and an extra one created to fix missing extensions.
 
@@ -64,11 +63,12 @@ The package comes with a binary that you can execute from your `package.json`, o
 # From the package.json
 cjs2esm
 
+# NPM
+npx cjs2esm
+
 # Yarn
 yarn cjs2esm
 
-# NPM
-npx cjs2esm
 ```
 
 ### Configuration
@@ -252,18 +252,21 @@ Yes, if you want to use the tool as a library, the tool uses itself to generate
 
 ```js
 // commonjs
-const { getConfiguration } = require('cjs2esm');
+const { prepare, getConfiguration } = require('cjs2esm');
 
 // ESM
-import { getConfiguration } from 'cjs2esm/esm';
+import { prepare, getConfiguration } from 'cjs2esm/esm';
 
 // #dogfooding
 ```
+
+> Check `src/index.js` to see how the API is used.
+
 ## ⚙️ Development
 
-### NPM/Yarn tasks
+### Scripts
 
-| Task       | Description                         |
+| Script     | Description                         |
 |------------|-------------------------------------|
 | `test`     | Run the project unit tests.         |
 | `lint`     | Lint the modified files.            |
@@ -274,7 +277,7 @@ import { getConfiguration } from 'cjs2esm/esm';
 
 ### Repository hooks
 
-I use [`husky`](https://yarnpkg.com/package/husky) to automatically install the repository hooks so the code will be tested and linted before any commit, and the dependencies updated after every merge.
+I use [`husky`](https://www.npmjs.com/package/husky) to automatically install the repository hooks so the code will be tested and linted before any commit, and the dependencies updated after every merge.
 
 #### Commits convention
 
@@ -284,7 +287,7 @@ The configuration is on the `commitlint` property of the `package.json`.
 
 ### Releases
 
-I use [`semantic-release`](https://yarnpkg.com/package/semantic-release) and a GitHub action to automatically release on NPM everything that gets merged to main.
+I use [`semantic-release`](https://www.npmjs.com/package/semantic-release) and a GitHub action to automatically release on NPM everything that gets merged to main.
 
 The configuration for `semantic-release` is on `./releaserc` and the workflow for the release is on `./.github/workflow/release.yml`.
 
@@ -296,9 +299,9 @@ The configuration file is on `./.jestrc.js`, the tests are on `./tests` and the
 
 ### Linting && Formatting
 
-I use [ESlint](https://eslint.org) with [my own custom configuration](https://yarnpkg.com/en/package/@homer0/eslint-plugin) to validate all the JS code. The configuration file for the project code is on `./.eslintrc` and the one for the tests is on `./tests/.eslintrc`. There's also an `./.eslintignore` to exclude some files on the process. The script that runs it is on `./utils/scripts/lint-all`.
+I use [ESlint](https://eslint.org) with [my own custom configuration](https://www.npmjs.com/package/@homer0/eslint-plugin) to validate all the JS code. The configuration file for the project code is on `./.eslintrc` and the one for the tests is on `./tests/.eslintrc`. There's also an `./.eslintignore` to exclude some files on the process. The script that runs it is on `./utils/scripts/lint-all`.
 
-For formatting I use [Prettier](https://prettier.io) with [my custom configuration](https://yarnpkg.com/en/package/@homer0/prettier-config). The configuration file for the project code is on `./.prettierrc`.
+For formatting I use [Prettier](https://prettier.io) with [my custom configuration](https://www.npmjs.com/package/@homer0/prettier-config). The configuration file for the project code is on `./.prettierrc`.
 
 ### Documentation
 
@@ -308,7 +311,7 @@ The configuration file is on `./.jsdoc.js` and the script that runs it is on `./
 
 ### To-Dos
 
-I use `@todo` comments to write all the pending improvements and fixes, and [Leasot](https://yarnpkg.com/en/package/leasot) to generate a report. The script that runs it is on `./utils/scripts/todo`.
+I use `@todo` comments to write all the pending improvements and fixes, and [Leasot](https://www.npmjs.com/package/leasot) to generate a report. The script that runs it is on `./utils/scripts/todo`.
 
 ## 💡 Motivation