@modern-js/utils 1.3.7 → 1.5.0

package/dist/types/constants.d.ts

@@ -1,219 +0,0 @@
-/**
- * hmr socket connect path
- */
-export declare const HMR_SOCK_PATH = "/_modern_js_hmr_ws";
-/**
- * route specification file
- */
-
-export declare const ROUTE_SPEC_FILE = "route.json";
-/**
- * main entry name
- */
-
-export declare const MAIN_ENTRY_NAME = "main";
-/**
- * open editor request path
- */
-
-export declare const LAUNCH_EDITOR_ENDPOINT = "/__open-stack-frame-in-editor";
-/**
- * server side bundles directory, which relative to dist.
- */
-
-export declare const SERVER_BUNDLE_DIRECTORY = "bundles";
-/**
- * entry name pattern used for ajv pattern properties.
- */
-
-export declare const ENTRY_NAME_PATTERN = "^[a-zA-Z0-9_-]+$";
-/**
- * SSR server render function name
- */
-
-export declare const SERVER_RENDER_FUNCTION_NAME = "serverRender";
-/**
- * loadbale manifest json file
- */
-
-export declare const LOADABLE_STATS_FILE = "loadable-stats.json";
-/**
- * internal specified folder
- */
-
-export declare const API_DIR = "api";
-export declare const SERVER_DIR = "server";
-export declare const SHARED_DIR = "shared";
-/**
- * Internal plugins that work as soon as they are installed.
- */
-
-export declare const INTERNAL_PLUGINS: {
-  [name: string]: {
-    cli?: string;
-    server?: string;
-  };
-};
-/**
- * The schema registered in the plugin.
- */
-
-export declare const PLUGIN_SCHEMAS: {
-  '@modern-js/runtime': ({
-    target: string;
-    schema: {
-      type: string;
-      additionalProperties: boolean;
-      patternProperties?: undefined;
-    };
-  } | {
-    target: string;
-    schema: {
-      type: string;
-      patternProperties: {
-        "^[a-zA-Z0-9_-]+$": {
-          type: string;
-        };
-      };
-      additionalProperties: boolean;
-    };
-  })[];
-  '@modern-js/plugin-bff': {
-    target: string;
-    schema: {
-      type: string;
-      properties: {
-        prefix: {
-          type: string[];
-          items: {
-            type: string;
-          };
-        };
-        fetcher: {
-          type: string;
-        };
-        proxy: {
-          type: string;
-        };
-        requestCreator: {
-          type: string;
-        };
-      };
-    };
-  }[];
-  '@modern-js/plugin-esbuild': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-less': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-sass': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-tailwindcss': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-proxy': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-unbundle': ({
-    target: string;
-    schema: {
-      type: string;
-      properties?: undefined;
-    };
-  } | {
-    target: string;
-    schema: {
-      type: string;
-      properties: {
-        ignore: {
-          type: string[];
-          items: {
-            type: string;
-          };
-        };
-        ignoreModuleCache: {
-          type: string;
-        };
-        clearPdnCache: {
-          type: string;
-        };
-        pdnHost: {
-          type: string;
-        };
-      };
-    };
-  })[];
-  '@modern-js/plugin-ssg': {
-    target: string;
-    schema: {
-      oneOf: ({
-        type: string;
-        instanceof?: undefined;
-      } | {
-        instanceof: string;
-        type?: undefined;
-      })[];
-    };
-  }[];
-  '@modern-js/plugin-ssr': {
-    target: string;
-    schema: {
-      type: string[];
-    };
-  }[];
-  '@modern-js/plugin-state': {
-    target: string;
-    schema: {
-      type: string[];
-    };
-  }[];
-  '@modern-js/plugin-design-token': ({
-    target: string;
-    schema: {
-      typeof: string[];
-      type?: undefined;
-    };
-  } | {
-    target: string;
-    schema: {
-      type: string[];
-      typeof?: undefined;
-    };
-  })[];
-  '@modern-js/plugin-router': {
-    target: string;
-    schema: {
-      type: string[];
-    };
-  }[];
-  '@modern-js/plugin-testing': {
-    target: string;
-    schema: {
-      typeof: string[];
-    };
-  }[];
-  '@modern-js/plugin-garfish': {
-    target: string;
-    schema: {
-      type: string[];
-    };
-  }[];
-  '@modern-js/plugin-nocode': never[];
-};

