tsrpc-cli

export declare type ApiTemplate = (apiBaseName: string, apiFileDir: string, ptlFileDir: string) => string;

 * 用于 `tsrpc.config.ts` 的代码模板

    static getExtendedPtl(baseFile?: string, baseReq?: string, baseRes?: string, baseConf?: string): PtlTemplate;

    static getExtendedMsg(baseFile?: string, baseMsg?: string, baseConf?: string): MsgTemplate;

export declare type MsgTemplate = (msgBaseName: string, msgPath: string, ptlDir: string) => string;

export declare type PtlTemplate = (ptlBaseName: string, ptlPath: string, ptlDir: string) => string;

export declare type TsrpcCliConfig = TsrpcConfig;

     * `tsrpc proto` 命令的创建的 ServiceProto

     * 一条记录对应一份 ServiceProto

         * 生成协议时忽略的文件（Glob表达式）

         * 输出的 ServiceProto文件名，例如 `src/shared/protocols/serviceProto.ts`

         * 扩展名可为 `.ts` 或 `.json`

         * 该 ServiceProto 对应的 API 目录，则可通过 `npx tsrpc api` 自动生成对应的 API 文件。

         * API 接口文档生成到哪个目录，为空则不生成

         * 生成 ServiceProto 时，要兼容的上一版 ServiceProto 的路径。

         * @defaultValue 同 `output`，即原地兼容旧版同名文件。

         * false 代表关闭兼容模式，总是生成全新的 ServiceProto

         * `npm run dev` 期间，当这些目录下内容变化时，自动更新 ServiceProto

        /** conf.dev.autoFillNewPtl 为 true 时自动填充的新 Ptl 的模板 */

             * @defaultValue BaseResponse

        /** conf.dev.autoFillNewPtl 为 true 时自动填充的新 Msg 的模板 */

        /** conf.dev.autoApi 为 true 时自动填充的新 Api 的模板 */

        /** @deprecated use `ptlTemplate` instead */

        /** @deprecated use `msgTemplate` instead */

        /** @deprecated use `apiTemplate` instead */

         * 自定义全局 Module 路径的解析方式

         * @experiment 注意：这是实验性特性，可能会在未来版本中被移除

         * @param importPath 例如 import xx from 'abcd/efg' 则 importPath 为 'abcd/efg'

         *     v = v.replace(/^@runtime\//, './common/runtime/);

         * @returns 返回 module 文件的绝对路径（不含扩展名）

        resolveModule?: (importPath: string) => string;

     * `tsrpc sync` 命令的相关配置

        /** 共享代码目录的源，例如 `src/shared` */

 * TSRPC Command-line Interface v2.4.5-dev.1

 * TSRPC Command-line Interface v2.4.5-dev.2

 * -----------------------------------------

Object.defineProperty(exports, '__esModule', { value: true });

function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }

