@eggjs/scripts 3.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# @eggjs/scripts
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/scripts/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/scripts/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/scripts.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/scripts.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/scripts
+[codecov-image]: https://codecov.io/github/eggjs/scripts/coverage.svg?branch=master
+[codecov-url]: https://codecov.io/github/eggjs/scripts?branch=master
+[download-image]: https://img.shields.io/npm/dm/@eggjs/scripts.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/scripts
+
+deploy tool for egg project.
+
+**Note: Windows is partially supported, see [#22](https://github.com/eggjs/egg-scripts/pull/22)**
+
+## Install
+
+```bash
+npm i @eggjs/scripts --save
+```
+
+## Usage
+
+Add `eggctl` to `package.json` scripts:
+
+```json
+{
+  "scripts": {
+    "start": "eggctl start --daemon",
+    "stop": "eggctl stop"
+  }
+}
+```
+
+Then run as:
+
+- `npm start`
+- `npm stop`
+
+**Note:** `egg-scripts` is not recommended to install global, you should install and use it as npm scripts.
+
+## Command
+
+### start
+
+Start egg at prod mode.
+
+```bash
+$ eggctl start [options] [baseDir]
+
+# Usage
+# eggctl start --port=7001
+# eggctl start ./server
+```
+
+- **Arguments**
+  - `baseDir` - directory of application, default to `process.cwd()`.
+- **Options**
+  - `port` - listening port, default to `process.env.PORT`, if unset, egg will use `7001` as default.
+  - `title` - process title description, use for kill grep, default to `egg-server-${APP_NAME}`.
+  - `workers` - numbers of app workers, default to `process.env.EGG_WORKERS`, if unset, egg will use `os.cpus().length`  as default.
+  - `daemon` - whether run at background daemon mode, don't use it if in docker mode.
+  - `framework` - specify framework that can be absolute path or npm package, default to auto detect.
+  - `env` - server env, default to `process.env.EGG_SERVER_ENV`, recommended to keep empty then use framwork default env.
+  - `stdout` - customize stdout file, default to `$HOME/logs/master-stdout.log`.
+  - `stderr` - customize stderr file, default to `$HOME/logs/master-stderr.log`.
+  - `timeout` - the maximum timeout when app starts, default to 300s.
+  - `ignore-stderr` - whether ignore stderr when app starts.
+  - `sourcemap` / `typescript` / `ts` - provides source map support for stack traces.
+  - `node` - customize node command path, default will find node from $PATH
+
+### stop
+
+Stop egg gracefull.
+
+**Note:** if exec without `--title`, it will kill all egg process.
+
+```bash
+$ eggctl stop [options]
+
+# Usage
+# eggctl stop --title=example
+```
+
+- **Options**
+  - `title` - process title description, use for kill grep.
+  - `timeout` - the maximum timeout when app stop, default to 5s.
+
+## Options in `package.json`
+
+In addition to the command line specification, options can also be specified in `package.json`. However, the command line designation takes precedence.
+
+```js
+{
+  "eggScriptsConfig": {
+    "port": 1234,
+    "ignore-stderr": true,
+    // will pass as `node --max-http-header-size=20000`
+    "node-options--max-http-header-size": "20000",
+    // will pass as `node --allow-wasi`
+    "node-options--allow-wasi": true
+  }
+}
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/scripts)](https://github.com/eggjs/scripts/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import { execute } from '@oclif/core';
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core';
+
+await execute({ dir: import.meta.url });

package/dist/commonjs/baseCommand.d.ts

@@ -0,0 +1,25 @@
+import { Command, Flags, Interfaces } from '@oclif/core';
+import { PackageEgg } from './types.js';
+type Flags<T extends typeof Command> = Interfaces.InferredFlags<typeof BaseCommand['baseFlags'] & T['flags']>;
+type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    static enableJsonFlag: boolean;
+    static baseFlags: {};
+    protected flags: Flags<T>;
+    protected args: Args<T>;
+    protected env: {
+        [x: string]: string | undefined;
+        TZ?: string;
+    };
+    protected pkg: Record<string, any>;
+    protected isESM: boolean;
+    protected pkgEgg: PackageEgg;
+    protected globalExecArgv: string[];
+    init(): Promise<void>;
+    protected initBaseInfo(baseDir: string): Promise<void>;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    protected finally(_: Error | undefined): Promise<any>;
+}
+export {};

package/dist/commonjs/baseCommand.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const node_util_1 = require("node:util");
+const core_1 = require("@oclif/core");
+const utility_1 = require("utility");
+const node_path_1 = __importDefault(require("node:path"));
+const debug = (0, node_util_1.debuglog)('@eggjs/scripts/baseCommand');
+class BaseCommand extends core_1.Command {
+    // add the --json flag
+    static enableJsonFlag = false;
+    // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+    // 'log-level': Flags.option({
+    //   default: 'info',
+    //   helpGroup: 'GLOBAL',
+    //   options: ['debug', 'warn', 'error', 'info', 'trace'] as const,
+    //   summary: 'Specify level for logging.',
+    // })(),
+    };
+    flags;
+    args;
+    env = { ...process.env };
+    pkg;
+    isESM;
+    pkgEgg;
+    globalExecArgv = [];
+    async init() {
+        await super.init();
+        debug('[init] raw args: %o, NODE_ENV: %o', this.argv, this.env.NODE_ENV);
+        const { args, flags } = await this.parse({
+            flags: this.ctor.flags,
+            baseFlags: super.ctor.baseFlags,
+            enableJsonFlag: this.ctor.enableJsonFlag,
+            args: this.ctor.args,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+    }
+    async initBaseInfo(baseDir) {
+        const pkg = await (0, utility_1.readJSON)(node_path_1.default.join(baseDir, 'package.json'));
+        this.pkg = pkg;
+        this.pkgEgg = pkg.egg ?? {};
+        this.isESM = pkg.type === 'module';
+        debug('[initBaseInfo] baseDir: %o, pkgEgg: %o, isESM: %o', baseDir, this.pkgEgg, this.isESM);
+    }
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+}
+exports.BaseCommand = BaseCommand;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZUNvbW1hbmQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYmFzZUNvbW1hbmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEseUNBQXFDO0FBQ3JDLHNDQUF5RDtBQUV6RCxxQ0FBbUM7QUFDbkMsMERBQTZCO0FBRTdCLE1BQU0sS0FBSyxHQUFHLElBQUEsb0JBQVEsRUFBQyw0QkFBNEIsQ0FBQyxDQUFDO0FBS3JELE1BQXNCLFdBQXNDLFNBQVEsY0FBTztJQUN6RSxzQkFBc0I7SUFDdEIsTUFBTSxDQUFDLGNBQWMsR0FBRyxLQUFLLENBQUM7SUFFOUIsNkVBQTZFO0lBQzdFLE1BQU0sQ0FBQyxTQUFTLEdBQUc7SUFDakIsOEJBQThCO0lBQzlCLHFCQUFxQjtJQUNyQix5QkFBeUI7SUFDekIsbUVBQW1FO0lBQ25FLDJDQUEyQztJQUMzQyxRQUFRO0tBQ1QsQ0FBQztJQUVRLEtBQUssQ0FBWTtJQUNqQixJQUFJLENBQVc7SUFFZixHQUFHLEdBQUcsRUFBRSxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN6QixHQUFHLENBQXNCO0lBQ3pCLEtBQUssQ0FBVTtJQUNmLE1BQU0sQ0FBYTtJQUNuQixjQUFjLEdBQWEsRUFBRSxDQUFDO0lBRWpDLEtBQUssQ0FBQyxJQUFJO1FBQ2YsTUFBTSxLQUFLLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDbkIsS0FBSyxDQUFDLG1DQUFtQyxFQUFFLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUN6RSxNQUFNLEVBQUUsSUFBSSxFQUFFLEtBQUssRUFBRSxHQUFHLE1BQU0sSUFBSSxDQUFDLEtBQUssQ0FBQztZQUN2QyxLQUFLLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLO1lBQ3RCLFNBQVMsRUFBRyxLQUFLLENBQUMsSUFBMkIsQ0FBQyxTQUFTO1lBQ3ZELGNBQWMsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWM7WUFDeEMsSUFBSSxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSTtZQUNwQixNQUFNLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNO1NBQ3pCLENBQUMsQ0FBQztRQUNILElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBaUIsQ0FBQztRQUMvQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQWUsQ0FBQztJQUM5QixDQUFDO0lBRVMsS0FBSyxDQUFDLFlBQVksQ0FBQyxPQUFlO1FBQzFDLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBQSxrQkFBUSxFQUFDLG1CQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxjQUFjLENBQUMsQ0FBQyxDQUFDO1FBQy9ELElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO1FBQ2YsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUMsR0FBRyxJQUFJLEVBQUUsQ0FBQztRQUM1QixJQUFJLENBQUMsS0FBSyxHQUFHLEdBQUcsQ0FBQyxJQUFJLEtBQUssUUFBUSxDQUFDO1FBQ25DLEtBQUssQ0FBQyxtREFBbUQsRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDL0YsQ0FBQztJQUVTLEtBQUssQ0FBQyxLQUFLLENBQUMsR0FBZ0M7UUFDcEQseURBQXlEO1FBQ3pELG1EQUFtRDtRQUNuRCxPQUFPLEtBQUssQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDMUIsQ0FBQztJQUVTLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBb0I7UUFDMUMsOEVBQThFO1FBQzlFLE9BQU8sS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMxQixDQUFDOztBQXRESCxrQ0F1REMifQ==

package/dist/commonjs/commands/start.d.ts

@@ -0,0 +1,34 @@
+import { BaseCommand } from '../baseCommand.js';
+export interface FrameworkOptions {
+    baseDir: string;
+    framework?: string;
+}
+export default class Start<T extends typeof Start> extends BaseCommand<T> {
+    #private;
+    static description: string;
+    static examples: string[];
+    static args: {
+        baseDir: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static flags: {
+        title: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        framework: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        port: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        workers: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        env: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        daemon: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        stdout: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        stderr: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        timeout: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'ignore-stderr': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        node: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        require: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        sourcemap: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    isReady: boolean;
+    protected getFrameworkPath(options: FrameworkOptions): Promise<string>;
+    protected getFrameworkName(frameworkPath: string): Promise<string>;
+    protected getServerBin(): Promise<string>;
+    run(): Promise<void>;
+    protected checkStatus(): Promise<void>;
+}