feat: use esm

BREAKING CHANGE: move code base to esm

Signed-off-by: Vitor Hugo Salgado <[email protected]>

Author: vitorsalgado

.dockerignore

@@ -119,5 +119,4 @@ dist
 .github/
 
 docs/
-dist/
 tools/

.eslintrc.cjs

@@ -5,7 +5,7 @@ module.exports = {
   extends: ['plugin:@typescript-eslint/recommended'],
   env: {
     jest: true,
-    node: true
+    node: true,
   },
   rules: {
     'no-console': 'error',
@@ -14,6 +14,6 @@ module.exports = {
     '@typescript-eslint/no-useless-constructor': ['error'],
     '@typescript-eslint/no-inferrable-types': ['off'],
 
-    'import/extensions': ['error', 'ignorePackages', { js: 'always', jsx: 'never', ts: 'never', tsx: 'never' }]
-  }
+    'import/extensions': ['error', 'ignorePackages', { js: 'always', jsx: 'never', ts: 'never', tsx: 'never' }],
+  },
 }

.prettierrc.json

@@ -1,5 +1,5 @@
 {
-  "trailingComma": "none",
+  "trailingComma": "all",
   "printWidth": 120,
   "singleQuote": true,
   "arrowParens": "avoid",

.versionrc.js

@@ -10,6 +10,6 @@ module.exports = {
     { type: 'refactor', section: 'Refactor', hidden: false },
     { type: 'perf', section: 'Perf', hidden: false },
     { type: 'test', section: 'Refactor', hidden: false },
-    { type: 'build', section: 'Build', hidden: false }
-  ]
+    { type: 'build', section: 'Build', hidden: false },
+  ],
 }

Makefile

@@ -5,26 +5,29 @@ SHELL := /bin/bash
 help:
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
 
-up: ## Run a development environment with Docker Compose.
-	@docker-compose -f ./deployments/dev/docker-compose.yml up
+up: ## Run a local development environment with Docker Compose.
+	@docker-compose -f ./deployments/dev/docker-compose.yml up --build --force-recreate
 
-down: ## Stop Docker Compose development environment.
+recreate: ## Recreate and run development docker compose
+	@docker-compose -f ./deployments/dev/docker-compose.yml up --build --force-recreate
+
+down: ## Stop Docker Compose local development environment.
 	@docker-compose -f ./deployments/dev/docker-compose.yml down
 
-clean: ## Clean Docker Compose development environment.
+clean: ## Clean Docker Compose local development environment.
 	@docker-compose -f ./deployments/dev/docker-compose.yml down --remove-orphans --volumes
 
 .PHONY: test
-test:
+test: ## Run tests
 	@npm test
 
-fmt: # Format code
+fmt: ## Format code
 	@npm run format
 
-lint: # Run static analysis
+lint: ## Run static analysis
 	@npm run lint
 
-check: # Run all checks for this project
+check: ## Run all checks for this project
 	@npm run format:check
 	@npm run lint
 	@npm run test

build/docker/Dockerfile.dev

@@ -1,7 +1,10 @@
 #!/usr/bin/env node
 
-const Path = require('path')
-const FsExt = require('fs-extra')
+import FsExt from 'fs-extra'
+import Path, { dirname } from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
 
 const paramOr = (map, arg, def) => map.get(arg) || def
 const makePath = (...p) => Path.join(...p)
@@ -38,7 +41,7 @@ const Ignores = [
   'Makefile',
   'package.json',
   'package-lock.json',
-  'yarn.lock'
+  'yarn.lock',
 ]
 
 const NoDeps = ['fs-extra', 'standard-release']
@@ -48,7 +51,7 @@ const Templates = [
   { file: 'README.md', copyTo: 'README.md' },
   { file: '.gitignore.husky', copyTo: '.husky/.gitignore' },
   { file: '.gitignore.root', copyTo: '.gitignore' },
-  { file: '.dockerignore.root', copyTo: '.dockerignore' }
+  { file: '.dockerignore.root', copyTo: '.dockerignore' },
 ]
 
 const PkgFieldsToKeep = ['scripts', 'dependencies', 'devDependencies']
@@ -86,7 +89,7 @@ function main() {
 Summary:
 Destination: ${destination}
 App: ${app}
-`
+`,
   )
 
   console.log('Copying Project Files ...')
@@ -102,7 +105,7 @@ App: ${app}
   const pkg = FsExt.readJsonSync(makePath(source, 'package.json'))
   const newPkg = {
     name: app,
-    main: 'dist/index.js'
+    main: 'dist/index.js',
   }
 
   PkgFieldsToKeep.forEach(field => {
@@ -128,4 +131,4 @@ App: ${app}
   return Promise.resolve()
 }
 
-main().catch(console.error)
+await main()

cmd/create-nodejs-ts/index.js

@@ -2,11 +2,12 @@ version: '3.8'
 
 services:
   dev-app:
-    build:
-      context: ./
-      dockerfile: ../../build/docker/Dockerfile.dev
-    container_name: nodejs-ts.dev-app
+    image: node:16.14.2
+    working_dir: /app
     volumes:
       - ../../:/app
+      - ../../node_modules:/app/node_modules
+      - ../../dist:/app/dist
+    command: bash -c "npm i --quiet --ignore-scripts && npm run start:dev"
     ports:
-      - 8080:8080
+      - "8080:8080"

deployments/dev/docker-compose.yml

@@ -1,15 +1,17 @@
 import 'dotenv/config'
-import type { Config as JestConfig } from '@jest/types'
 
-const config: JestConfig.InitialOptions = {
+export default {
   verbose: true,
   collectCoverage: false,
   restoreMocks: true,
-  transform: { '^.+\\.tsx?$': 'ts-jest' },
+  transform: {},
+  preset: 'ts-jest/presets/default-esm',
+  extensionsToTreatAsEsm: ['.ts'],
   globals: {
     'ts-jest': {
-      tsconfig: './tsconfig.test.json'
-    }
+      tsconfig: './tsconfig.test.json',
+      useESM: true,
+    },
   },
   collectCoverageFrom: ['**/src/*/**/*.ts', '!**/__fixtures__/**', '!**/__tests__/**'],
   coveragePathIgnorePatterns: ['<rootDir>/dist/', '/node_modules/', '<rootDir>/scripts', '<rootDir>/tools'],
@@ -19,9 +21,7 @@ const config: JestConfig.InitialOptions = {
       branches: 10,
       functions: 10,
       lines: 10,
-      statements: 10
-    }
-  }
+      statements: 10,
+    },
+  },
 }
-
-export default config

jest.config.ts renamed to jest.config.js

@@ -2,5 +2,5 @@
 
 module.exports = {
   '*.{js,jsx,ts,tsx,md,json}': 'prettier --write --ignore-unknown',
-  '*.ts': 'eslint --ext .ts .'
+  '*.ts': 'eslint --ext .ts .',
 }