package/dist/types/debug.d.ts

@@ -1,8 +0,0 @@
-import debug from 'debug';
-/**
- * Create debug function with unified namespace prefix.
- * @param scope - Custom module name of your debug function.
- * @returns Debug function which namespace start with modern-js:.
- */
-
-export declare const createDebugger: (scope: string) => debug.Debugger;

package/dist/types/emptyDir.d.ts

@@ -1 +0,0 @@
-export declare const emptyDir: (dir: string) => Promise<void>;

package/dist/types/is/platform.d.ts

@@ -1,2 +0,0 @@
-export declare const isNodeJS: () => boolean;
-export declare const isBrowser: () => boolean;

package/dist/types/logger.d.ts

@@ -1,63 +0,0 @@
-import { Color } from 'chalk';
-declare type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-interface LoggerConfiguration {
-  color?: typeof Color;
-  label?: string;
-  level?: LogLevel;
-}
-interface InstanceConfiguration {
-  displayLabel?: boolean;
-  underlineLabel?: boolean;
-  uppercaseLabel?: boolean;
-}
-interface ConstructorOptions {
-  config?: InstanceConfiguration;
-  types?: Record<string, LoggerConfiguration>;
-}
-declare type LoggerFunction = (message?: number | string | Error, ...args: any[]) => void;
-declare const LOG_TYPES: {
-  error: {
-    color: string;
-    label: string;
-    level: string;
-  };
-  info: {
-    color: string;
-    label: string;
-    level: string;
-  };
-  warn: {
-    color: string;
-    label: string;
-    level: string;
-  };
-  debug: {
-    color: string;
-    label: string;
-    level: string;
-  };
-  log: {
-    level: string;
-  };
-};
-
-declare class Logger {
-  private readonly logCount;
-  private history;
-  private readonly config;
-  private readonly types;
-  private readonly longestLabel;
-  [key: string]: any;
-  constructor(options?: ConstructorOptions);
-  private retainLog;
-  private _log;
-  private getLongestLabel;
-  private get longestUnderlinedLabel();
-  getRetainedLogs(type: string): string[];
-  clearRetainedLogs(type: string): void;
-}
-
-declare type LoggerInterface = { [key in keyof typeof LOG_TYPES]: LoggerFunction };
-declare const logger: Logger & LoggerInterface;
-export { logger };
-export type { LoggerInterface };

package/dist/types/pkgUp.d.ts

@@ -1,2 +0,0 @@
-import pkgUp from 'pkg-up';
-export { pkgUp };

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/__snapshots__/prettyInstructions.test.ts.snap

@@ -1,19 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`prettyInstructions The src directory does not exist 1`] = `
-"App running at:
-
-  > Network:  http://127.0.0.1:8080/api
-  > Network:  http://11.11.111.11:8080/api
-  > Network:  http://10.100.100.100:8080/api
-"
-`;
-
-exports[`prettyInstructions basic usage 1`] = `
-"App running at:
-
-  > Network:  http://127.0.0.1:8080/
-  > Network:  http://11.11.111.11:8080/
-  > Network:  http://10.100.100.100:8080/
-"
-`;

package/tests/applyOptionsChain.test.ts

