rallf-js-sdk/bin/init.js

Toolset to create Tasks for RALLF

#!/usr/bin/env node

'use strict';

const path = require('path');
const fs = require('fs-extra');
const clc = require('cli-color');
const program = require('commander');
const readline = require('readline');
const child_process = require('child_process');

const { logger } = require('../src/lib/logging');
const { version } = require('../package.json');

const loggerInit = logger.clone({ channel: 'init' });

program.version(version);
program.option('-s, --skill');
program.option('-f, --force');

console.log('init');

let cwd = process.cwd();
let folderName = path.parse(cwd).base;
let nameGoodFormat = folderName.replace(/[ ]/g, '-').replace(/[@$]/g, '').toLowerCase();

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

let initQuestions = [{
  "key": "name",
  "description": "Set a name for your task, the one displayed at market.rallf.com",
  "default": nameGoodFormat,
  "pattern": /^[\w\d-_.@$]*$/,
  "example": "task-name"
},
{
  "key": "fqtn",
  "description": "This is a unique identifier for your task, must be a valid FQDN",
  "default": `com.${nameGoodFormat}.task`,
  "pattern": /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){2,}([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]){2,}$/,
  "example": "com.example.task"
}
];

let manifestTemplate = {
  sdk_version: version
};

let init_template_name = 'init-template';

function replaceVars(str, vars) {
  str = String(str);
  for (let key in vars) {
    let var_ = vars[key];
    str = str.replace(new RegExp(`<${key}>`, 'g'), var_);
  }
  return str;
}

function copyFile(origin, target, vars) {

  target = target.replace('.tmpl', '');
  loggerInit.info('copy file: ' + target);

  let content = fs.readFileSync(origin) || '';
  content = replaceVars(content, vars);

  // This ensures the file is created, even if dirs not exist
  fs.ensureFileSync(target);

  fs.writeFileSync(target, content);
}

function toPascalCase(str) {
  return str.match(/[a-z]+/gi)
    .map(function (word) {
      return word.charAt(0).toUpperCase() + word.substr(1).toLowerCase()
    })
    .join('');
}

function copyTemplate() {
  loggerInit.info('Generating rallf-sdk-project ' + clc.blueBright('@' + version));
  let templatePath = __dirname.replace('bin', '') + `/examples/${init_template_name}`;
  let templateFiles = [{
    path: 'config/manifest.json',
    vars: manifestTemplate
  },
  {
    path: 'package.json',
    vars: manifestTemplate
  },
  {
    path: 'README.md',
    vars: manifestTemplate
  },
  {
    path: 'src/main.js.tmpl',
    vars: {
      ...manifestTemplate,
      name: toPascalCase(manifestTemplate.name)
    }
  },
    'mocks/com.test.task/index.js',
    'robots/nullrobot/devices.json',
    'robots/nullrobot/skills.json',
  ];

  for (let file of templateFiles) {
    let vars = {};
    if (file.vars) vars = file.vars;
    if (file.path) file = file.path;

    copyFile(path.join(templatePath, file), path.join(cwd, file), vars);
  }

  loggerInit.info('Installing dependencies, please wait...');

  let p = child_process.exec(`cd ${cwd} && npm install`, {
    stdio: ['inherit', 'inherit', 'inherit', 'ipc']
  });
  p.on('exit', (exit_code) => {
    if (exit_code === 0) {
      loggerInit.info(`To run the task you can do: ${clc.blackBright(isSkill ? 'npm run run:getTitle' : 'npm start')}`);
      loggerInit.info(`Readme available at: ${clc.blackBright.underline('./README.md')}`);
      loggerInit.info(`Documentation at: ${clc.blackBright.underline('https://github.com/RobotUnion/rallf-js-sdk/wiki')}`);
    }
  });
}

/**
 * 
 * @param {any[]} questions 
 */
function askForData(questions) {
  let question = questions[0];
  rl.question(`${question.description}\n ${question.key} (${clc.blackBright(question.default)}): `,
    (answer) => {
      if (!answer && question.default) {
        answer = question.default;
      }

      if (!question.pattern.test(answer)) {
        loggerInit.error(question.key + ' is not valid format, example: ' + question.example);
        askForData(questions);
      } else {
        manifestTemplate[question.key] = answer;

        if (questions.length > 1) {
          askForData(questions.slice(1));
        } else {
          loggerInit.info('Saving manifest.json');
          rl.close();
          copyTemplate();
        }
      }
    });
}

function isTask() {
  return fs.existsSync(path.join(cwd, 'config/manifest.json'));
}

let force = process.argv.includes('--force');
let isSkill = process.argv.includes('--skill');

if (isSkill) {
  init_template_name = 'init-skill-template';
}

if (!force && isTask()) {
  loggerInit.warning(`Folder ./${folderName} is already a rallf-task project`);
  process.exit();
}

loggerInit.info('running command: init');
loggerInit.info('Answer the following questions to initialize rallf-task project\n');

askForData(initQuestions);

program.parse(process.argv);