var path__default = /*#__PURE__*/_interopDefaultLegacy(path);

    static getExtendedPtl(baseFile = 'src/shared/protocols/base.ts', baseReq = 'BaseRequest', baseRes = 'BaseResponse', baseConf = 'BaseConf') {

        return (ptlBaseName, ptlPath, ptlDir) => {

            const importPath = path__default["default"].relative(path__default["default"].dirname(ptlPath), path__default["default"].resolve(baseFile.replace(/\.ts$/, ''))).replace(/\\/g, '/');

            return `import { ${baseReq}, ${baseRes}, ${baseConf} } from "${importPath.startsWith('.') ? importPath : `./${importPath}`}";

export interface Req${ptlBaseName} extends ${baseReq} {

export interface Res${ptlBaseName} extends ${baseRes} {

    static getExtendedMsg(baseFile = 'src/shared/protocols/base.ts', baseMsg = 'BaseMessage', baseConf = 'BaseConf') {

        return (msgBaseName, msgPath, msgDir) => `import { ${baseMsg}, ${baseConf} } from "./${path__default["default"].relative(path__default["default"].dirname(msgPath), path__default["default"].resolve(baseFile.replace(/\.ts$/, ''))).replace(/\\/g, '/')}";

export interface Msg${msgBaseName} extends ${baseMsg} {

CodeTemplate.defaultPtl = ptlBaseName => `export interface Req${ptlBaseName} {

CodeTemplate.defaultMsg = msgBaseName => `export interface Msg${msgBaseName} {

CodeTemplate.defaultApi = (apiBaseName, apiFileDir, ptlFileDir) => `import { ApiCall } from "tsrpc";

import { Req${apiBaseName}, Res${apiBaseName} } from "${path__default["default"].relative(apiFileDir, ptlFileDir).replace(/\\/g, '/')}/Ptl${apiBaseName}";

export default async function (call: ApiCall<Req${apiBaseName}, Res${apiBaseName}>) {

    "build": "npm run build:js && npm run build:dts",

    "build:js": "rm -rf dist && npx rollup -c && cp -rf res LICENSE README.md README_CN.md package.json dist/",

    "build:dts": "rm -rf lib && npx tsc && npx api-extractor run --local --verbose && rm -rf lib",

    "try": "node -r ts-node/register src/index.ts proto -i try/proto -o try/proto/proto.ts -n",

    "try:npx": "npx tsrpc proto -i try/proto -o try/proto/proto.ts -n",

    "test:doc": "cd test/demo_project/backend && npm run doc",

    "up:dev": "ncu -u -t minor && npm i && npm run bp:dev",

    "bp:dev": "npm run build && cd dist && npm publish --tag dev"

    "url": "git+https://github.com/k8w/tsrpc-cli.git"

    "url": "https://github.com/k8w/tsrpc-cli/issues"

  "homepage": "https://github.com/k8w/tsrpc-cli#readme",

    "@microsoft/api-documenter": "^7.17.17",

    "@microsoft/api-extractor": "^7.25.0",

    "@microsoft/api-documenter": "^7.18.0",

    "@microsoft/api-extractor": "^7.28.2",

    "rollup-plugin-typescript2": "^0.32.1"

    "tsbuffer-proto-generator": "^1.7.2",

		@@ -34,2 +34,4 @@ export declare type ApiTemplate = (apiBaseName: string, apiFileDir: string, ptlFileDir: string) => string;

		export declare type TsrpcCliConfig = TsrpcConfig;

		export declare interface TsrpcConfig {
		@@ -36,0 +38,0 @@ /**

		{
		"name": "tsrpc-cli",
		"version": "2.4.5-dev.1",
		"version": "2.4.5-dev.2",
		"description": "TSRPC CLI Tools",
		@@ -40,4 +40,4 @@ "main": "index.js",
		"devDependencies": {
		"@microsoft/api-documenter": "^7.17.17",
		"@microsoft/api-extractor": "^7.25.0",
		"@microsoft/api-documenter": "^7.18.0",
		"@microsoft/api-extractor": "^7.28.2",
		"@rollup/plugin-replace": "^2.4.2",
		@@ -53,3 +53,3 @@ "@types/fs-extra": "^9.0.13",
		"openapi-types": "^9.3.1",
		"rollup": "^2.75.6",
		"rollup": "^2.75.7",
		"rollup-plugin-terser": "^7.0.2",
		@@ -68,3 +68,3 @@ "rollup-plugin-typescript2": "^0.32.1"
		"os-locale": "^5.0.0",
		"ts-node": "^10.8.1",
		"ts-node": "^10.8.2",
		"tsbuffer": "^2.2.3",
		@@ -74,5 +74,5 @@ "tsbuffer-proto-generator": "^1.7.2",
		"tsrpc-proto": "^1.4.2",
		"typescript": "^4.7.3",
		"typescript": "^4.7.4",
		"typescript-formatter": "^7.2.2"
		}
		}

Improved metrics

Dependency changes