Nx and typia setup docs

[renesass]

Hey @samchon,

I love typia and desperately want to integrate it with Nx (express app).
I tried all I could find

• Nx monorepo + NodeJS + Typia #814
• Using nestia in nx/webpack nestia#319

However, no matter what I do, I always get errors:

• 'rootDir' is expected to contain all source files.
• throw new Error(Could not find ${fileToRun}. Make sure your build succeeded.);

Since some people got it running, I would love to see the specific steps on how to set it up.
Here is my current setup:

/apps/api/project.json

{
  "name": "api",
  "$schema": "../../node_modules/nx/schemas/project-schema.json",
  "sourceRoot": "apps/api/src",
  "projectType": "application",
  "targets": {
    "build": {
      "executor": "@nx/js:tsc",
      "outputs": ["{options.outputPath}"],
      "defaultConfiguration": "production",
      "options": {
        "target": "node",
        "compiler": "tsc",
        "outputPath": "dist/apps/api",
        "main": "apps/api/src/main.ts",
        "tsConfig": "apps/api/tsconfig.app.json",
        "assets": ["apps/api/src/assets"],
        "isolatedConfig": true,
        "webpackConfig": "apps/api/webpack.config.js"
      },
      "configurations": {
        "development": {},
        "production": {}
      }
    },
    "serve": {
      "executor": "@nx/js:node",
      "defaultConfiguration": "development",
      "options": {
        "buildTarget": "api:build"
      },
      "configurations": {
        "development": {
          "buildTarget": "api:build:development"
        },
        "production": {
          "buildTarget": "api:build:production"
        }
      }
    },

(I tried all kind of executors, specifically @nx/js:tsc and @nx/webpack:webpack)

apps/api/webpack.config.js

 const path = require('path')
const nodeExternals = require('webpack-node-externals')
const { composePlugins, withNx } = require('@nx/webpack')

module.exports = composePlugins(withNx(), (config) => {
  // Update the webpack config as needed here.
  // e.g. `config.plugins.push(new MyPlugin())`

  // CUSTOMIZE HERE
  config.entry = ['./src/main.ts']
  config.output = {
    path: path.join(__dirname, 'dist'),
    filename: 'main.js',
  }
  config.optimization = {
    minimize: false,
  }

  // JUST KEEP THEM
  config.mode = 'development'
  config.target = 'node'
  config.module = {
    rules: [
      {
        test: /\.ts$/,
        exclude: /node_modules/,
        loader: 'ts-loader',
      },
    ],
  }
  config.resolve = {
    extensions: ['.tsx', '.ts', '.js'],
  }

  return config
})

(basically merged nx default but also tried the provided webpack.config.js from the docs)

tsconfig.base.json

{
  "compileOnSave": false,
  "compilerOptions": {
    "rootDir": ".",
    "moduleResolution": "node",
    "strict": true,
    "strictNullChecks": true,
    "noUncheckedIndexedAccess": true,
    "forceConsistentCasingInFileNames": true,
    "stripInternal": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noFallthroughCasesInSwitch": true,
    "module": "commonjs",
    "target": "ES2022",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "typeRoots": ["node_modules/@types"],
    "skipLibCheck": true,
    "baseUrl": ".",
    "paths": {
      "@XXX/config": ["libs/config/src/main.ts"],
      "@XXX/services": ["libs/services/src/index.ts"]
    }
  },
  "ignorePatterns": [".eslintrc.cjs", "vite.config.ts"],
  "transformers": ["typia/lib/transform"]
}

I'm looking forward to any answer!
Best,
René

[renesass]

With this option

"targets": {
    "build": {
      "executor": "@nx/webpack:webpack",
      "outputs": ["{options.outputPath}"],
      "defaultConfiguration": "production",
      "options": {
        "target": "node",
        "compiler": "tsc",
        "outputPath": "dist/apps/api",
        "main": "apps/api/src/main.ts",
        "tsConfig": "apps/api/tsconfig.app.json",
        "assets": ["apps/api/src/assets"],
        "isolatedConfig": true,
        "webpackConfig": "apps/api/webpack.config.js"
      },
      "configurations": {
        "development": {},
        "production": {}
      }
    },
    "serve": {
      "executor": "@nx/js:node",
      "defaultConfiguration": "development",
      "options": {
        "buildTarget": "api:build"
      },
      "configurations": {
        "development": {
          "buildTarget": "api:build:development"
        },
        "production": {
          "buildTarget": "api:build:production"
        }
      }
    }

I can at least build it but I can not serve the app:

• throw new Error(`Could not find ${fileToRun}. Make sure your build succeeded.
• Error: write EPIPE
• node_modules/fork-ts-checker-webpack-plugin/lib/rpc/expose-rpc.js:5:58)

[samchon]

As I'm not using NX at all, have no insight about it.

If there's some NX user, then please help him.

[loucass003]

@renesass Did you ever got this to work?

[renesass]

Unfortunately not :( I tried for too long and then give up switching to typebox. Maybe you have better luck?

[loucass003]

Unfortunately not :( I tried for too long and then give up switching to typebox. Maybe you have better luck?

no I had to give up on NX too. I ended up using turborepo and it required no changes in the build setup, maybe you would be interested into that?

[samchon]

This way is not working? @loucass003 @renesass

https://nestia.io/docs/setup/#nx

[loucass003]

@samchon Sadly no, according to samchon/nestia#319 (comment)
it looks like the transformers are not compatible with Nx anymore

I tried myself for few hours and never got it to work 😭

[kakasoo]

I also tried to write a test code for type using packages managed by my company, but it failed. It seems to be an nx problem.
Unfortunately, I also have no understanding of nx.

[honguyenhaituan]

I make the newest version nx (18.2.4) run with nestia in this example repo. See commit: honguyenhaituan/nx-typia@c1df98c

[kakasoo]

I'm going to install it with this version and try it again. However, if the problem is reproduced every time the nx version is updated, I can consider removing it in the future.
I will share the results later.

[KyleBastien]

Okay here's what I found which works with Nx v20 and Typia v6.

1. In package.json you need to have a prepare script which is something like: ts-patch install && typia patch. This ensures that TypeScript is patched with ts-patch when Nx uses it later.
2. Update your tsconfig.lib.json file in your @nx/js package to include the compilerOption so it looks something like the following:

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "../../dist/out-tsc",
    "declaration": true,
    "types": [],
    "plugins": [{ "transform": "typia/lib/transform" }]
  },
  "include": ["**/*.ts"],
  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"]
}

3. When you run the standard nx <package-name>:build it should now output with the Typia transforms applied. But if Typia fails for any reasons (for example it considers some type you have to be invalid), this error is not reported back via Nx. Nx will silent swallow these errors from ts-patch/typia, and you will just not get the output you expect. I figured this out by creating a new task in my project.json file similar to:

"build:validate:typia": {
  "executor": "nx:run-commands",
  "options": {
    "commands": [
      "tsc --project packages/<package-name>/tsconfig.lib.json --outDir dist/packages/typiaTest"
    ],
    "parallel": false
  }
},

Running this task, showed me the errors from Typia, and once I corrected them, everything worked using the standard build task the way I expected.

Note: While Nx has a transformers feature on the @nx/js plugin, that won't work with Typia. The reason there is because Nx is expecting a transformer to export a before hook, which Nx then plugs directly into TypeScript via the compiler API. Typia doesn't export that kind of hook, because Typia (per my understanding) only works with ts-patch, which abstracts the need for creating a specific before hook in the way Nx wants.

I hope this helps someone!

[samchon]

@KyleBastien Can you send a PR of documentation in typia and nestia?

If you're busy, I'll to it by myself after two weeks later.

[KyleBastien]

@samchon Made the two PR's here:

#1373
samchon/nestia#1110