Merge pull request #16 from AthennaIO/develop

Migrate project to TS

.github/workflows/cd.yml

@@ -20,9 +20,14 @@ jobs:
 
       - name: Install dependencies
         run: npm install
+
+      - name: Transpile code
+        run: npm run build
+
       - name: Automatic GitHub Release
         uses: justincy/[email protected]
         id: release
+
       - name: Publish to NPM Registry
         run: npm publish --access public
         if: steps.release.outputs.released == 'true'

.github/workflows/ci.yml

@@ -27,9 +27,13 @@ jobs:
 
       - name: Install dependencies
         run: npm install
+
       - name: Run tests
         run: npm run test:coverage
 
+      - name: Test code transpilation
+        run: npm run build
+
   windows:
     runs-on: windows-latest
     strategy:
@@ -46,5 +50,9 @@ jobs:
 
       - name: Install dependencies
         run: npm install
+
       - name: Run tests
         run: npm run test:coverage
+
+      - name: Test code transpilation
+        run: npm run build

.gitignore

@@ -114,8 +114,13 @@ out
 .yarn/install-state.gz
 .pnp.*
 
+# Transpiled code path
+dist
+build
+
 # IDE
 .idea
+.fleet
 .vscode
 
 # Environment variables file

bin/japaTypes.ts

@@ -0,0 +1,25 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare module '@japa/assert' {
+  export interface Assert {
+    throws(fn: () => void, errType: any, message?: string): void
+    doesNotThrows(fn: () => void, errType: any, message?: string): void
+    rejects(
+      fn: () => void | Promise<void>,
+      errType: any,
+      message?: string,
+    ): Promise<void>
+    doesNotRejects(
+      fn: () => void | Promise<void>,
+      errType: any,
+      message?: string,
+    ): Promise<void>
+  }
+}

tests/index.js → bin/test.ts

@@ -1,8 +1,19 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 import { pathToFileURL } from 'url'
 import { assert } from '@japa/assert'
 import { specReporter } from '@japa/spec-reporter'
 import { processCliArgs, configure, run } from '@japa/runner'
 
+import('./japaTypes.js')
+
 /*
 |--------------------------------------------------------------------------
 | Configure tests
@@ -17,10 +28,12 @@ import { processCliArgs, configure, run } from '@japa/runner'
 | Please consult japa.dev/runner-config for the config docs.
 */
 
+process.env.IS_TS = 'true'
+
 configure({
   ...processCliArgs(process.argv.slice(2)),
   ...{
-    files: ['tests/**/*Test.js'],
+    files: ['tests/**/*Test.ts'],
     plugins: [assert()],
     reporters: [specReporter()],
     importer: filePath => import(pathToFileURL(filePath).href),