Merge pull request #163 from AthennaIO/develop

feat(command): remove commands property dependency
AthennaIO · Mar 27, 2023 · 2ab305e · 2ab305e
2 parents 4f449c2 + e1f4dba
commit 2ab305e
Show file tree

Hide file tree

Showing 22 changed files with 87 additions and 88 deletions.
diff --git a/bin/artisan.ts b/bin/artisan.ts
@@ -25,16 +25,26 @@ import { Ignite } from '#src'
 
 process.env.CORE_TESTING = 'false'
 
-Config.set('rc.commands', [
-  '#src/Commands/MakeExceptionCommand',
-  '#src/Commands/MakeFacadeCommand',
-  '#src/Commands/MakeProviderCommand',
-  '#src/Commands/MakeServiceCommand',
-  '#src/Commands/MakeTestCommand',
-  '#src/Commands/ServeCommand',
-  '#src/Commands/BuildCommand',
-  '#src/Commands/TestCommand',
-])
+Config.set('rc.commands', {
+  'make:exception': '#src/Commands/MakeExceptionCommand',
+  'make:facade': '#src/Commands/MakeFacadeCommand',
+  'make:provider': '#src/Commands/MakeProviderCommand',
+  'make:service': '#src/Commands/MakeServiceCommand',
+  'make:test': '#src/Commands/MakeTestCommand',
+  build: '#src/Commands/BuildCommand',
+  serve: {
+    entrypoint: '#bin/http',
+    path: '#src/Commands/ServeCommand',
+  },
+  test: {
+    entrypoint: '#bin/test',
+    path: '#src/Commands/TestCommand',
+  },
+  repl: {
+    entrypoint: '#bin/repl',
+    path: '#src/Commands/ReplCommand',
+  },
+})
 
 /*
 |--------------------------------------------------------------------------

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@athenna/core",
-  "version": "3.3.4",
+  "version": "3.4.0",
   "description": "The plug and play Node.js framework.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -62,10 +62,10 @@
     "semver": "^7.3.8"
   },
   "devDependencies": {
-    "@athenna/artisan": "^3.4.0",
+    "@athenna/artisan": "^3.6.0",
     "@athenna/common": "^3.5.0",
     "@athenna/config": "^3.3.0",
-    "@athenna/http": "^3.5.0",
+    "@athenna/http": "^3.7.0",
     "@athenna/ioc": "^3.2.0",
     "@athenna/logger": "^3.2.0",
     "@athenna/test": "^3.3.0",
@@ -224,18 +224,7 @@
       "interceptor": "node_modules/@athenna/http/templates/interceptor.edge",
       "terminator": "node_modules/@athenna/http/templates/terminator.edge"
     },
-    "commands": [
-      "#src/Commands/MakeExceptionCommand",
-      "#src/Commands/MakeFacadeCommand",
-      "#src/Commands/MakeProviderCommand",
-      "#src/Commands/MakeServiceCommand",
-      "#src/Commands/MakeTestCommand",
-      "#src/Commands/ServeCommand",
-      "#src/Commands/BuildCommand",
-      "#src/Commands/TestCommand",
-      "#src/Commands/ReplCommand"
-    ],
-    "commandsManifest": {
+    "commands": {
       "make:exception": "#src/Commands/MakeExceptionCommand",
       "make:facade": "#src/Commands/MakeFacadeCommand",
       "make:provider": "#src/Commands/MakeProviderCommand",

diff --git a/src/Commands/BuildCommand.ts b/src/Commands/BuildCommand.ts
@@ -72,7 +72,7 @@ export class BuildCommand extends BaseCommand {
 
   private getTsConfig(): Promise<File> {
     const path = Config.get(
-      'rc.commandsManifest.build.tsconfig',
+      'rc.commands.build.tsconfig',
       '../../tmp/tsconfig.build.json',
     )
 

diff --git a/src/Commands/MakeExceptionCommand.ts b/src/Commands/MakeExceptionCommand.ts
@@ -51,7 +51,7 @@ export class MakeExceptionCommand extends BaseCommand {
    */
   private getDestinationPath(): string {
     let destination = Config.get(
-      'rc.commandsManifest.make:exception.destination',
+      'rc.commands.make:exception.destination',
       Path.app('Exceptions'),
     )
 

diff --git a/src/Commands/MakeFacadeCommand.ts b/src/Commands/MakeFacadeCommand.ts
@@ -51,7 +51,7 @@ export class MakeFacadeCommand extends BaseCommand {
    */
   private getDestinationPath(): string {
     let destination = Config.get(
-      'rc.commandsManifest.make:facade.destination',
+      'rc.commands.make:facade.destination',
       Path.facades(),
     )
 

diff --git a/src/Commands/MakeProviderCommand.ts b/src/Commands/MakeProviderCommand.ts
@@ -59,7 +59,7 @@ export class MakeProviderCommand extends BaseCommand {
    */
   private getDestinationPath(): string {
     let destination = Config.get(
-      'rc.commandsManifest.make:provider.destination',
+      'rc.commands.make:provider.destination',
       Path.providers(),
     )
 

diff --git a/src/Commands/MakeServiceCommand.ts b/src/Commands/MakeServiceCommand.ts
@@ -59,7 +59,7 @@ export class MakeServiceCommand extends BaseCommand {
    */
   private getDestinationPath(): string {
     let destination = Config.get(
-      'rc.commandsManifest.make:service.destination',
+      'rc.commands.make:service.destination',
       Path.app('Services'),
     )
 

diff --git a/src/Commands/MakeTestCommand.ts b/src/Commands/MakeTestCommand.ts
@@ -69,7 +69,7 @@ export class MakeTestCommand extends BaseCommand {
    */
   private getDestinationPath(): string {
     let destination = Config.get(
-      'rc.commandsManifest.make:test.destination',
+      'rc.commands.make:test.destination',
       this.isUnit ? Path.tests('Unit') : Path.tests('E2E'),
     )
 

diff --git a/src/Commands/ReplCommand.ts b/src/Commands/ReplCommand.ts
@@ -39,7 +39,7 @@ export class ReplCommand extends BaseCommand {
     }
 
     const entrypoint = Config.get(
-      'rc.commandsManifest.repl.entrypoint',
+      'rc.commands.repl.entrypoint',
       '#bootstrap/repl',
     )
 

diff --git a/src/Commands/ServeCommand.ts b/src/Commands/ServeCommand.ts
@@ -39,7 +39,7 @@ export class ServeCommand extends BaseCommand {
     }
 
     const entrypoint = Config.get(
-      'rc.commandsManifest.serve.entrypoint',
+      'rc.commands.serve.entrypoint',
       '#bootstrap/main',
     )
 

diff --git a/src/Commands/TestCommand.ts b/src/Commands/TestCommand.ts
@@ -39,7 +39,7 @@ export class TestCommand extends BaseCommand {
     }
 
     const entrypoint = Config.get(
-      'rc.commandsManifest.test.entrypoint',
+      'rc.commands.test.entrypoint',
       '#bootstrap/test',
     )
 

diff --git a/src/Ignite/Ignite.ts b/src/Ignite/Ignite.ts
@@ -331,7 +331,7 @@ export class Ignite {
       version: coreSemverVersion,
       athennaVersion: process.env.ATHENNA_VERSION,
       engines: pkgJson.engines || {},
-      commands: [],
+      commands: {},
       services: [],
       preloads: [],
       providers: [],
@@ -340,7 +340,6 @@ export class Ignite {
       namedMiddlewares: {},
       globalMiddlewares: {},
       environments: [],
-      commandsManifest: {},
     }
 
     const replaceableConfigs = {

diff --git a/src/Types/ArtisanOptions.ts b/src/Types/ArtisanOptions.ts
@@ -26,7 +26,7 @@ export type ArtisanOptions = {
   /**
    * The path to the ConsoleKernel. The console kernel is responsible to
    * register the exception handler, register the commands or register a single
-   * command by it's path if exists inside "rc.commandsManifest". By default,
+   * command by it's path if exists inside "rc.commands". By default,
    * Athenna will use the built in Kernel. But you can do your own implementation
    * extending the "ConsoleKernel" class from Artisan and setting the path to it
    * here.

diff --git a/src/Types/RcOptions.ts b/src/Types/RcOptions.ts
@@ -85,15 +85,11 @@ export interface RcOptions {
   globalMiddlewares?: string[]
 
   /**
-   * Set the commands that Athenna needs to register when running an Artisan command.
-   */
-  commands?: string[]
-
-  /**
-   * Set the commands manifest where the key is the signature of your command and the
+   * Set the commands where the key is the signature of your command and the
    * value is the path to your command. If the command that you are running is inside
-   * the commandsManifest property, Athenna will import ONLY that specific command,
-   * ignoring the entire "commands" array.
+   * the commands property, Athenna will import ONLY that specific command,
+   * ignoring the entire "commands" array. Unless you set the "loadAllCommands" property
+   * to true.
    */
-  commandsManifest?: Record<string, string | any>
+  commands?: Record<string, string | any>
 }
diff --git a/tests/Stubs/artisan.ts b/tests/Stubs/artisan.ts
@@ -25,15 +25,18 @@ import { Ignite } from '#src'
 
 process.env.CORE_TESTING = 'true'
 
-Config.set('rc.commandsManifest.test', {
+Config.set('rc.commands.test', {
   path: '#src/Commands/TestCommand',
   entrypoint: '#tests/Stubs/tests/main',
 })
-Config.set('rc.commandsManifest.repl', {
+Config.set('rc.commands.repl', {
   path: '#src/Commands/ReplCommand',
   entrypoint: '#tests/Stubs/bootstrap/repl',
 })
-Config.set('rc.commandsManifest.serve', {
+Config.set('rc.commands.build', {
+  path: '#src/Commands/BuildCommand',
+})
+Config.set('rc.commands.serve', {
   path: '#src/Commands/ServeCommand',
   entrypoint: '#tests/Stubs/bootstrap/main',
 })

diff --git a/tests/Unit/Commands/BuildCommandTest.ts b/tests/Unit/Commands/BuildCommandTest.ts
@@ -18,6 +18,8 @@ export default class BuildCommandTest extends BaseCommandTest {
   public async shouldBeAbleToBuildTheApplication({ assert }: TestContext) {
     const { stdout, stderr } = await Artisan.callInChild('build', this.artisan)
 
+    console.log(stdout)
+
     assert.deepEqual(stderr, '')
     assert.isTrue(stdout.includes('[ BUILDING APPLICATION ]'))
     assert.isTrue(stdout.includes('Compiling all .ts files from your application'))

diff --git a/tests/Unit/Commands/MakeExceptionCommandTest.ts b/tests/Unit/Commands/MakeExceptionCommandTest.ts
@@ -25,7 +25,7 @@ export default class MakeExceptionCommandTest extends BaseCommandTest {
 
   @Test()
   public async shouldBeAbleToCreateAnExceptionFileInDifferentDestPath({ assert }: TestContext) {
-    Config.set('rc.commandsManifest.make:exception.destination', Path.stubs('storage/exceptions'))
+    Config.set('rc.commands.make:exception.destination', Path.stubs('storage/exceptions'))
 
     await Artisan.call('make:exception TestException')