angular - 如何在 Angular/nx 工作空间的上下文中运行 nestjs-console 命令

Question

我有一个 NestJS 应用程序作为 Angular/Nx 工作区的一部分。

在 nest 应用程序中，我使用 nestjs-console 来运行命令(例如加载夹具数据)。

根据 nestjs-console docs这涉及:

1. 创建一个 console.ts 文件
2. 在 package.json 中添加一个脚本，如 "console:dev": "ts-node --project apps/api/tsconfig.console.json apps/api/src/console.ts"
3. 调用它，例如使用 npm run console:dev -- --help

现在我已经使用 Nx 创建了一个 lib of shared code应用程序之间。

这适用于 Angular CLI 下的命令(test；serve 等)，但是 nestjs-console 任务失败是可以理解的:

Error: Cannot find module '@my-workspace/my-lib'

所以问题是如何将 nestjs-console 命令置于 Angular CLI 的控制之下(或以其他方式运行 NestJS 命令)。

我觉得应该可以向 angular.json 添加自定义任务，它使用现有的构建器，然后以某种方式指向控制台命令。 (我觉得我不需要 custom builder ，但我可能错了)。

我卡住了，因为我对这个环境不是很熟悉，而且angular.json workspace config .

感谢任何帮助，无论是:

• 方法建议
• 我可以复制的例子
• 具体指点

编辑

我尝试使用 NestJS Application Context直接，(而不是通过 nestjs-console)并根据这个 blog post使用 ts-node 运行它。

这和以前有同样的问题。我相信这个问题与 ts-node 如何处理 tsconfg 中的路径有关。

如果我更改共享代码的导入方式:

import { HeadwordDto } from '@my-workspace/my-lib';

收件人:

import { HeadwordDto } from '../../../../../../libs/my-lib/src';

然后一切正常，但 tslint 提示“库导入必须以 @my-workspace/(nx-enforce-module-boundaries) 开头。”我可以看出这如何打败 Nx 的观点。

或者，处理我认为的 paths issue看起来有点毛茸茸，涉及像tspath这样的工具或 module-alias .它也没有受益于 Nx 优点。

我现在添加了一个新的 Architect target到 angular.json，它就像 build 目标(使用 @nrwl/node:build 构建器)，除了构建所需的应用程序上下文:

"build-console": {
  "builder": "@nrwl/node:build",
  "options": {
    "main": "apps/api/src/console.ts",      // build console application context
    "outputPath": "different/output/path",  // can run alongside app
    ...
  }
},

构建之后它可以是run via node :

node ./different/output/path/main.js –help

编辑 2

在上述方法的基础上，还可以使用 execute builder在单独的终端窗口中持续构建控制台应用程序上下文:

"serve-console": {
  "builder": "@nrwl/node:execute",
  "options": {
    "buildTarget": "api:build-console",
    "port": 7778,
    "args": ["--help"]
  }
},

从这里我猜下一步可能是将控制台应用程序上下文制作成一个单独的应用程序，在 angular.json 中有它自己的项目，然后只需要拉入所需的代码。开始觉得 Nx 团队领先我大约 58 步 ;-)

不确定这是否是最佳解决方案，但它确实有效。和以前一样，任何建议表示赞赏!

编辑 3

要对此进行扩展，以回应@Digitrance 的问题。我最终使用的方法是:

angular.json

{
    ...
    "api": {
      ...
      "architect": {
        ...
        "build-console": {
          "builder": "@nrwl/node:build",
          "options": {
            "outputPath": "dist/apps/api-console",
            "main": "apps/api/src/console.ts",
            "tsConfig": "apps/api/tsconfig.app.json"
          }
        },
        "serve-console": {
          "builder": "@nrwl/node:execute",
          "options": {
            "buildTarget": "api:build-console",
            "port": 7778,
            "args": ["--help"]
          }
        },

/my-repo/apps/api/src/console.ts

import { BootstrapConsole } from 'nestjs-console';
import { AppModule } from './app/app.module';

const bootstrap = new BootstrapConsole({
  module: AppModule,
  useDecorators: true
});
bootstrap.init().then(async app => {
  try {
    await app.init();
    await bootstrap.boot();
    process.exit(0);
  } catch (e) {
    console.error('Error', e);
    process.exit(1);
  }
});

然后命令运行控制台:

ng run api:build-console
ng run api:serve-console

node ./dist/apps/api-console/main.js --help
node ./dist/apps/api-console/main.js myCommand

(请注意，api 是我的应用程序的名称)。

希望这对您有所帮助!

Answer 1

和您一样，我在设置时遇到了麻烦。我的错误归结为语法错误，根据 ts-node github 上的一些问题，这与节点无法正确读取导入有关，因为它是 commonjs 语法。我的解决方案如下:

1. 在您的 nx 应用程序中的 tsconfig.app.json 旁边添加 tsconfig.console.json。
2. 确保 tsconfig.console.json 在 "compilerOptions" 中包含 "module": "commonjs"。除此之外，我复制了 tsconfig.app.json。
3. 在 package.json 中添加以下行:"console:dev": "ts-node --project apps/api/tsconfig.console.json -r tsconfig-paths/register apps/api/src/console.ts" 到你的脚本。

希望对您或其他人有所帮助。