feat(esm): move to ESM in this module and in the configurations it generates

BREAKING CHANGE: You will have to be careful about file extensions - cjs/cts vs. js/ts

Author: djMax

.github/workflows/npm_publish.yml

@@ -33,7 +33,10 @@ jobs:
       - run: yarn install --immutable
       - run: yarn build
 
-      - run: npm publish --access public
+      - name: Release
         env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm whoami
+          yarn dlx semantic-release

.gitignore

@@ -60,6 +60,7 @@ Thumbs.db
 .npmignore
 tsconfig.json
 tsconfig.build.json
-jest.config.js
-.prettierrc.js
-.eslintrc.js
+.commitlintrc.json
+jest.config.cjs
+.prettierrc.cjs
+.eslintrc.cjs

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

coconfig.ts

@@ -1,4 +1,4 @@
-import { config } from './src';
+import { config } from './src/index';
 
 // During the initial creation of tsconfig. sythentic default imports are not allowed.
 // This is here so we can handle both pre and post initial creation

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@openapi-typescript-infra/coconfig",
-  "version": "1.0.1",
+  "version": "0.0.0",
   "description": "Default Node.js configuration files for openapi-typescript-infra projects",
-  "main": "build/index.js",
+  "main": "./build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
     "test": "jest",
@@ -12,7 +12,8 @@
     "lint": "eslint .",
     "prepack": "pinst --disable",
     "postpack": "pinst --enable",
-    "postinstall": "husky install && coconfig"
+    "postinstall": "husky install && coconfig",
+    "semantic-release": "semantic-release"
   },
   "engines": {
     "node": ">12.0.0"
@@ -21,7 +22,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/openapi-typescript-infra/coconfig.git"
+    "url": "https://github.com/openapi-typescript-infra/coconfig.git"
   },
   "keywords": [
     "typescript",
@@ -30,7 +31,12 @@
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": "yarn eslint --cache --fix"
   },
+  "release": {
+    "branches": ["main"]
+  },
   "devDependencies": {
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
     "@types/jest": "^29.5.1",
     "@types/node": "^18.16.14",
     "@typescript-eslint/eslint-plugin": "^5.59.7",
@@ -44,6 +50,7 @@
     "jest": "^29.5.0",
     "lint-staged": "^13.2.2",
     "pinst": "^3.0.0",
+    "semantic-release": "^21.0.2",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"

src/index.ts

@@ -14,9 +14,9 @@ interface OtiCoConfig {
   '.npmignore': string,
   'tsconfig.json': CoConfigPassthroughEntry<typeof tsconfig>,
   'tsconfig.build.json': CoConfigPassthroughEntry<typeof tsconfigBuild>,
-  'jest.config.js': CoConfigPassthroughEntry,
-  '.prettierrc.js': CoConfigPassthroughEntry,
-  '.eslintrc.js': CoConfigPassthroughEntry,
+  'jest.config.cjs': CoConfigPassthroughEntry,
+  '.prettierrc.cjs': CoConfigPassthroughEntry,
+  '.eslintrc.cjs': CoConfigPassthroughEntry,
   '.commitlintrc.json': CoConfigPassthroughEntry,
 }
 
@@ -25,8 +25,8 @@ export const config: OtiCoConfig = {
   '.npmignore': fs.readFileSync(path.resolve(__dirname, '../templates/npmignore'), 'utf8'),
   'tsconfig.json': { configuration: tsconfig, stringify: true },
   'tsconfig.build.json': { configuration: tsconfigBuild, stringify: true },
-  'jest.config.js': { configuration: jestConfig },
-  '.prettierrc.js': { configuration: prettierConfig },
-  '.eslintrc.js': { configuration: eslintRc },
-  '.commitlintrc.json': { configuration: commitLint },
+  'jest.config.cjs': { configuration: jestConfig },
+  '.prettierrc.cjs': { configuration: prettierConfig },
+  '.eslintrc.cjs': { configuration: eslintRc },
+  '.commitlintrc.json': { configuration: commitLint, stringify: true },
 };

src/tsconfig.ts

@@ -4,18 +4,19 @@ export const tsconfig = {
   'ts-node': {
     transpileOnly: true,
     files: true,
+    esm: true,
   },
   compilerOptions: {
     lib: ['ES2022', 'DOM'],
-    module: 'CommonJS',
+    module: 'Node16',
+    moduleResolution: 'node16',
     target: 'ES2022',
     declaration: true,
     sourceMap: true,
     outDir: './build',
     incremental: true,
     isolatedModules: true,
     strict: true,
-    moduleResolution: 'NodeNext',
     baseUrl: './src',
     allowSyntheticDefaultImports: true,
     esModuleInterop: true,