feat: Only export as ESM.

Author: ShogunPanda

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Use Node.js LTS
         uses: actions/setup-node@v2
         with:
-          node-version: 12.x
+          node-version: lts/*
       - name: Restore cached dependencies
         uses: actions/cache@v2
         with:

README.md

@@ -40,9 +40,12 @@ If the UI is enabled, it will be reachable at `/${prefix}`.
 ## Example
 
 ```js
-const server = require('fastify')()
+import fastify from 'fastify'
+import fastifyOpenapiDocs from 'fastify-openapi-docs'
 
-server.register(require('fastify-openapi-docs'), {
+const server = fastify()
+
+server.register(fastifyOpenapiDocs, {
   openapi: {
     // All these fields are optional, but they should be provided to satisfy OpenAPI specification.
     openapi: '3.0.3',

package.json

@@ -23,42 +23,43 @@
     "LICENSE.md",
     "README.md"
   ],
-  "main": "dist/cjs/index.js",
-  "exports": {
-    "require": "./dist/cjs/index.js",
-    "import": "./dist/mjs/index.mjs"
-  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
   "typings": "types/index.d.ts",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "eslint src/*.ts test/*.ts",
-    "test": "tap --reporter=spec --coverage-report=html --coverage-report=text --no-browser test/*.test.ts",
-    "test:ci": "tap --no-color --reporter=spec --coverage-report=json --coverage-report=text --branches 90 --functions 90 --lines 90 --statements 90 test/*.test.ts",
-    "ci": "npm run lint && npm run test:ci",
     "prebuild": "rm -rf dist types && npm run lint",
-    "build": "tsc -p . && tsc -p tsconfig.modules.json && renamer --find js --replace mjs dist/mjs/* >> /dev/null && jscodeshift -s --extensions=mjs -t node_modules/@cowtech/esm-package-utils dist/mjs/**",
+    "build": "tsc -p . && esm-pkg-add-imports-extensions dist",
+    "format": "prettier -w src test",
+    "lint": "eslint src test",
+    "test": "c8 --reporter=text --reporter=html esm-ts-tap --reporter=spec --no-coverage test/*.test.ts",
+    "test:ci": "c8 --reporter=text --reporter=json --check-coverage --branches 90 --functions 90 --lines 90 --statements 90 esm-ts-tap --no-color --no-coverage test/*.test.ts",
+    "ci": "npm run lint && npm run test:ci",
     "prepublishOnly": "npm run ci",
     "postpublish": "git push origin && git push origin -f --tags"
   },
   "dependencies": {
     "fastify-plugin": "^3.0.0",
-    "fastify-static": "^3.3.0",
-    "js-yaml": "^3.14.1",
-    "swagger-ui-dist": "^3.38.0"
+    "fastify-static": "^4.2.3",
+    "js-yaml": "^4.1.0",
+    "swagger-ui-dist": "^4.0.0-beta.4"
   },
   "devDependencies": {
-    "@cowtech/eslint-config": "^7.14.0",
-    "@cowtech/esm-package-utils": "^0.2.0",
-    "@types/js-yaml": "^3.12.5",
-    "@types/node": "^14.14.19",
-    "@types/swagger-ui-dist": "^3.30.0",
-    "@types/tap": "^14.10.1",
-    "fastify": "^3.9.2",
-    "prettier": "^2.2.1",
-    "tap": "^14.11.0",
-    "typescript": "^4.1.3"
+    "@cowtech/eslint-config": "^7.14.5",
+    "@cowtech/esm-package-utils": "^0.9.0",
+    "@types/js-yaml": "^4.0.2",
+    "@types/node": "^16.6.1",
+    "@types/swagger-ui-dist": "^3.30.1",
+    "@types/tap": "^15.0.5",
+    "c8": "^7.8.0",
+    "fastify": "^3.20.2",
+    "prettier": "^2.3.2",
+    "tap": "^15.0.9",
+    "ts-node": "^10.2.0",
+    "typescript": "^4.2.4"
   },
   "engines": {
-    "node": ">=12.15.0"
+    "node": ">=14.15.0"
   }
 }

prettier.config.js renamed to prettier.config.cjs

@@ -63,10 +63,3 @@ export const plugin = fastifyPlugin(
 )
 
 export default plugin
-
-// Fix CommonJS exporting
-/* istanbul ignore else */
-if (typeof module !== 'undefined') {
-  module.exports = plugin
-  Object.assign(module.exports, exports)
-}

src/index.ts

@@ -109,16 +109,16 @@ info:
   description: Description
   contact:
     name: Shogun
-    url: 'https://cowtech.it'
+    url: https://cowtech.it
     email: shogun@cowtech.it
   license:
     name: ISC
-    url: 'https://choosealicense.com/licenses/isc/'
+    url: https://choosealicense.com/licenses/isc/
   version: 1.0.0
 servers:
-  - url: 'https://example.com'
+  - url: https://example.com
     description: Production Server
-  - url: 'https://dev.example.com'
+  - url: https://dev.example.com
     description: Development Server
 tags:
   - name: service

test/spec.test.ts

@@ -1,10 +1,11 @@
 {
   "compilerOptions": {
-    "target": "es2019",
-    "module": "commonjs",
+    "target": "ES2020",
+    "module": "ESNext",
     "moduleResolution": "node",
     "jsx": "preserve",
-    "outDir": "dist/cjs",
+    "declaration": true,
+    "outDir": "dist",
     "declarationDir": "types",
     "allowJs": false,
     "allowSyntheticDefaultImports": true,
@@ -13,8 +14,7 @@
     "noImplicitAny": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "strictNullChecks": true,
-    "declaration": true
+    "strictNullChecks": true
   },
   "include": ["src/*.ts"],
   "exclude": []