@nathapp/na-cli 1.0.0-rc.11 → 1.0.0-rc.13

package/src/index.ts

@@ -1,202 +1,31 @@
 #!/usr/bin/env node
 
-import * as inquirer from 'inquirer';
-import * as fs from 'fs';
 import * as path from 'path';
-import * as shell from 'shelljs';
-import * as template from './utils/template';
-import chalk from 'chalk';
+import { generateTemplate } from './utils/template';
 import * as yargs from 'yargs';
-const { name, version } = require("../package.json");
+const { version } = require("../package.json");
 
-const CHOICES = fs.readdirSync(path.join(__dirname, 'templates'));
-
-const QUESTIONS = [
-  {
-    name: 'template',
-    type: 'list',
-    message: 'What project template would you like to generate?',
-    choices: CHOICES,
-    when: () => !yargs.argv['template']
-  },
-  {
-    name: 'name',
-    type: 'input',
-    message: 'Project name:',
-    when: () => !yargs.argv['name'],
-    validate: (input: string) => {
-      if (/^([A-Za-z\-\_\d])+$/.test(input)) return true;
-      else return 'Project name may only include letters, numbers, underscores and hashes.';
-    }
-  },
-  {
-    name: 'author',
-    type: 'input',
-    message: 'Author:',
-    when: () => !yargs.argv['author']
-  },
-  {
-    name: "run_install",
-    type: "confirm",
-    message: "Do you want to run npm install after template created?",
-  },
-];
-
-const CURR_DIR = process.cwd();
-
-export interface TemplateConfig {
-  files?: string[]
-  postMessage?: string
-}
-
-export interface CliOptions {
-  projectName: string
-  templateName: string
-  templatePath: string
-  tartgetPath: string
-  config: TemplateConfig
-}
-console.log(`Welcome to ${name} version ${version}`);
-inquirer.prompt(QUESTIONS)
-  .then(answers => {
-
-    answers = Object.assign({}, answers, yargs.argv);
-    // @ts-ignore
-    const projectChoice = answers['template'];
-    // @ts-ignore
-    const projectName = answers['name'];
-    // @ts-ignore
-    const author = answers['author'];
-    // @ts-ignore
-    const runInstall = answers['run_install'];
-    const templatePath = path.join(__dirname, 'templates', projectChoice);
-    const tartgetPath = path.join(CURR_DIR, projectName);
-    const templateConfig = getTemplateConfig(templatePath);
-
-    const options: CliOptions = {
-      projectName,
-      templateName: projectChoice,
-      templatePath,
-      tartgetPath,
-      config: templateConfig
-    }
-
-    if (!createProject(tartgetPath)) {
-      return;
-    }
-
-    createDirectoryContents(templatePath, projectName, templateConfig, author);
-
-    if (runInstall && !postProcess(options)) {
-      return;
-    }
-
-    showMessage(options);
-  });
-
-function showMessage(options: CliOptions) {
-  console.log('');
-  console.log(chalk.green('Done.'));
-  console.log(chalk.green(`Go into the project: cd ${options.projectName}`));
-
-  const message = options.config.postMessage;
-
-  if (message) {
-    console.log('');
-    console.log(chalk.yellow(message));
-    console.log('');
-  }
+function runGenerateTemplate() {
+  const TEMPLATE_PATH = path.join(__dirname, 'templates');
+  const CURR_DIR = process.cwd();
 
+  generateTemplate(TEMPLATE_PATH, CURR_DIR)
 }
 
-function getTemplateConfig(templatePath: string): TemplateConfig {
-  const configPath = path.join(templatePath, '.template.json');
-
-  if (!fs.existsSync(configPath)) return {};
-
-  const templateConfigContent = fs.readFileSync(configPath);
-
-  if (templateConfigContent) {
-    return JSON.parse(templateConfigContent.toString());
+yargs.version(version).command({
+  command: 'generate',
+  describe: 'generate project template',
+  builder: (yargs) => yargs.options({}),
+  handler: (argv: {}) => {
+    runGenerateTemplate()
   }
-
-  return {};
-}
-
-function createProject(projectPath: string) {
-  if (fs.existsSync(projectPath)) {
-    console.log(chalk.red(`Folder ${projectPath} exists. Delete or use another name.`));
-    return false;
+}).command({
+  command: 'gen',
+  describe: 'generate project template, "generate" command alias',
+  builder: (yargs) => yargs.options({}),
+  handler: (argv: {}) => {
+    runGenerateTemplate()
   }
+}).help().alias("help", "h").showHelpOnFail(true);
 
-  fs.mkdirSync(projectPath);
-  return true;
-}
-
-function postProcess(options: CliOptions) {
-  console.log('');
-  console.log("running post installation..please wait...")
-  if (isNode(options)) {
-    return postProcessNode(options);
-  }
-  return true;
-}
-
-function isNode(options: CliOptions) {
-  return fs.existsSync(path.join(options.templatePath, 'package.json'));
-}
-
-function postProcessNode(options: CliOptions) {
-  shell.cd(options.tartgetPath);
-
-  let cmd = '';
-
-  if (shell.which('yarn')) {
-    cmd = 'yarn';
-  } else if (shell.which('npm')) {
-    cmd = 'npm install';
-  }
-
-  if (cmd) {
-    const result = shell.exec(cmd);
-
-    if (result.code !== 0) {
-      return false;
-    }
-  } else {
-    console.log(chalk.red('No yarn or npm found. Cannot run installation.'));
-  }
-
-  return true;
-}
-
-const SKIP_FILES = ['node_modules', '.template.json'];
-
-function createDirectoryContents(templatePath: string, projectName: string, config: TemplateConfig, author?: string) {
-  const filesToCreate = fs.readdirSync(templatePath);
-
-  filesToCreate.forEach(file => {
-    const origFilePath = path.join(templatePath, file);
-
-    // get stats about the current file
-    const stats = fs.statSync(origFilePath);
-
-    if (SKIP_FILES.indexOf(file) > -1) return;
-
-    if (stats.isFile()) {
-      let contents = fs.readFileSync(origFilePath, 'utf8');
-
-      if (file === '.npmignore-rename') file = '.npmignore';
-
-      contents = template.render(contents, { projectName, author });
-
-      const writePath = path.join(CURR_DIR, projectName, file);
-      fs.writeFileSync(writePath, contents, 'utf8');
-    } else if (stats.isDirectory()) {
-      fs.mkdirSync(path.join(CURR_DIR, projectName, file));
-
-      // recursive call
-      createDirectoryContents(path.join(templatePath, file), path.join(projectName, file), config, author);
-    }
-  });
-}
+yargs.parse();

package/src/utils/template.ts

@@ -1,4 +1,25 @@
 import * as ejs from 'ejs';
+import * as fs from 'fs';
+import * as inquirer from 'inquirer';
+import * as shell from 'shelljs';
+import chalk from 'chalk';
+import * as yargs from 'yargs';
+import * as path from 'path';
+
+const { name, version } = require("../../package.json");
+
+export interface TemplateConfig {
+    files?: string[]
+    postMessage?: string
+}
+
+export interface CliOptions {
+    projectName: string
+    templateName: string
+    templatePath: string
+    tartgetPath: string
+    config: TemplateConfig
+}
 
 export interface TemplateData {
     projectName: string
@@ -7,4 +28,186 @@ export interface TemplateData {
 
 export function render(content: string, data: TemplateData) {
     return ejs.render(content, data);
+}
+
+
+export function generateTemplate(templateDir: string, targetDirectory: string) {
+    const templateChoices = fs.readdirSync(templateDir);
+
+    const QUESTIONS = [
+        {
+            name: 'template',
+            type: 'list',
+            message: 'What project template would you like to generate?',
+            choices: templateChoices,
+            when: () => !yargs.argv['template']
+        },
+        {
+            name: 'name',
+            type: 'input',
+            message: 'Project name:',
+            when: () => !yargs.argv['name'],
+            validate: (input: string) => {
+                if (/^([A-Za-z\-\_\d])+$/.test(input)) return true;
+                else return 'Project name may only include letters, numbers, underscores and hashes.';
+            }
+        },
+        {
+            name: 'author',
+            type: 'input',
+            message: 'Author:',
+            when: () => !yargs.argv['author']
+        },
+        {
+            name: "run_install",
+            type: "confirm",
+            message: "Do you want to run npm install after template created?",
+        },
+    ];
+
+
+    console.log(`Welcome to ${name} version ${version}`);
+    inquirer.prompt(QUESTIONS)
+        .then(answers => {
+
+            answers = Object.assign({}, answers, yargs.argv);
+            // @ts-ignore
+            const projectChoice = answers['template'];
+            // @ts-ignore
+            const projectName = answers['name'];
+            // @ts-ignore
+            const author = answers['author'];
+            // @ts-ignore
+            const runInstall = answers['run_install'];
+            const templatePath = path.join(templateDir, projectChoice);
+            const tartgetPath = path.join(targetDirectory, projectName);
+            const templateConfig = getTemplateConfig(templatePath);
+
+            const options: CliOptions = {
+                projectName,
+                templateName: projectChoice,
+                templatePath,
+                tartgetPath,
+                config: templateConfig
+            }
+
+            if (!createProject(tartgetPath)) {
+                return;
+            }
+
+            createDirectoryContents(templatePath, projectName, templateConfig, author);
+
+            if (runInstall && !postProcess(options)) {
+                return;
+            }
+
+            showMessage(options);
+        });
+
+    function showMessage(options: CliOptions) {
+        console.log('');
+        console.log(chalk.green('Done.'));
+        console.log(chalk.green(`Go into the project: cd ${options.projectName}`));
+
+        const message = options.config.postMessage;
+
+        if (message) {
+            console.log('');
+            console.log(chalk.yellow(message));
+            console.log('');
+        }
+
+    }
+
+    function getTemplateConfig(templatePath: string): TemplateConfig {
+        const configPath = path.join(templatePath, '.template.json');
+
+        if (!fs.existsSync(configPath)) return {};
+
+        const templateConfigContent = fs.readFileSync(configPath);
+
+        if (templateConfigContent) {
+            return JSON.parse(templateConfigContent.toString());
+        }
+
+        return {};
+    }
+
+    function createProject(projectPath: string) {
+        if (fs.existsSync(projectPath)) {
+            console.log(chalk.red(`Folder ${projectPath} exists. Delete or use another name.`));
+            return false;
+        }
+
+        fs.mkdirSync(projectPath);
+        return true;
+    }
+
+    function postProcess(options: CliOptions) {
+        console.log('');
+        console.log("running post installation..please wait...")
+        if (isNode(options)) {
+            return postProcessNode(options);
+        }
+        return true;
+    }
+
+    function isNode(options: CliOptions) {
+        return fs.existsSync(path.join(options.templatePath, 'package.json'));
+    }
+
+    function postProcessNode(options: CliOptions) {
+        shell.cd(options.tartgetPath);
+
+        let cmd = '';
+
+        if (shell.which('yarn')) {
+            cmd = 'yarn';
+        } else if (shell.which('npm')) {
+            cmd = 'npm install';
+        }
+
+        if (cmd) {
+            const result = shell.exec(cmd);
+
+            if (result.code !== 0) {
+                return false;
+            }
+        } else {
+            console.log(chalk.red('No yarn or npm found. Cannot run installation.'));
+        }
+
+        return true;
+    }
+
+    const SKIP_FILES = ['node_modules', '.template.json'];
+
+    function createDirectoryContents(templatePath: string, projectName: string, config: TemplateConfig, author?: string) {
+        const filesToCreate = fs.readdirSync(templatePath);
+
+        filesToCreate.forEach(file => {
+            const origFilePath = path.join(templatePath, file);
+
+            // get stats about the current file
+            const stats = fs.statSync(origFilePath);
+
+            if (SKIP_FILES.indexOf(file) > -1) return;
+
+            if (stats.isFile()) {
+                let contents = fs.readFileSync(origFilePath, 'utf8');
+
+                if (file === '.npmignore-rename') file = '.npmignore';
+
+                contents = render(contents, { projectName, author });
+
+                const writePath = path.join(targetDirectory, projectName, file);
+                fs.writeFileSync(writePath, contents, 'utf8');
+            } else if (stats.isDirectory()) {
+                fs.mkdirSync(path.join(targetDirectory, projectName, file));
+
+                // recursive call
+                createDirectoryContents(path.join(templatePath, file), path.join(projectName, file), config, author);
+            }
+        });
+    }
 }

package/templates/mxw-base-api-express/.gitlab-ci.yml

@@ -17,6 +17,7 @@ stages:
   - build-commit
   # mark release commit as verified
   - release
+  - notify
 
 run-test:
   stage: test
@@ -153,3 +154,19 @@ run-release:
       when: never
     # Tag was created
     - if: '$CI_COMMIT_TAG != null'
+
+run-notify:
+  stage: notify
+  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/node:10.20.0-alpine-ci-1
+  before_script:
+    - apk --no-cache add curl
+  script:
+    - 'curl -X POST -H "Content-Type: application/json" -d "{\"chat_id\": \"$TELEGRAM_CHAT_ID\", \"text\": \"CI: $CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME version:$(make version) has been released \"}" https://api.telegram.org/bot$TELEGRAM_BOT_TOKEN/sendMessage'
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    - if: $TELEGRAM_BOT_TOKEN != null  
+    - if: $TELEGRAM_BOT_TOKEN != ""
+    - if: $TELEGRAM_CHAT_ID != null  
+    - if: $TELEGRAM_CHAT_ID != ""  

package/templates/ts-library/.gitlab-ci.yml

@@ -5,7 +5,7 @@ stages:
   - build
   - build-commit
   - release
-
+  - notify
 
 run-test:
   stage: test
@@ -13,7 +13,7 @@ run-test:
   script:
     - make test
   rules:
-    - if: '$CI_COMMIT_MESSAGE =~ /release-rc-by-bybot/ || $CI_COMMIT_MESSAGE =~ /release-by-cibot/'
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/'
       when: never
     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
     - if: '$CI_COMMIT_REF_PROTECTED == "true"'
@@ -113,4 +113,21 @@ run-release:
     - if: '$CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event"'
       when: never
     # Tag was created
-    - if: '$CI_COMMIT_TAG != null'      
+    - if: '$CI_COMMIT_TAG != null'      
+      
+
+run-notify:
+  stage: notify
+  image: registry-intl.cn-hongkong.aliyuncs.com/gkci/node:10.20.0-alpine-ci-1
+  before_script:
+    - apk --no-cache add curl
+  script:
+    - 'curl -X POST -H "Content-Type: application/json" -d "{\"chat_id\": \"$TELEGRAM_CHAT_ID\", \"text\": \"CI: $CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME version:$(make version) has been released \"}" https://api.telegram.org/bot$TELEGRAM_BOT_TOKEN/sendMessage'
+  rules:
+    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
+    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
+      when: never
+    - if: $TELEGRAM_BOT_TOKEN != null  
+    - if: $TELEGRAM_BOT_TOKEN != ""
+    - if: $TELEGRAM_CHAT_ID != null  
+    - if: $TELEGRAM_CHAT_ID != ""      

package/templates/ts-library/Makefile

@@ -1,5 +1,6 @@
 MAKEFILE := $(abspath $(lastword $(MAKEFILE_LIST)))
 ROOT_PATH := $(shell pwd)
+SERVICE_NAME := <%= projectName %>
 
 .PHONY: test