@@ -1,100 +0,0 @@
-import { applyOptionsChain } from '../src/applyOptionsChain';
-
-describe('apply options chain', () => {
-  test(`should return default options`, () => {
-    expect(applyOptionsChain({ default: 'a' })).toEqual({ default: 'a' });
-  });
-
-  test(`should merge default options`, () => {
-    expect(
-      applyOptionsChain(
-        { name: 'a' },
-        {
-          name: 'b',
-          custom: 'c',
-        },
-      ),
-    ).toEqual({
-      name: 'b',
-      custom: 'c',
-    });
-  });
-
-  test(`should support custom merge function`, () => {
-    const merge = (target: any, source: any) => {
-      for (const key in source) {
-        if (target.hasOwnProperty(key)) {
-          target[key] += source[key];
-        } else {
-          target[key] = source[key];
-        }
-      }
-      return target;
-    };
-
-    expect(
-      applyOptionsChain(
-        {
-          a: 1,
-          b: 'b',
-        },
-        {
-          a: 2,
-          b: 'b',
-          c: 'c',
-        },
-        {},
-        merge,
-      ),
-    ).toEqual({
-      a: 3,
-      b: 'bb',
-      c: 'c',
-    });
-  });
-
-  test(`should support funciton or object array`, () => {
-    const defaults = { a: 'a' };
-
-    const options = [
-      { b: 'b' },
-      (o: any, { add }: { add: any }) => {
-        o.c = add(1, 2);
-      },
-      (o: any) => ({
-        ...o,
-        d: 'd',
-      }),
-      { e: 'e' },
-    ];
-    expect(
-      applyOptionsChain(defaults, options as any, {
-        add: (a: any, b: any) => a + b,
-      }),
-    ).toEqual({
-      a: 'a',
-      b: 'b',
-      c: 3,
-      d: 'd',
-      e: 'e',
-    });
-  });
-
-  test(`should throw error`, () => {
-    expect(() => {
-      applyOptionsChain(1, 2);
-    }).toThrow(/^applyOptionsChain error:/);
-  });
-
-  test(`should log warning about function result`, () => {
-    let outputs = '';
-    /* eslint-disable no-console */
-    console.log = jest.fn(input => (outputs += input));
-    /* eslint-enable no-console */
-    applyOptionsChain({ name: 'a' } as any, [() => 111]);
-
-    expect(outputs).toContain(
-      'Function should mutate the config and return nothing, Or return a cloned or merged version of config object.',
-    );
-  });
-});

package/tests/compatRequire.test.ts

@@ -1,32 +0,0 @@
-import path from 'path';
-import { compatRequire, cleanRequireCache } from '../src/compatRequire';
-
-describe('compat require', () => {
-  const fixturePath = path.resolve(__dirname, './fixtures/compat-require');
-
-  test(`should support default property`, () => {
-    expect(compatRequire(path.join(fixturePath, 'esm.js'))).toEqual({
-      name: 'esm',
-    });
-  });
-
-  test(`should support commonjs module`, () => {
-    expect(compatRequire(path.join(fixturePath, 'cjs.js'))).toEqual({
-      name: 'cjs',
-    });
-  });
-
-  test(`should return null`, () => {
-    expect(compatRequire(path.join(fixturePath, 'empty.js'))).toEqual(null);
-  });
-
-  test('should clearn cache after fn', () => {
-    const foo = module.require('./fixtures/compat-require/foo');
-    const requirePath = require.resolve('./fixtures/compat-require/foo.js');
-    expect(foo.name).toBe('foo');
-    expect(require.cache[requirePath]).toBeDefined();
-    cleanRequireCache([requirePath]);
-    jest.resetModules();
-    expect(require.cache[requirePath]).toBeUndefined();
-  });
-});

package/tests/debug.test.ts

@@ -1,25 +0,0 @@
-import debug from 'debug';
-import stripAnsi from 'strip-ansi';
-import { createDebugger } from '../src/debug';
-
-describe('debug utility', () => {
-  test('should return file path', () => {
-    const debug1 = createDebugger('test');
-
-    const debug2 = createDebugger('test2');
-
-    debug.enable('modern-js:test2');
-
-    debug.log = (...args) => {
-      // XXX: args[0] 的内容有时候是 '  \x1B[38;5;167;1mmodern-js:test2 \x1B[0m22222' 这种格式
-      expect(stripAnsi(args[0])).toContain('modern-js:test2 22222');
-    };
-
-    debug1('11111');
-    debug2('22222');
-
-    expect(debug2.enabled).toBe(true);
-
-    expect(debug1.enabled).toBe(false);
-  });
-});

package/tests/ensureAbsolutePath.test.ts

@@ -1,16 +0,0 @@
-import path from 'path';
-import { ensureAbsolutePath } from '../src/ensureAbsolutePath';
-
-describe('ensure absolute file path', () => {
-  test('should return filePath directly', () => {
-    expect(
-      path.isAbsolute(ensureAbsolutePath('/a/b', '/a/b/c/d/e.jsx')),
-    ).toBeTruthy();
-  });
-
-  test(`should resolve absolute path`, () => {
-    expect(
-      path.isAbsolute(ensureAbsolutePath('/a/b', 'c/d/e.jsx')),
-    ).toBeTruthy();
-  });
-});

