feat: add CONSTANTS & isDocker, art test file

zyao89 · zyao89 · commit 5d859f844e7c · 2020-06-04T15:41:49.000+08:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
diff --git a/index.d.ts b/index.d.ts
@@ -27,6 +27,7 @@ export * as onExit from 'signal-exit';
 export * as hash from 'hash-sum';
 export * as path from 'path';
 export * as tryRequire from 'try-require';
+export * as isDocker from 'is-docker';
 
 export function assert(value: any, message?: string | Error): void;
 
@@ -42,3 +43,4 @@ export * as Env from './src/Env';
 export * as validateSchema from './src/validateSchema';
 export * as loadFile from './src/loadFile';
 export * as pluginResolution from './src/pluginResolution';
+export * as CONSTANTS from './src/constants';
diff --git a/index.js b/index.js
@@ -25,6 +25,7 @@ const internal = [
     'Env',
     'validateSchema',
     'pluginResolution',
+    'CONSTANTS',
 ].reduce((obj, key) => {
     obj[key] = `./src/${key}`;
     return obj;
@@ -62,6 +63,7 @@ const thirdParty = {
     onExit: 'signal-exit',
     hash: 'hash-sum',
     path: 'path',
+    isDocker: 'is-docker',
 };
 
 Object.keys(thirdParty).forEach(key => {
diff --git a/package.json b/package.json
@@ -71,6 +71,7 @@
         "hash-sum": "^2.0.0",
         "import-fresh": "^3.2.1",
         "inquirer": "^7.1.0",
+        "is-docker": "^2.0.0",
         "is-glob": "^4.0.1",
         "lodash": "^4.17.15",
         "lru-cache": "^5.1.1",
diff --git a/src/Env/index.js b/src/Env/index.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const { execSync } = require('child_process');
-const fs = require('fs');
+const fs = require('fs-extra');
 const path = require('path');
 const LRU = require('lru-cache');
 const semver = require('semver');
diff --git a/src/constants/index.js b/src/constants/index.js
@@ -1,7 +1,32 @@
 'use strict';
 
-module.exports = {
-    NAME: 'Micro App',
-    SCOPE_NAME: '@micro-app',
-    INJECT_ID: '_MICRO_APP_INJECT_',
-};
+const logger = require('../logger');
+
+class Constants {
+
+    constructor() {
+        this.NAME = 'Micro App';
+        this.SCOPE_NAME = '@micro-app';
+        this.INJECT_ID = '_MICRO_APP_INJECT_';
+    }
+
+    set(key, value) {
+        this[key] = value;
+    }
+
+    get(key) {
+        return this[key] || null;
+    }
+
+    freeze(key, value) {
+        Object.defineProperty(this, key, {
+            get() { return value; },
+            set() {
+                logger.warn('[freeze]', `"${key}" be freezed, Not Allow Change!`);
+            },
+            enumerable: true,
+        });
+    }
+}
+
+module.exports = new Constants();
diff --git a/src/injectHtml.js b/src/injectHtml.js
@@ -7,6 +7,7 @@ const stream = require('stream');
 const CONSTANTS = require('./constants');
 
 module.exports = async function injectHtml(ctx) {
+    const INJECT_ID = CONSTANTS.get('INJECT_ID');
     // 处理文件注入一些信息
     let ok = false;
     if (ctx && ctx.method === 'GET' && ctx.type === 'text/html') {
@@ -22,7 +23,6 @@ module.exports = async function injectHtml(ctx) {
             ctx.body = body;
             try {
                 const $ = cheerio.load(ctx.body);
-                const { INJECT_ID } = CONSTANTS;
                 if ($(`body>#${INJECT_ID}`).length <= 0) {
                     const INJECT_MICRO_APP = `{
                         cache: {},
@@ -54,7 +54,6 @@ module.exports = async function injectHtml(ctx) {
     function func(key, value) {
         if (ok && key) {
             const $ = cheerio.load(ctx.body);
-            const { INJECT_ID } = CONSTANTS;
             $(`body>#${INJECT_ID}`).append(`<textarea id="${INJECT_ID}_${key}" style="display: none;">${encodeURIComponent(JSON.stringify(value))}</textarea>`);
             ctx.body = $.html();
         }
diff --git a/src/logger/index.js b/src/logger/index.js
@@ -122,8 +122,8 @@ const format = {
     // },
     logo(...arrs) {
         const message = utils.format(...(arrs || []));
-        const { NAME } = CONSTANTS;
-        return `${chalk.bgHex('#662F88')(` ${NAME} `)} ${message}`;
+        const namespace = CONSTANTS.get('NAME');
+        return `${chalk.bgHex('#662F88')(` ${namespace} `)} ${message}`;
     },
     json(...arrs) {
         const message = utils.format(...(arrs || []).map(item => formatObject(item)));
diff --git a/src/moduleAlias/index.js b/src/moduleAlias/index.js
@@ -24,4 +24,5 @@ module.exports = {
     add,
     addPaths,
     addPath: addPaths,
+    Module: moduleAlias,
 };
diff --git a/src/moduleAlias/index.test.js b/src/moduleAlias/index.test.js
diff --git a/test/constants.test.js b/test/constants.test.js
@@ -0,0 +1,32 @@
+'use strict';
+
+/* global expect */
+
+const { CONSTANTS } = require('..');
+
+describe('CONSTANTS', () => {
+
+    it('set', () => {
+
+        CONSTANTS.set('foo', 'bar');
+        expect(CONSTANTS.get('foo')).toEqual('bar');
+
+    });
+
+    it('get', () => {
+
+        CONSTANTS.get('foo1');
+        expect(CONSTANTS.get('foo1')).toEqual(null);
+        expect(CONSTANTS.get('NAME')).toEqual(CONSTANTS.NAME);
+
+    });
+
+    it('freeze', () => {
+
+        CONSTANTS.freeze('foo', 'ff');
+        CONSTANTS.set('foo', 'bar');
+        expect(CONSTANTS.get('foo')).toEqual('ff');
+
+    });
+
+});
diff --git a/test/demo/a.js b/test/demo/a.js
diff --git a/test/demo/a.yaml b/test/demo/a.yaml
diff --git a/test/demo/b.js b/test/demo/b.js
diff --git a/test/demo/npmlog.js b/test/demo/npmlog.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const logger = require('../src/logger');
+const logger = require('../../src/logger');
 
 // npmlog.prefixStyle = {
 
diff --git a/test/demo/prompt.js b/test/demo/prompt.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const prompt = require('../src/prompt');
+const prompt = require('../../src/prompt');
 
 (async () => {
 
diff --git a/test/demo/skipPlugins.js b/test/demo/skipPlugins.js
diff --git a/test/getPadLength.test.js b/test/getPadLength.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { getPadLength } = require('../../');
+const { getPadLength } = require('../');
 
 describe('getPadLength', () => {
 
diff --git a/test/loadFile.test.js b/test/loadFile.test.js
@@ -2,7 +2,9 @@
 
 /* global expect */
 
-const { loadFile } = require('../..');
+const { loadFile } = require('../');
+
+const ROOT = __dirname;
 
 describe('loadFile', () => {
 
@@ -13,31 +15,25 @@ describe('loadFile', () => {
     });
 
     it('not exist', () => {
-        const file = loadFile(process.cwd(), 'abc.jsx');
+        const file = loadFile(ROOT, './demo/abc.jsx');
 
         expect(file).toBeNull();
     });
 
     it('not file', () => {
-        const file = loadFile(process.cwd(), './');
+        const file = loadFile(ROOT, './demo/aa');
 
         expect(file).toBeNull();
     });
 
     it('success', () => {
-        const file = loadFile(process.cwd(), 'test/a.js');
-
-        expect(file).not.toBeNull();
-    });
-
-    it('json', () => {
-        const file = loadFile(process.cwd(), 'package.json');
+        const file = loadFile(ROOT, './demo/a.js');
 
         expect(file).not.toBeNull();
     });
 
     it('yaml', () => {
-        const file = loadFile(process.cwd(), 'test/a.yaml');
+        const file = loadFile(ROOT, './demo/a.yaml');
 
         expect(file).not.toBeNull();
     });
diff --git a/test/logger.test.js b/test/logger.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { logger } = require('../..');
+const { logger } = require('../');
 
 describe('Logger', () => {
 
@@ -93,7 +93,7 @@ describe('Logger', () => {
     });
 
     it('logger createInstance', () => {
-        const { createInstance } = require('.');
+        const { createInstance } = require('../src/logger');
         const newLogger = createInstance();
         newLogger.info('createInstance', 'pause...');
         newLogger.pause();
diff --git a/test/moduleAlias.test.js b/test/moduleAlias.test.js
@@ -0,0 +1,28 @@
+'use strict';
+
+/* global expect */
+
+const { moduleAlias } = require('../');
+const Module = moduleAlias.Module;
+
+describe('moduleAlias', () => {
+
+    it('addPath', () => {
+
+        moduleAlias.addPath(__dirname);
+        moduleAlias.addPaths([ __dirname ]);
+
+        expect(Module._modulePaths).toContain(__dirname);
+    });
+
+    it('add', () => {
+
+        moduleAlias.add({
+            abcd: __dirname,
+        });
+
+        expect(Module._moduleAliasNames.includes('abcd')).toBeTruthy();
+        expect(Module._moduleAliases.abcd).toContain(__dirname);
+    });
+
+});
diff --git a/test/pluginResolution.test.js b/test/pluginResolution.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const { pluginResolution } = require('../..');
+const { pluginResolution } = require('..');
 
 describe('pluginResolution', () => {
 
diff --git a/test/prompt.test.js b/test/prompt.test.js
diff --git a/test/smartMerge.test.js b/test/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/test/validateSchema.test.js b/test/validateSchema.test.js
@@ -2,7 +2,7 @@
 
 /* global expect */
 
-const validateSchema = require('.');
+const { validateSchema } = require('../');
 
 const schema = {
     additionalProperties: false,
diff --git a/test/virtualFile.test.js b/test/virtualFile.test.js
@@ -3,20 +3,23 @@
 /* global expect */
 
 const fs = require('fs-extra');
-const { virtualFile } = require('../..');
+const path = require('path');
+const { virtualFile } = require('../');
+
+const ROOT = __dirname;
 
 describe('virtualFile', () => {
 
     it('require', () => {
-        const file = require.resolve(__dirname, '../../test/a.js');
+        const file = require.resolve(path.join(ROOT, './demo/a.js'));
         const jsText = fs.readFileSync(file);
         virtualFile.register(file, jsText);
 
         virtualFile.require(file);
     });
 
     it('require test', () => {
-        const file = require.resolve(__dirname, '../../test/b.js');
+        const file = require.resolve(path.join(ROOT, './demo/b.js'));
         const jsText = fs.readFileSync(file);
         virtualFile.register(file, jsText);
 
@@ -35,7 +38,7 @@ describe('virtualFile', () => {
     });
 
     it('require function', () => {
-        const file = require.resolve('../logger');
+        const file = require.resolve('../src/logger');
         virtualFile.register(file, content => {
             return content.replace('INFO', 'CCTV');
         });
