@leanix/reporting-cli/src/initializer.ts

Command line interface to develop custom reports for LeanIX EAM

// eslint-disable-next-line node/prefer-global/process
import { versions } from 'node:process'
import chalk from 'chalk'
import * as inquirer from 'inquirer'
import { getTemplateDirectoryPath } from './path.helpers'
import { TemplateExtractor } from './template-extractor'

export class Initializer {
  private extractor = new TemplateExtractor()

  public init(): Promise<void> {
    console.log(chalk.green('Initializing new project...'))

    return inquirer.prompt(this.getInquirerQuestions()).then((answers) => {
      answers.nodeVersion = versions.node
      this.extractor.extractTemplateFiles(getTemplateDirectoryPath(), answers)
      console.log(chalk.green('\u2713 Your project is ready!'))
      console.log(chalk.green('Please run `npm install` to install dependencies and then run `npm start` to start developing!'))
    })
  }

  private getInquirerQuestions(): inquirer.QuestionCollection {
    // The name properties correspond to the variables in the package.json template file
    return [
      {
        type: 'input',
        name: 'name',
        message: 'Name of your project for package.json'
      },
      {
        type: 'input',
        name: 'id',
        message: 'Unique id for this report in Java package notation (e.g. net.leanix.barcharts)'
      },
      {
        type: 'input',
        name: 'author',
        message: 'Who is the author of this report (e.g. LeanIX GmbH)'
      },
      {
        type: 'input',
        name: 'title',
        message: 'A title to be shown in LeanIX when report is installed'
      },
      {
        type: 'input',
        name: 'description',
        message: 'Description of your project'
      },
      {
        type: 'input',
        name: 'licence',
        default: 'UNLICENSED',
        message: 'Which licence do you want to use for this project?'
      },
      {
        type: 'input',
        name: 'host',
        default: 'app.leanix.net',
        message: 'Which host do you want to work with?'
      },
      {
        type: 'input',
        name: 'workspace',
        message: 'Which is the workspace you want to test your report in?'
      },
      {
        type: 'input',
        name: 'apitoken',
        message: 'API-Token for Authentication (see: https://dev.leanix.net/docs/authentication#section-generate-api-tokens)'
      },
      {
        type: 'confirm',
        name: 'behindProxy',
        message: 'Are you behind a proxy?',
        default: false
      },
      {
        when: answers => answers.behindProxy,
        type: 'input',
        name: 'proxyURL',
        message: 'Proxy URL?'
      }
    ]
  }
}