🎨 整理结构, 修改默认logger, 增加prompt.

zyao89 · zyao89 · commit 8a6fee87e097 · 2019-11-04T23:16:06.000+08:00
diff --git a/README.md b/README.md
@@ -9,10 +9,10 @@ Micro APP 依赖工具库.
 [![NPM Version][npm-img]][npm-url]
 [![NPM Download][download-img]][download-url]
 
-[Coverage-img]: https://coveralls.io/repos/github/MicrosApp/MicroApp-Shared-Utils/badge.svg?branch=master
-[Coverage-url]: https://coveralls.io/github/MicrosApp/MicroApp-Shared-Utils?branch=master
-[CircleCI-img]: https://circleci.com/gh/MicrosApp/MicroApp-Shared-Utils/tree/master.svg?style=svg
-[CircleCI-url]: https://circleci.com/gh/MicrosApp/MicroApp-Shared-Utils/tree/master
+[Coverage-img]: https://coveralls.io/repos/github/MicroAppJS/MicroApp-Shared-Utils/badge.svg?branch=master
+[Coverage-url]: https://coveralls.io/github/MicroAppJS/MicroApp-Shared-Utils?branch=master
+[CircleCI-img]: https://circleci.com/gh/MicroAppJS/MicroApp-Shared-Utils/tree/master.svg?style=svg
+[CircleCI-url]: https://circleci.com/gh/MicroAppJS/MicroApp-Shared-Utils/tree/master
 [npm-img]: https://img.shields.io/npm/v/@micro-app/shared-utils.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/@micro-app/shared-utils
 [download-img]: https://img.shields.io/npm/dm/@micro-app/shared-utils.svg?style=flat-square
diff --git a/package.json b/package.json
@@ -8,13 +8,13 @@
         "lint:fix": "npm run lint -- --fix",
         "test": "jest"
     },