package/tests/findExists.test.ts

@@ -1,22 +0,0 @@
-import path from 'path';
-import { findExists } from '../src/findExists';
-
-describe('find first exists file', () => {
-  const fixturePath = path.resolve(__dirname, './fixtures/file-exists');
-
-  test('should return file path', () => {
-    expect(
-      findExists(
-        ['.js', '.ts', '.ejs', '.mjs'].map(ext =>
-          path.join(fixturePath, `a${ext}`),
-        ),
-      ),
-    ).toEqual(path.join(fixturePath, 'a.ts'));
-  });
-
-  test('should return false when no file exists', () => {
-    expect(
-      findExists(['.jsx'].map(ext => path.join(fixturePath, `a${ext}`))),
-    ).toBe(false);
-  });
-});

package/tests/fixtures/browserlist/develop/package.json

@@ -1,11 +0,0 @@
-{
-  "name": "test-browserlist-develop",
-  "browserslist": {
-    "development": [
-      "last 1 chrome version"
-    ],
-    "production": [
-      "IOS 7"
-    ]
-  }
-}

package/tests/fixtures/browserlist/dotfile/.browserslistrc

@@ -1,3 +0,0 @@
-defaults
-not IE 11
-maintained node versions

package/tests/fixtures/browserlist/pkg/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "test-browserlist-pkg",
-  "browserslist": [
-    "not IE 11",
-    "maintained node versions"
-  ]
-}

package/tests/fixtures/compat-require/cjs.js

@@ -1 +0,0 @@
-module.exports = { name: 'cjs' };

package/tests/fixtures/compat-require/empty.js

@@ -1 +0,0 @@
-module.exports = null;

package/tests/fixtures/compat-require/esm.js

@@ -1,5 +0,0 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const _default = { name: 'esm' };
-
-exports.default = _default;

package/tests/fixtures/compat-require/foo.js

@@ -1,3 +0,0 @@
-module.exports = {
-  name: 'foo',
-};

package/tests/format.test.ts

@@ -1,60 +0,0 @@
-import { formatProxyOptions } from '../src/format';
-
-describe('test format', () => {
-  it('should format correctly use simply options', async () => {
-    const proxy = {
-      '/simple': `http://localhost`,
-    };
-
-    const options = formatProxyOptions(proxy);
-    expect(options).toEqual([
-      {
-        context: '/simple',
-        changeOrigin: true,
-        logLevel: 'warn',
-        target: 'http://localhost',
-      },
-    ]);
-  });
-
-  it('should format correctly use simply options', async () => {
-    const proxy = {
-      '/simple-obj': {
-        target: `http://localhost`,
-      },
-    };
-    const options = formatProxyOptions(proxy);
-    expect(options).toEqual([
-      {
-        context: '/simple-obj',
-        changeOrigin: true,
-        logLevel: 'warn',
-        target: 'http://localhost',
-      },
-    ]);
-  });
-
-  it('should format correctly use simply options', async () => {
-    const proxy = {
-      context: '/context',
-      target: `http://localhost`,
-    };
-    const options = formatProxyOptions(proxy);
-    expect(options).toEqual([
-      { context: '/context', target: 'http://localhost' },
-    ]);
-  });
-
-  it('should format correctly use simply options', async () => {
-    const proxy = [
-      {
-        context: '/array',
-        target: `http://localhost`,
-      },
-    ];
-    const options = formatProxyOptions(proxy);
-    expect(options).toEqual([
-      { context: '/array', target: 'http://localhost' },
-    ]);
-  });
-});

package/tests/generateMetaTags.test.ts

@@ -1,19 +0,0 @@
-import { generateMetaTags } from '../src/generateMetaTags';
-
-describe('generateMetaTags', () => {
-  it('should return empty string when params is empty', () => {
-    expect(generateMetaTags()).toEqual('');
-  });
-
-  it('should generate meta tag correctly', () => {
-    const options = {
-      foo: {
-        name: 'viewport',
-        content: 'width=500, initial-scale=1',
-      },
-    };
-    expect(generateMetaTags(options).trim()).toEqual(
-      '<meta name="viewport" content="width=500, initial-scale=1">',
-    );
-  });
-});