Merge pull request #80 from AthennaIO/develop

refactor(scripts): use scripts to build code

.github/workflows/cd.yml

@@ -21,14 +21,8 @@ jobs:
       - name: Install dependencies
         run: npm install
 
-      - name: Transpile code
-        run: npm run build
-
-      - name: Install jq
-        run: sudo apt-get -y install jq
-
-      - name: Change import aliases to build
-        run: jq '.imports."#src"="./build/index.js" | .imports."#src/*"="./build/*.js"'  package.json > tmp.json && mv tmp.json package.json
+      - name: Compile code
+        run: sh scripts/build
 
       - name: Automatic GitHub Release
         uses: justincy/[email protected]

.github/workflows/ci.yml

@@ -42,8 +42,8 @@ jobs:
       - name: Run tests
         run: npm run test:coverage
 
-      - name: Test code transpilation
-        run: npm run build
+      - name: Test code compilation
+        run: sh scripts/build
 
   windows:
     runs-on: windows-latest
@@ -65,5 +65,5 @@ jobs:
       - name: Run tests
         run: npm run test:coverage
 
-      - name: Test code transpilation
-        run: npm run build
+      - name: Test code compilation
+        run: sh scripts/build

.gitignore

@@ -114,9 +114,15 @@ out
 .yarn/install-state.gz
 .pnp.*
 
-# Transpiled code path
-dist
-build
+# Compiled code
+./dist
+./build
+*.js
+*.d.ts
+*.js.map
+!tests/Stubs/**/*.js
+!tests/Stubs/**/*.d.ts
+!tests/Stubs/**/*.js.map
 
 # IDE
 .idea

node

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# This file is useful for development purposes because
+# it allows you to run TypeScript files without having
+# to add the --loader option every time.
+
+# Usage:
+
+# ./node --version
+# ./node bin/test.ts
+# ./node --inspect bin/test.ts
+
+# Usage with "sh" or "bash":
+
+# sh node --version
+# sh node bin/test.ts
+# sh node --inspect bin/test.ts
+
+# Node.js executable with all arguments required to run the application.
+node="node --loader ts-node/esm --experimental-import-meta-resolve --no-warnings"
+
+$node $@

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/test",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "The Athenna test runner. Built on top of Japa.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -10,39 +10,41 @@
   "keywords": [
     "esm",
     "japa",
+    "testing",
+    "test-runner",
     "classes",
     "decorators",
     "athenna"
   ],
   "scripts": {
-    "node": "cross-env NODE_OPTIONS=\"--experimental-import-meta-resolve\" ts-node",
-    "build": "npm run node --silent -- bin/build.ts",
-    "lint:fix": "eslint \"{src,tests}/**/*.ts\" --fix",
-    "test": "npm run --silent lint:fix && npm run node --silent -- bin/test.ts",
-    "test:debug": "cross-env DEBUG=api:* npm run node --silent -- bin/test.ts --inspect",
+    "lint:fix": "eslint \"{bin,src,tests}/**/*.ts\" --fix",
+    "test": "npm run --silent lint:fix && sh node bin/test.ts",
+    "test:debug": "cross-env DEBUG=api:* sh node --inspect bin/test.ts",
     "test:coverage": "c8 npm run --silent test"
   },
   "files": [
-    "build/*.js",
-    "build/*.d.ts",
-    "build/**/*.js",
-    "build/**/*.d.ts",
-    "templates/**"
+    "src/*.js",
+    "src/*.d.ts",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "templates"
   ],
   "type": "module",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "exports": {
-    ".": "./build/index.js"
+    ".": "./src/index.js"
   },
   "imports": {
+    "#bin/*": "./bin/*.js",
+    "#bin": "./bin/index.js",
     "#src/*": "./src/*.js",
     "#src": "./src/index.js",
     "#tests/*": "./tests/*.js",
     "#tests": "./tests/index.js"
   },
   "devDependencies": {
-    "@athenna/common": "^3.3.1",
+    "@athenna/common": "^3.4.4",
     "@japa/assert": "^1.3.6",
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",

scripts/build

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+sh scripts/clean
+
+./node_modules/.bin/tsc --project scripts/tsconfig.build.json

scripts/clean

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+find src -name "*.js" -type f -delete
+find src -name "*.d.ts" -type f -delete

scripts/tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["../**/*"],
+  "exclude": ["../bin", "../build", "../tests", "../scripts", "../node_modules"]
+}

tsconfig.json

@@ -6,16 +6,23 @@
   "compilerOptions": {
     "strict": false,
     "rootDir": ".",
-    "outDir": "build",
-    "module": "ESNext",
+    "baseUrl": ".",
+    "outDir": ".",
+    "module": "NodeNext",
     "target": "ESNext",
     "declaration": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
     "removeComments": false,
     "resolveJsonModule": true,
+    "experimentalDecorators": true,
     "moduleResolution": "NodeNext",
-    "experimentalDecorators": true
+    "paths": {
+      "#bin/*": ["./bin/*.ts"],
+      "#src/*": ["./src/*.ts"],
+      "#tests/*": ["./tests/*.ts"]
+    }
   },
-  "exclude": ["node_modules"]
+  "include": ["./**/*"],
+  "exclude": ["build", "node_modules"]
 }