✨ allow user to provided loaded commands

Author: MatthieuLemoine

README.md

@@ -35,7 +35,15 @@ const config = {
   projectName: 'Immersive',
   // Will be displayed on CLI start (optional - default to displayName)
   displayName: 'Immersive',
-  // Path to the directory where commands are defined (required)
+  // Loaded commands (required if commandsDirectory not provided) - Should be valid map of ImmersiveCommand
+  commands: {
+    'import-orgs': {
+      command: 'importOrgs',
+      description: 'Import organizations',
+      action: () => {},
+    },
+  },
+  // Path to the directory where commands are defined (required if commands not provided)
   commandsDirectory: path.join(__dirname, 'commands'),
   // Will be accessible from commands as argument (optional)
   helpers: {

index.d.ts

@@ -15,10 +15,17 @@ declare module 'immersive' {
     };
   }
 
+  export interface ImmersiveCommand {
+    command: string;
+    description: string;
+    action: Function;
+  }
+
   interface ImmersiveConfiguration {
     projectName: string;
     displayName?: string;
-    commandsDirectory: string;
+    commands?: Record<string, ImmersiveCommand>;
+    commandsDirectory?: string;
     helpers: Record<string, Helper>;
     environments: Record<string, ImmersiveEnvironment>;
     defaultEnvironment?: string;
@@ -53,7 +60,11 @@ declare module 'immersive' {
     clearHistory: () => void;
   }
 
-  type ImmersiveActionInput<Helpers, EnvironmentNames = string, EnvironmentConfig = ImmersiveEnvironment> = Helpers & {
+  type ImmersiveActionInput<
+    Helpers,
+    EnvironmentNames = string,
+    EnvironmentConfig = ImmersiveEnvironment
+  > = Helpers & {
     args: Arguments;
     commands: Record<string, ImmersiveAction<Helpers, EnvironmentNames>>;
     logger: ImmersiveLogger;
@@ -66,8 +77,17 @@ declare module 'immersive' {
     envConfig: EnvironmentConfig;
   };
 
-  type ImmersiveAction<Helpers, EnvironmentNames = string, EnvironmentConfig = ImmersiveEnvironment, ReturnType = any> = (
-    actionInput: ImmersiveActionInput<Helpers, EnvironmentNames, EnvironmentConfig>,
+  type ImmersiveAction<
+    Helpers,
+    EnvironmentNames = string,
+    EnvironmentConfig = ImmersiveEnvironment,
+    ReturnType = any
+  > = (
+    actionInput: ImmersiveActionInput<
+      Helpers,
+      EnvironmentNames,
+      EnvironmentConfig
+    >,
   ) => ReturnType;
 
   export default function immersive(

package.json

@@ -1,6 +1,6 @@
 {
   "name": "immersive",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "A framework to build immersive CLIs & great developer tools.",
   "main": "index.js",
   "module": "src/main.js",

src/command/index.js

@@ -109,9 +109,13 @@ const wrapCommand = (action, config) => (argv, command) => {
   });
 };
 
-export const loadCommands = ({ commandsDirectory, ...config }) => {
+export const loadCommands = ({
+  commands: userLoadedCommands,
+  commandsDirectory,
+  ...config
+}) => {
   const customCommands = parseCommands(
-    requireDir(commandsDirectory, { recurse: true }),
+    userLoadedCommands || requireDir(commandsDirectory, { recurse: true }),
   );
   commands = [
     ...customCommands,