-    "homepage": "https://github.com/MicrosApp/MicroApp-Shared-Utils",
+    "homepage": "https://github.com/MicroAppJS/MicroApp-Shared-Utils",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/MicrosApp/MicroApp-Shared-Utils.git"
+        "url": "git+https://github.com/MicroAppJS/MicroApp-Shared-Utils.git"
     },
     "bugs": {
-        "url": "https://github.com/MicrosApp/MicroApp-Shared-Utils/issues"
+        "url": "https://github.com/MicroAppJS/MicroApp-Shared-Utils/issues"
     },
     "files": [
         "src",
@@ -55,6 +55,7 @@
         "cheerio": "^1.0.0-rc.3",
         "fs-extra": "^8.1.0",
         "lodash": "^4.17.15",
+        "npmlog": "^4.1.2",
         "ora": "^3.4.0",
         "semver": "^6.3.0",
         "semver-regex": "^3.1.0",
diff --git a/src/constants/index.js b/src/constants/index.js
@@ -1,5 +1,6 @@
 'use strict';
 
 module.exports = {
+    SCOPE_NAME: '@micro-app',
     INJECT_ID: '_MICRO_APP_INJECT_',
 };
diff --git a/src/getPadLength/getPadLength.test.js b/src/getPadLength/getPadLength.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { getPadLength } = require('../');
+const { getPadLength } = require('../../');
 
 describe('getPadLength', () => {
 
diff --git a/src/getPadLength/index.js b/src/getPadLength/index.js
diff --git a/src/loadFile/index.js b/src/loadFile/index.js
diff --git a/src/loadFile/loadFile.test.js b/src/loadFile/loadFile.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { loadFile } = require('../');
+const { loadFile } = require('../..');
 
 describe('loadFile', () => {
 
@@ -25,7 +25,7 @@ describe('loadFile', () => {
     });
 
     it('success', () => {
-        const file = loadFile(__dirname, 'a.js');
+        const file = loadFile(__dirname, '../../test/a.js');
 
         expect(file).not.toBeNull();
     });
diff --git a/src/logger/index.js b/src/logger/index.js
@@ -1,11 +1,47 @@
 'use strict';
 
+const npmlog = require('npmlog');
+
 const chalk = require('chalk');
 const utils = require('util');
 const ora = require('ora');
 const os = require('os');
 
+npmlog.heading = require('../constants').SCOPE_NAME || '@micro-app';
+
+if (process.env.MICRO_APP_LOGGER_LEVEL) {
+    npmlog.level = process.env.MICRO_APP_LOGGER_LEVEL === 'true' ? 'silly' : process.env.MICRO_APP_LOGGER_LEVEL;
+}
+// npmlog.prefixStyle = {};
+const CUSTOM_LEVEL = {
+    debug: {
+        disp: '*DEBUG*',
+        bg: 'magenta',
+    },
+    info: {
+        fg: 'brightGreen',
+    },
+    success: {
+        fg: 'brightWhite',
+        bg: 'green',
+        bold: true,
+    },
+    noise: {
+        fg: 'blue',
+        level: 10000,
+        beep: true,
+    },
+};
+Object.keys(CUSTOM_LEVEL).forEach(key => {
+    const style = CUSTOM_LEVEL[key];
+    const disp = style.disp || (key.length > 4 ? key.substr(0, 4) : key).toUpperCase();
+    npmlog.addLevel(key, style.level || 'info', style, disp);
+});
+
 const getStdoutMethod = function(type) {
+    if ([ 'debug', 'success' ].includes(type)) {
+        type = 'log';
+    }
     if (!process) {
         if (type) {
             return console[type].bind(console);
@@ -18,6 +54,10 @@ const getStdoutMethod = function(type) {
     return process.stdout.write.bind(process.stdout);
 };
 
+const getNpmlogMethod = function(type) {
+    return npmlog[type].bind(npmlog);
+};
+
 const toString = {
     debug() {
         const message = utils.format(...(arguments || []));
@@ -41,23 +81,37 @@ const toString = {
     },
 };
 
-module.exports = {
+const getMethod = function(type) {
+    const logger = getNpmlogMethod(type);
+    return function(...args) {
+        if (args.length <= 1) {
+            return logger(false, ...args);
+        }
+        return logger(...args);
+    };
+    // const logger = getStdoutMethod(type);
+    // return function(...args) {
+    //     return logger(toString[type].call(toString, ...args));
+    // };
+};
+
+const logger = {
     toString,
     debug() {
         if (!process.env.MICRO_APP_DEBUG_LOGGER) return; // 是否开启
-        return getStdoutMethod('log')(toString.debug.call(toString, ...arguments));
+        return getMethod('debug')(...arguments);
     },
     warn() {
-        return getStdoutMethod('warn')(toString.warn.call(toString, ...arguments));
+        return getMethod('warn')(...arguments);
     },
     error() {
-        return getStdoutMethod('error')(toString.error.call(toString, ...arguments));
+        return getMethod('error')(...arguments);
     },
     info() {
-        return getStdoutMethod('info')(toString.info.call(toString, ...arguments));
+        return getMethod('info')(...arguments);
     },
     success() {
-        return getStdoutMethod('log')(toString.success.call(toString, ...arguments));
+        return getMethod('success')(...arguments);
     },
 
     /**
@@ -90,5 +144,16 @@ module.exports = {
         process.exit(1);
     },
 };
+module.exports = new Proxy(logger, {
+    get(target, prop) {
+        if (!(prop in target) && typeof prop === 'string') {
+            return getMethod(prop).bind(target);
+        }
+        return target[prop];
+    },
+});
 
+module.exports.npmlog = npmlog;
 module.exports.getStdoutMethod = getStdoutMethod;
+module.exports.getNpmlogMethod = getNpmlogMethod;
+module.exports.getMethod = getMethod;
diff --git a/src/logger/logger.test.js b/src/logger/logger.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { logger } = require('../');
+const { logger } = require('../..');
 
 describe('Logger', () => {
 
@@ -46,4 +46,11 @@ describe('Logger', () => {
 
     });
 
+    it('logger npmlog', () => {
+
+        const npmlog = require('npmlog');
+        npmlog.info('abcddd');
+
+    });
+
 });
diff --git a/src/prompt/index.js b/src/prompt/index.js
@@ -0,0 +1,88 @@
+'use strict';
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const logger = require('../logger');
+const npmlog = logger.npmlog;
+
+const SCOPE_NAME = require('../constants').SCOPE_NAME || '@micro-app';
+const prefix = `[${chalk.green('?')}] ${chalk.bgBlack(chalk.whiteBright(SCOPE_NAME))}`;
+
+function createDefaultOptions(options = {}) {
+    return Object.assign({
+        prefix,
+    }, options);
+}
+
+function confirm(message) {
+    npmlog.pause();
+
+    return inquirer
+        .prompt([
+            createDefaultOptions({
+                type: 'expand',
+                name: 'confirm',
+                message,
+                default: 2, // default to help in order to avoid clicking straight through
+                choices: [
+                    { key: 'y', name: 'Yes', value: true },
+                    { key: 'n', name: 'No', value: false },
+                ],
+            }),
+        ])
+        .then(answers => {
+            npmlog.resume();
+
+            return answers.confirm;
+        });
+}
+
+function select(message, { choices, filter, validate } = {}) {
+    if (!choices || choices.length <= 0) {
+        logger.throw('prompt', 'select choices is empty!');
+    }
+
+    npmlog.pause();
+
+    return inquirer
+        .prompt([
+            createDefaultOptions({
+                type: 'list',
+                name: 'prompt',
+                message,
+                choices,
+                pageSize: choices.length,
+                filter,
+                validate,
+            }),
+        ])
+        .then(answers => {
+            npmlog.resume();
+
+            return answers.prompt;
+        });
+}
+
+function input(message, { filter, validate } = {}) {
+    npmlog.pause();
+
+    return inquirer
+        .prompt([
+            createDefaultOptions({
+                type: 'input',
+                name: 'input',
+                message,
+                filter,
+                validate,
+            }),
+        ])
+        .then(answers => {
+            npmlog.resume();
+
+            return answers.input;
+        });
+}
+
+exports.confirm = confirm;
+exports.select = select;
+exports.input = input;
diff --git a/src/prompt/prompt.test.js b/src/prompt/prompt.test.js
@@ -0,0 +1,16 @@
+'use strict';
+
+/* global expect */
+
+// const prompt = require('.');
+
+describe('prompt', () => {
+
+    it('confirm', async () => {
+
+        // const result = await prompt.confirm('are you sure?');
+
+        // console.log(result);
+    });
+
+});
diff --git a/src/smartMerge/index.js b/src/smartMerge/index.js
diff --git a/src/smartMerge/smartMerge.test.js b/src/smartMerge/smartMerge.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { smartMerge } = require('../');
+const { smartMerge } = require('../..');
 const merge = require('webpack-merge');
 
 describe('smartMerge', () => {
diff --git a/src/virtualFile/index.js b/src/virtualFile/index.js
diff --git a/src/virtualFile/virtualFile.test.js b/src/virtualFile/virtualFile.test.js
@@ -3,21 +3,20 @@
 /* global expect */
 
 const fs = require('fs-extra');
-const path = require('path');
-const { virtualFile } = require('../');
+const { virtualFile } = require('../..');
 
 describe('virtualFile', () => {
 
     it('require', () => {
-        const file = path.resolve(__dirname, 'a.js');
+        const file = require.resolve(__dirname, '../../test/a.js');
         const jsText = fs.readFileSync(file);
         virtualFile.register(file, jsText);
 
         virtualFile.require(file);
     });
 
     it('require test', () => {
-        const file = path.resolve(__dirname, 'b.js');
+        const file = require.resolve(__dirname, '../../test/b.js');
         const jsText = fs.readFileSync(file);
         virtualFile.register(file, jsText);
 
@@ -36,7 +35,7 @@ describe('virtualFile', () => {
     });
 
     it('require function', () => {
-        const file = require.resolve('../src/logger.js');
+        const file = require.resolve('../logger');
         virtualFile.register(file, content => {
             return content.replace('INFO', 'CCTV');
         });
diff --git a/test/npmlog.js b/test/npmlog.js
@@ -0,0 +1,26 @@
+'use strict';
+
+const npmlog = require('../src/logger');
+
+// npmlog.prefixStyle = {
+
+// };
+
+// npmlog.heading = '333'
+
+// npmlog.headingStyle = {
+//     bg: 'red',
+// };
+
+npmlog.info('abc', 'haha..');
+npmlog.error('abc', 'haha..');
+npmlog.warn('abc', 'haha..');
+npmlog.warn('', 'haha..');
+npmlog.success('haha..');
+npmlog.debug('111haha..');
+npmlog.noise(false, 'haha..');
+
+npmlog.throw(new Error('abbdd'), 'abc..');
+
+// console.log(npmlog.record)
+// console.log(npmlog.level)
diff --git a/test/prompt.js b/test/prompt.js
diff --git a/yarn.lock b/yarn.lock
