@villedemontreal/scripting/src/config/configs.ts

Scripting core utilities

import { Program } from '@caporal/core';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';

export class Configs {
  /**
   * The library root. When this library is used
   * as a dependency in a project, the "libRoot"
   * will be the path to the dependency folder,
   * inside the "node_modules".
   */
  public libRoot: string;
  public isWindows: boolean;
  private projectRootVar: string;
  private projectOutDirVar: string;
  private caporalVar: Program;

  constructor() {
    // From the "dist/src/config" folder
    this.libRoot = path.normalize(__dirname + '/../../..');
    this.isWindows = os.platform() === 'win32';
  }

  /**
   * The proper Caporal instance to use in the code!
   * It is on this instance that commands and options
   * have been registered.
   */
  public get caporal() {
    if (!this.caporalVar) {
      throw new Error(`The Caporal instance must have been set on the configurations!`);
    }
    return this.caporalVar;
  }

  public setCaporal(caporal: Program) {
    this.caporalVar = caporal;
  }

  public get projectRoot() {
    if (!this.projectRootVar) {
      throw new Error(`The project root must have been set on the configurations!`);
    }
    return this.projectRootVar;
  }

  public setProjectRoot(projectRoot: string) {
    this.projectRootVar = projectRoot;
  }

  public get projectOutDir() {
    if (!this.projectOutDirVar) {
      throw new Error(`The project output directory must have been set on the configurations!`);
    }
    return this.projectOutDirVar;
  }

  public setProjectOutDir(projectOutDir: string) {
    this.projectOutDirVar = projectOutDir;
  }

  public findModulePath(subPath: string): string {
    let current = this.libRoot;
    let counter = 0;
    while (counter < 10 && current !== '/' && fs.existsSync(current)) {
      const p = path.join(current, subPath);
      if (fs.existsSync(p)) {
        return path.normalize(p);
      }
      current = path.normalize(path.join(current, '..'));
      counter += 1;
    }
    throw new Error(`Could not find module "${subPath}"`);
  }
}

export const configs: Configs = new Configs();