index.ts

/**
 *
 *  Router Dex Script
 *  @module .
 *
 *  @description allows to execute router dex directly via package script
 *  @author diegoulloao
 *
 */
import moduleAlias from "module-alias"

moduleAlias.addAliases({
  "@root": `${__dirname}`,
  "@src": `${__dirname}/src`,
  "@helpers": `${__dirname}/src/helpers`,
  "@types": `${__dirname}/src/types`
})


import path from "path"
import chalk from "chalk"
import routerDex from "@root/inspector"

import { Express } from "@types"

// ts-node adds so many unnecessary parameters, we delete them
if ( /\.bin\/ts-node/.test(process.argv[1]) ) {
  process.argv.splice(0, process.argv.findIndex((a: string) => /router-dex/.test(a)))
}

// Exit if path from where to import the express server is not valid
if ( !process.argv[1] ) {
  console.log(chalk.bgRed.black(" Must specify a module to import. "), "\n")
  process.exit(1)
}

// Local package.json
const clientPackageJson: any = require(path.normalize(`${process.cwd()}/package.json`))

// Module absolute path where to import the express server
const modulePath: string = path.resolve(process.cwd(), process.argv[1])

// If module export the server as default or specific name
const namespace: string = process.argv[2]

// Remove import name from process arguments
process.argv.splice(2, 1)

try {
  // Imports the module
  const Module: any = require(modulePath)

  // Check if the namespace provided is valid
  if ( namespace !== "default" && !Module[namespace] ) {
    console.log(chalk.bgRed.black(" Must provide a valid namespace to import. "), "\n")
    console.log(chalk.red("If the module exports the application by default then use \"default\" right after the module path."), "\n")
    process.exit(1)
  }

  // Gets the express server from the module
  const server: Express = (namespace === "default") ? Module : Module[namespace]

  // Checks if object passed is an express instance
  if ( !server.hasOwnProperty("listen") || typeof server.listen !== "function" ) {
    console.log(chalk.bgRed.black(" Must provide a valid express instance. "), "\n")
    process.exit(1)
  }

  // Inspect routes
  routerDex(server, clientPackageJson.name)

} catch (e: any) {
  console.log(chalk.bgRed.black(" Must specify a valid module to import. "), "\n")
}