I have integrated a NestJS application within an Angular / Nx workspace environment.
For running commands in the Nest application, I am utilizing nestjs-console (e.g., to load fixture data).
As per the instructions in the nestjs-console documentation, the process involves:
- Creation of a
console.tsfile - Inclusion of a script in package.json like:
"console:dev": "ts-node --project apps/api/tsconfig.console.json apps/api/src/console.ts" - Execution via command line, e.g., using:
npm run console:dev -- --help
My use of Nx has been beneficial for creating a shared code library across applications
While this setup works seamlessly with commands under Angular CLI (such as test or serve), it encounters issues with nestjs-console tasks leading to the error:
Error: Cannot find module '@my-workspace/my-lib'
Therefore, the key question remains on how to bring the nestjs-console command within the purview of Angular CLI (or implement NestJS commands through alternative means).
I believe it should be feasible to incorporate a custom task into angular.json that leverages an existing builder and thereby directs to the console command. While I don’t think a custom builder is necessary, I could be mistaken about this.
The challenge lies in my lack of familiarity with this setting and the workspace configuration in angular.json.
Assistance is welcomed, whether in the form of:
- Guidance on potential methodologies
- Sample instances to emulate
- Specific guidelines
UPDATE
I experimented with using the NestJS Application Context directly (as opposed to relying on nestjs-console) and followed the instructions outlined in this blog post by executing it with ts-node.
Nevertheless, I encountered similar challenges as before. The problem seems related to how ts-node manages paths in tsconfig.
By altering the way shared code is imported from:
import { HeadwordDto } from '@my-workspace/my-lib';
To:
import { HeadwordDto } from '../../../../../../libs/my-lib/src';
Everything functions properly, albeit triggering tslint complaints stating "library imports must start with @my-workspace/ (nx-enforce-module-boundaries)." This contradicts the essence of Nx.
Exploring the path-related issue appears complex and entails tools like tspath or module-alias. Moreover, these solutions do not leverage the advantages of Nx.
Subsequently, I augmented angular.json by introducing a new Architect target similar to the build target (utilizing the @nrwl/node:build builder) specifically tailored towards constructing the desired application context:
"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
...
}
},
Once the build is completed, it can be executed via node:
node ./different/output/path/main.js –help
UPDATES CONTINUED...
Expanding further on the previous approach, there's also the option to utilize the execute builder to continuously build the console application context in a separate terminal window:
"serve-console": {
"builder": "@nrwl/node:execute",
"options": {
"buildTarget": "api:build-console",
"port": 7778,
"args": ["--help"]
}
},
Following this progression, the next step could involve transforming the console application context into a distinct app, featuring its own project structure in angular.json, and selectively incorporating the essential code components. It almost appears as though the Nx team is lightyears ahead ;-)
While not certain if this is the optimal resolution, it does seem effective. As always, open to any suggestions!
FURTHER UPDATES
As a response to @Digitrance's query, I settled on the following course of action:
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);
}
});
This set up allows for running the console commands using:
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
(Note that api was used as the app name)
Hope this explanation proves helpful!