2.x: Added development mode to oclif

Author: DionisioFG

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

bin/dev.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env ts-node
+// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
+async function main() {
+  const {execute} = await import('@oclif/core')
+  await execute({development: true, dir: import.meta.url})
+}
+
+await main()

package.json

@@ -10,32 +10,32 @@
   "homepage": "https://github.com/codeenigma/ce-dev",
   "license": "MIT",
   "dependencies": {
-    "@oclif/core": "^3.11.0",
+    "@oclif/core": "^4",
     "@oclif/plugin-autocomplete": "^3.0.3",
     "@oclif/plugin-help": "^6.0.6",
-    "@oclif/plugin-plugins": "^4.1.8",
+    "@oclif/plugin-plugins": "^5",
     "@types/inquirer-fuzzy-path": "^2.3.9",
     "debug": "^4.3.4",
     "inquirer": "^9.2.12",
     "inquirer-fuzzy-path": "^2.3.0",
     "js-yaml": "^4.1.0",
-    "open": "^9.1.0"
+    "open": "^10"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.1.2",
+    "@oclif/test": "^4",
     "@types/inquirer": "^9.0.7",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^20.9.1",
-    "eslint": "^8.53.0",
+    "eslint": "^9",
     "eslint-config-oclif": "^5.0.0",
     "eslint-config-oclif-typescript": "^3.0.15",
     "eslint-config-prettier": "^9.0.0",
-    "oclif": "^4.0.3",
+    "oclif": "^4",
+    "renamer": "^5",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2",
-    "renamer": "^4.0.0"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=18.0.0"

src/abstracts/base-cmd-abstract.ts

@@ -95,7 +95,7 @@ export default abstract class BaseCmd extends Command {
    * Path to the user config file.
    */
   protected userConfigFilePath = fspath.resolve(
-    this.config.configDir + '/preferences-2.x.yml',
+    this.config.configDir + '/preferences.yml',
   )
 
   /**
@@ -104,6 +104,12 @@ export default abstract class BaseCmd extends Command {
    */
   private readonly controllerManager: CeDevControllerManager
 
+  /**
+   * @member
+   * Development mode or not.
+   */
+  protected developmentMode: boolean = false
+
   /**
    * @inheritdoc
    */
@@ -140,6 +146,10 @@ export default abstract class BaseCmd extends Command {
       this.UserConfig = this.parseYaml(this.userConfigFilePath) as UserConfig
     }
 
+    if ((typeof process.env.NODE_ENV !== 'undefined') && (process.env.NODE_ENV === 'development')) {
+      this.developmentMode = true;
+    }
+
     this.dockerBin = this.UserConfig.docker_bin
     this.dockerComposeBin = this.UserConfig.docker_compose_bin
     this.mkcertBin = this.UserConfig.mkcert_bin
@@ -321,7 +331,7 @@ export default abstract class BaseCmd extends Command {
   }
 
   /**
-   * Pull controller latest image.
+   * Pull controller latest|devel image.
    *
    * @return void
    */

src/commands/build.ts

@@ -78,9 +78,13 @@ export default class BuildCmd extends BaseCmd {
       if (this.composeConfig['x-ce_dev']) {
         containerName = this.composeConfig['x-ce_dev'].project_name + '-' + name
       }
+      let version = 'latest'
+      if (this.developmentMode) {
+        version = 'devel'
+      }
 
       ux.action.start('Committing container ' + containerName + ' as a new image.')
-      execSync(this.dockerBin + ' commit ' + containerName + ' ' + this.dockerRegistry + '/' + containerName + ':latest', {stdio: 'inherit'})
+      execSync(this.dockerBin + ' commit ' + containerName + ' ' + this.dockerRegistry + '/' + containerName + ':' + version, {stdio: 'inherit'})
       ux.action.stop()
     }
   }
@@ -91,10 +95,14 @@ export default class BuildCmd extends BaseCmd {
    * @return void
    */
   private generateCompose(): void {
+    let version = 'latest'
+    if (this.developmentMode) {
+      version = 'devel'
+    }
     ux.action.start('Generating new compose file ' + this.composeDest + '.')
     for (const [name, service] of Object.entries(this.composeConfig.services)) {
       const containerName = this.composeConfig['x-ce_dev'].project_name + '-' + name
-      service.image = this.dockerRegistry + '/' + containerName + ':latest'
+      service.image = this.dockerRegistry + '/' + containerName + ':' + version
     }
 
     YamlParser.writeYaml(this.composeDest, this.composeConfig)

src/commands/push.ts

@@ -47,10 +47,14 @@ export default class PushCmd extends DockerImagesCmd {
    * @return void
    */
   private push(): void {
+    let version = 'latest'
+    if (this.developmentMode) {
+      version = 'devel'
+    }
     for (const name of Object.keys(this.composeConfig.services)) {
       const containerName = this.composeConfig['x-ce_dev'].project_name + '-' + name
       ux.action.start('Pushing image ' + containerName)
-      execSync(this.dockerBin + ' push ' + this.dockerRegistry + '/' + containerName + ':latest', {stdio: 'inherit'})
+      execSync(this.dockerBin + ' push ' + this.dockerRegistry + '/' + containerName + ':' + version, {stdio: 'inherit'})
       ux.action.stop()
     }
   }

src/controller-manager.ts

@@ -45,6 +45,12 @@ export default class ControllerManager {
    */
   private readonly networkComposeFile: string
 
+  /**
+   * @member
+   * Development mode or not.
+   */
+  protected developmentMode: boolean = false
+
   public constructor(config: Config, dockerBin: string, dockerComposeBin: string, mkcertBin: string) {
     this.dockerBin = dockerBin
     this.dockerComposeBin = dockerComposeBin
@@ -58,6 +64,10 @@ export default class ControllerManager {
       this.config.dataDir,
       'docker-compose.network.yml',
     )
+
+    if ((typeof process.env.NODE_ENV !== 'undefined') && (process.env.NODE_ENV === 'development')) {
+      this.developmentMode = true;
+    }
   }
 
   /**
@@ -237,13 +247,22 @@ export default class ControllerManager {
    * @return void
    */
   public pullImage(): void {
-    execSync(this.dockerBin + ' pull codeenigma/ce-dev-controller-' + AppSettings.ceDevVersion + '.x:latest', {
+    // If in development mode, we use devel version.
+    let version = 'latest'
+    if (this.developmentMode) {
+      version = 'devel'
+    }
+    execSync(this.dockerBin + ' pull codeenigma/ce-dev-controller-' + AppSettings.ceDevVersion + '.x:' + version, {
       stdio: 'inherit',
     })
   }
 
   private getControllerConfig(): DockerComposeConfigBare {
     const ipManager = new IPManager(this.config, this.dockerBin)
+    let version = 'latest'
+    if (this.developmentMode) {
+      version = 'devel'
+    }
     return {
       networks: {
         ce_dev: {
@@ -256,7 +275,7 @@ export default class ControllerManager {
           cgroup: 'host',
           container_name: 'ce_dev_controller',
           hostname: 'ce_dev_controller',
-          image: 'codeenigma/ce-dev-controller-'+ AppSettings.ceDevVersion + '.x:latest',
+          image: 'codeenigma/ce-dev-controller-'+ AppSettings.ceDevVersion + '.x:' + version,
           networks: {
             ce_dev: {
               ipv4_address: ipManager.getControllerIP(),

templates/localgov/ce-dev/ce-dev-devel.compose.yml.j2

@@ -11,7 +11,7 @@ x-ce_dev:
     - https://www.{{ project_name }}.local
 services:
   web:
-    image: codeenigma/ce-dev-2.x:latest
+    image: codeenigma/ce-dev-2.x:devel
     platform: linux/amd64
     cgroup: host
     expose:

templates/prebuild.sh

@@ -8,6 +8,7 @@ usage(){
   echo 'Available options:'
   echo '--template: ce-dev template to use. By default: ce-dev.compose.yml'
   echo '--push: if we want to push the images to docker'
+  echo '--devel: if we want to run the templates in devel mode'
 }
 # Parse options arguments.
 parse_options(){
@@ -20,6 +21,9 @@ parse_options(){
       "--push")
           PUSH="yes"
         ;;
+      "--devel")
+          DEVEL="yes"
+        ;;
         *)
         usage
         exit 1
@@ -33,6 +37,7 @@ parse_options(){
 PROJECTS="blank drupal10"
 PUSH="no"
 TEMPLATE="ce-dev.compose.yml"
+DEVEL="no"
 
 # Common processing.
 OWN_DIR=$(dirname "$0")
@@ -47,6 +52,13 @@ parse_options "$@"
 
 CE_DEV_BIN="$OWN_DIR/bin/run.js"
 
+if [ $DEVEL = "yes" ]; then
+  CE_DEV_BIN="$OWN_DIR/bin/dev.js"
+fi
+
+echo $CE_DEV_BIN
+exit 1
+
 # Create a project.
 # @param $1
 # Project name.