shuvi 1.0.22 → 1.0.23

package/lib/cli.js

@@ -1,73 +1,45 @@
 #!/usr/bin/env node
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
-const spawn = __importStar(require("cross-spawn"));
-const logger_1 = __importDefault(require("@shuvi/utils/logger"));
+const commander_1 = require("commander");
+const dev_1 = __importDefault(require("./commands/dev"));
+const build_1 = __importDefault(require("./commands/build"));
+const inspect_1 = __importDefault(require("./commands/inspect"));
+const serve_1 = __importDefault(require("./commands/serve"));
+const lint_1 = __importDefault(require("./commands/lint"));
+const constants_1 = require("./constants");
+const options_1 = require("./commands/utils/options");
 const utils_1 = require("./utils");
-const Commands = ['dev', 'build', 'serve', 'inspect'];
-const pkgInfo = (0, utils_1.getPackageInfo)();
-// must be before .parse()
-commander_1.default.on('--help', () => {
-    logger_1.default.info('');
-    logger_1.default.info('Avaliable cmds:');
-    logger_1.default.info(`  ${Commands.join(', ')}`);
-});
-commander_1.default.name('shuvi').version(pkgInfo.version).usage('<cmd> [options]');
-commander_1.default.allowUnknownOption().parse();
-const args = commander_1.default.args;
-const [cmd, ...commandArgs] = args.length ? args : ['dev'];
-if (!Commands.includes(cmd)) {
-    logger_1.default.error('Unknown command "' + cmd + '".');
-    commander_1.default.outputHelp();
-    process.exit(1);
-}
-const nodeEnv = cmd === 'dev' ? 'development' : 'production';
-const result = spawn.sync('node', [
-    require.resolve('./agent'),
-    require.resolve('./cmds/' + cmd),
-    ...commandArgs
-], {
-    stdio: 'inherit',
-    env: Object.assign(Object.assign({}, process.env), { NODE_ENV: nodeEnv })
-});
-if (result.signal) {
-    if (result.signal === 'SIGKILL') {
-        logger_1.default.error('The build failed because the process exited too early. ' +
-            'This probably means the system ran out of memory or someone called ' +
-            '`kill -9` on the process.');
-    }
-    else if (result.signal === 'SIGTERM') {
-        logger_1.default.error('The build failed because the process exited too early. ' +
-            'Someone might have called `kill` or `killall`, or the system could ' +
-            'be shutting down.');
+const { name, description, version } = (0, utils_1.getPackageInfo)();
+const program = new commander_1.Command();
+const devCommand = (0, dev_1.default)().copyInheritedSettings(program);
+const buildCommand = (0, build_1.default)().copyInheritedSettings(program);
+const inspectCommand = (0, inspect_1.default)().copyInheritedSettings(program);
+const serveCommand = (0, serve_1.default)().copyInheritedSettings(program);
+const lintCommand = (0, lint_1.default)().copyInheritedSettings(program);
+program
+    .name(name)
+    .description(description)
+    .version(version)
+    .showHelpAfterError('(add --help for additional information)')
+    .addOption(options_1.optionNoColor)
+    .addCommand(devCommand)
+    .addCommand(buildCommand)
+    .addCommand(inspectCommand)
+    .addCommand(serveCommand)
+    .addCommand(lintCommand)
+    .usage(`[command] [dir] [options]`)
+    .configureHelp({
+    subcommandTerm: cmd => {
+        return `${cmd.name()} ${cmd.usage()}`;
     }
-    process.exit(1);
-}
-process.exit(result.status);
+})
+    .addHelpText('beforeAll', constants_1.TITLE)
+    .addHelpText('after', constants_1.HELPER)
+    .configureOutput({
+    outputError: (str, write) => write(utils_1.color.error(str)) // Highlight errors in color.
+})
+    .parseAsync(process.argv);

package/lib/commands/build.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const _default: () => Command;
+export default _default;

package/lib/{cmds → commands}/build.js

@@ -35,13 +35,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
+const commander_1 = require("commander");
 const path = __importStar(require("path"));
 const logger_1 = __importDefault(require("@shuvi/utils/logger"));
 const build_1 = require("../tasks/build");
 const utils_1 = require("../utils");
 const config_1 = require("../config");
-const pkgInfo = (0, utils_1.getPackageInfo)();
+const options_1 = require("./utils/options");
 const cliConfigMap = {
     analyze: 'analyze',
     publicPath: 'publicPath',
@@ -52,22 +52,27 @@ const cliConfigMap = {
         }
     }
 };
-function main(argv) {
+exports.default = () => {
+    const subCommand = new commander_1.Command('build');
+    subCommand
+        .usage(`[dir] [options]`)
+        .description('build your project')
+        .addArgument(options_1.argumentDir)
+        .addOption(options_1.optionPublicPath)
+        .addOption(options_1.optionTarget)
+        .addOption(options_1.optionRouterHistory)
+        .addOption(options_1.optionAnalyze)
+        .addOption(options_1.optionConfig)
+        .addOption(options_1.optionOverrides)
+        .action(buildAction);
+    return subCommand;
+};
+function buildAction(dir, options) {
     return __awaiter(this, void 0, void 0, function* () {
-        commander_1.default
-            .name(pkgInfo.name)
-            .usage(`build [dir] [options]`)
-            .helpOption()
-            .option('--public-path <url>', 'specify the asset prefix. eg: https://some.cdn.com')
-            .option('--target <target>', 'specify the app output target. eg: spa')
-            .option('--router-history <history>', "specify the hisotry type. 'browser' or 'hash'")
-            .option('--analyze', 'generate html file to help analyze webpack bundle')
-            .option('--config <file>', 'path to config file')
-            .option('--config-overrides <json>', 'config overrides json')
-            .parse(argv, { from: 'user' });
-        const cwd = (0, utils_1.getProjectDir)(commander_1.default);
-        const configFile = commander_1.default.config && path.resolve(cwd, commander_1.default.config);
-        const config = yield (0, config_1.getConfigFromCli)(commander_1.default, cliConfigMap);
+        process.env.NODE_ENV = 'production';
+        const cwd = (0, utils_1.getProjectDir)(dir);
+        const configFile = options.config && path.resolve(cwd, options.config);
+        const config = yield (0, config_1.getConfigFromCli)(options, cliConfigMap);
         try {
             yield (0, build_1.build)({
                 cwd,
@@ -83,4 +88,3 @@ function main(argv) {
         }
     });
 }
-exports.default = main;

package/lib/commands/dev.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+declare const _default: () => Command;
+export default _default;

package/lib/{cmds → commands}/dev.js

@@ -35,31 +35,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
+const commander_1 = require("commander");
 const path = __importStar(require("path"));
 const service_1 = require("@shuvi/service");
 const logger_1 = __importDefault(require("@shuvi/utils/logger"));
 const utils_1 = require("../utils");
 const config_1 = require("../config");
 const shuvi_1 = require("../shuvi");
-function main(argv) {
+const options_1 = require("./utils/options");
+exports.default = () => {
+    const subCommand = new commander_1.Command('dev');
+    subCommand
+        .usage(`[dir] [options]`)
+        .description('run your project locally in development')
+        .addArgument(options_1.argumentDir)
+        .addOption(options_1.optionHostDev)
+        .addOption(options_1.optionPort)
+        .addOption(options_1.optionConfig)
+        .addOption(options_1.optionOverrides)
+        .action(devAction);
+    return subCommand;
+};
+function devAction(dir, options) {
     return __awaiter(this, void 0, void 0, function* () {
+        process.env.NODE_ENV = 'development';
         const startTime = performance.now();
-        const pkgInfo = (0, utils_1.getPackageInfo)();
-        commander_1.default
-            .name(pkgInfo.name)
-            .usage(`dev [dir] [options]`)
-            .helpOption()
-            .option('--host <host>', 'specify host')
-            .option('--port <port>', 'specify port')
-            .option('--config <file>', 'path to config file')
-            .option('--config-overrides <json>', 'config overrides json')
-            .parse(argv, { from: 'user' });
-        const cwd = (0, utils_1.getProjectDir)(commander_1.default);
-        const port = Number(commander_1.default.port) || 3000;
-        const host = commander_1.default.host || 'localhost';
-        const configFile = commander_1.default.config && path.resolve(cwd, commander_1.default.config);
-        const config = yield (0, config_1.getConfigFromCli)(commander_1.default);
+        const cwd = (0, utils_1.getProjectDir)(dir);
+        const { host, port } = options;
+        const configFile = options.config && path.resolve(cwd, options.config);
+        const config = yield (0, config_1.getConfigFromCli)(options);
         const api = yield (0, shuvi_1.initShuvi)({
             cwd,
             config,
@@ -93,4 +97,3 @@ function main(argv) {
         }
     });
 }
-exports.default = main;

package/lib/commands/eslint/compile-error.d.ts

@@ -0,0 +1,2 @@
+export declare class CompileError extends Error {
+}

package/lib/commands/eslint/compile-error.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompileError = void 0;
+class CompileError extends Error {
+}
+exports.CompileError = CompileError;

package/lib/commands/eslint/core/customFormatter.d.ts

@@ -0,0 +1,26 @@
+export declare enum MessageSeverity {
+    Warning = 1,
+    Error = 2
+}
+interface LintMessage {
+    ruleId: string | null;
+    severity: 1 | 2;
+    message: string;
+    line: number;
+    column: number;
+}
+export interface LintResult {
+    filePath: string;
+    messages: LintMessage[];
+    errorCount: number;
+    warningCount: number;
+    output?: string;
+    source?: string;
+}
+export declare function formatResults(baseDir: string, results: LintResult[], format: (r: LintResult[]) => string): {
+    output: string;
+    outputWithMessages: string;
+    totalShuviPluginErrorCount: number;
+    totalShuviPluginWarningCount: number;
+};
+export {};

package/lib/commands/eslint/core/customFormatter.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatResults = exports.MessageSeverity = void 0;
+/* eslint-disable prefer-template */
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+// eslint-disable-next-line no-shadow
+var MessageSeverity;
+(function (MessageSeverity) {
+    MessageSeverity[MessageSeverity["Warning"] = 1] = "Warning";
+    MessageSeverity[MessageSeverity["Error"] = 2] = "Error";
+})(MessageSeverity = exports.MessageSeverity || (exports.MessageSeverity = {}));
+function pluginCount(messages) {
+    let pluginWarningCount = 0;
+    let pluginErrorCount = 0;
+    for (let i = 0; i < messages.length; i++) {
+        const { severity, ruleId } = messages[i];
+        if (ruleId === null || ruleId === void 0 ? void 0 : ruleId.includes('@shuvi/shuvi')) {
+            if (severity === MessageSeverity.Warning) {
+                pluginWarningCount += 1;
+            }
+            else {
+                pluginErrorCount += 1;
+            }
+        }
+    }
+    return {
+        pluginErrorCount,
+        pluginWarningCount
+    };
+}
+function formatMessage(dir, messages, filePath) {
+    let fileName = path_1.default.posix.normalize(path_1.default.relative(dir, filePath).replace(/\\/g, '/'));
+    if (!fileName.startsWith('.')) {
+        fileName = './' + fileName;
+    }
+    let output = '\n' + chalk_1.default.cyan(fileName);
+    for (let i = 0; i < messages.length; i++) {
+        const { message, severity, line, column, ruleId } = messages[i];
+        output = output + '\n';
+        if (line && column) {
+            output =
+                output +
+                    chalk_1.default.yellow(line.toString()) +
+                    ':' +
+                    chalk_1.default.yellow(column.toString()) +
+                    '  ';
+        }
+        if (severity === MessageSeverity.Warning) {
+            output += chalk_1.default.yellow.bold('Warning') + ': ';
+        }
+        else {
+            output += chalk_1.default.red.bold('Error') + ': ';
+        }
+        output += message;
+        if (ruleId) {
+            output += '  ' + chalk_1.default.gray.bold(ruleId);
+        }
+    }
+    return output;
+}
+function formatResults(baseDir, results, format) {
+    let totalShuviPluginErrorCount = 0;
+    let totalShuviPluginWarningCount = 0;
+    let resultsWithMessages = results.filter(({ messages }) => messages === null || messages === void 0 ? void 0 : messages.length);
+    // Track number of shuvi.js plugin errors and warnings
+    resultsWithMessages.forEach(({ messages }) => {
+        const res = pluginCount(messages);
+        totalShuviPluginErrorCount += res.pluginErrorCount;
+        totalShuviPluginWarningCount += res.pluginWarningCount;
+    });
+    // Use user defined formatter or Shuvi.js's built-in custom formatter
+    const output = format
+        ? format(resultsWithMessages)
+        : resultsWithMessages
+            .map(({ messages, filePath }) => formatMessage(baseDir, messages, filePath))
+            .join('\n');
+    return {
+        output: output,
+        outputWithMessages: resultsWithMessages.length > 0
+            ? output +
+                `\n\n${chalk_1.default.cyan('info')}  - Need to disable some ESLint rules?`
+            : '',
+        totalShuviPluginErrorCount,
+        totalShuviPluginWarningCount
+    };
+}
+exports.formatResults = formatResults;

package/lib/commands/eslint/core/hasEslintConfiguration.d.ts

@@ -0,0 +1,9 @@
+export declare type ConfigAvailable = {
+    exists: boolean;
+    emptyEslintrc?: boolean;
+    emptyPkgJsonConfig?: boolean;
+    firstTimeSetup?: true;
+};
+export declare function hasEslintConfiguration(eslintrcFile: string | null, packageJsonConfig: {
+    eslintConfig: any;
+} | null): Promise<ConfigAvailable>;

package/lib/commands/eslint/core/hasEslintConfiguration.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasEslintConfiguration = void 0;
+const fs_1 = require("fs");
+function hasEslintConfiguration(eslintrcFile, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+packageJsonConfig) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const configObject = {
+            exists: false,
+            emptyEslintrc: false,
+            emptyPkgJsonConfig: false
+        };
+        if (eslintrcFile) {
+            const content = yield fs_1.promises.readFile(eslintrcFile, { encoding: 'utf8' }).then(txt => txt.trim().replace(/\n/g, ''), () => null);
+            if (content === '' ||
+                content === '{}' ||
+                content === '---' ||
+                content === 'module.exports = {}') {
+                return Object.assign(Object.assign({}, configObject), { emptyEslintrc: true });
+            }
+            return Object.assign(Object.assign({}, configObject), { exists: true });
+        }
+        else if (packageJsonConfig === null || packageJsonConfig === void 0 ? void 0 : packageJsonConfig.eslintConfig) {
+            if (Object.keys(packageJsonConfig === null || packageJsonConfig === void 0 ? void 0 : packageJsonConfig.eslintConfig).length) {
+                return Object.assign(Object.assign({}, configObject), { exists: true });
+            }
+            return Object.assign(Object.assign({}, configObject), { emptyPkgJsonConfig: true });
+        }
+        return configObject;
+    });
+}
+exports.hasEslintConfiguration = hasEslintConfiguration;

package/lib/commands/eslint/core/runLintCheck.d.ts

@@ -0,0 +1,31 @@
+export declare const ESLINT_PROMPT_VALUES: ({
+    title: string;
+    config: {
+        extends: string;
+    };
+} | {
+    title: string;
+    config: null;
+})[];
+declare function lint(baseDir: string, lintDirs: string[], eslintrcFile: string | null, pkgJsonPath: string | null, { lintDuringBuild, eslintOptions, reportErrorsOnly, maxWarnings, formatter, outputFile }: {
+    lintDuringBuild: boolean;
+    eslintOptions: any;
+    reportErrorsOnly: boolean;
+    maxWarnings: number;
+    formatter: string | null;
+    outputFile: string | null;
+}): Promise<string | null | {
+    output: string | null;
+    isError: boolean;
+    eventInfo: any;
+}>;
+export declare function runLintCheck(baseDir: string, lintDirs: string[], opts: {
+    lintDuringBuild?: boolean;
+    eslintOptions?: any;
+    reportErrorsOnly?: boolean;
+    maxWarnings?: number;
+    formatter?: string | null;
+    outputFile?: string | null;
+    strict?: boolean;
+}): ReturnType<typeof lint>;
+export {};