Repo: address issues introduced by updated `nx` configuration #11229

aryaemami59 · 2025-05-20T08:44:33Z

Suggestion

Overview

There are several issues related to inferred plugin options, unexpected overrides, and missing configuration context in the current setup. This issue summarizes and clarifies those points while referencing this video made by @JamesHenry.

1. Plugin Option Overriding

Some inferred plugins provide default options that unintentionally override explicitly set options from other plugins.

For example, @nx/vite/plugin has a default typecheckTargetName of "typecheck", which overrides the targetName we explicitly set for @nx/js/typescript.

Initially, this was mitigated by explicitly overriding the value:

{
  "plugin": "@nx/vite/plugin",
  "include": ["packages/*"],
  "options": {
    "typecheckTargetName": "vite:typecheck"
  }
}

However, the current config no longer specifies that override:

{
  "plugin": "@nx/js/typescript",
  "options": {
    "typecheck": {
      "targetName": "typecheck"
    }
  }
},
{
  "plugin": "@nx/vite/plugin",
  "options": {
    // Implicit: "typecheckTargetName": "typecheck"
  }
}

This results in the @nx/vite/plugin inferring a typecheck target by detecting vitest.config.mts, which overrides the one from @nx/js/typescript.

You can clearly see this misalignment in the output from nx graph:

Current (Incorrect):

Expected (Correct):

This is a serious issue since running tsc -p tsconfig.json --noEmit ends up type-checking nothing, because our tsconfig.json uses empty files and include arrays, relying instead on project references. You can confirm this by introducing a type error and rerunning typecheck.

2. `@nx/eslint:lint` – Config Path Was Correct

In the video (14:13), it's mentioned that the value of options.eslintConfig (set to {workspaceRoot}/eslint.config.mjs) is incorrect. However, this was in fact correct. We only have a single eslint.config.mjs file, and it's at the root of the workspace.

3. Type Tests and Why `utils:test` Depends on `build` and `typecheck`

At 19:45, the video questions why utils:test depends on ^build. This dependency, along with typecheck, was actually intentional and necessary for running type-tests using vitest. These tests require the workspace's dependencies to be built beforehand, hence the original configuration:

"test": {
  "dependsOn": ["^build", "typecheck"]
}

Currently, only a few packages (e.g., ast-spec, utils) include type tests. In those workspaces:

typecheck.enabled was previously set to true in vitest.config.mts.
The typecheck.tsconfig was previously set to the local tsconfig.spec.json.

While vitest's type-checker is essentially a wrapper around tsc, there are some differences, which is why the scope of files to check was narrowed in the root vitest.config.base.mts file.

4. Missing `--config=vitest.config.mts` Flag

In the PR that simplified the configuration, the --config=vitest.config.mts flag was not carried over into the updated nx.json. While not strictly required, re-adding it would avoid vitest's config file lookup and offer a slight performance improvement.

Additional Info

I will submit a PR for this shortly.

The text was updated successfully, but these errors were encountered:

JamesHenry · 2025-05-20T12:06:23Z

This was me being dumb thinking that missing the config off would not create the target, rather than fallback to the default name.

I am discussing with the team about supporting a way to explicitly disabled an inferred target, because obviously this vite:typecheck target isn't referenced anywhere and so having it is misleading.

You're right that I should have verified the presence of eslint configs in the projects, this is an uncommon setup and is fundamentally incompatible with the inference plugin because it is inferred based on the presence of the config file. We should add project level configs.

The mixing of executor and inference plugin points I made still stand, the setup did not make sense before.

JamesHenry · 2025-05-20T12:08:04Z

I'm still not clear on, the tsconfig.spec.json is included in the solution tsconfig.json and is therefore covered by the typecheck target from the typescript plugin?

JamesHenry · 2025-05-20T12:09:21Z

I am very skpetical about a negligible performance improvement there 😅

aryaemami59 · 2025-05-20T12:56:28Z

This was me being dumb thinking that missing the config off would not create the target, rather than fallback to the default name.

I am discussing with the team about supporting a way to explicitly disabled an inferred target, because obviously this vite:typecheck target isn't referenced anywhere and so having it is misleading.

I think I got it, seems like all We have to do is: "typecheckTargetName": false.

You're right that I should have verified the presence of eslint configs in the projects, this is an uncommon setup and is fundamentally incompatible with the inference plugin because it is inferred based on the presence of the config file. We should add project level configs.

Yeah, I'll add project level configs.

The mixing of executor and inference plugin points I made still stand, the setup did not make sense before.

I agree, I won't be adding anymore executors, We'll stick with one or the other.

JamesHenry · 2025-05-20T14:47:19Z

I think I got it, seems like all We have to do is: "typecheckTargetName": false.

@aryaemami59 No, sadly that simply sets up a target called "false" and makes it do the typechecking, so it's confusing either way, so probably reverting it to the vite:typecheck is best for now, thanks!

I'll keep chatting with the team about addressing this

JamesHenry · 2025-05-20T14:48:59Z

If the @typescript-eslint/triage-team really prefers not having the project level configs which simply inherit from the root one, we could remove the eslint inference plugin and simply have lint scripts inline on the projects, but yeah I think having the project level configs is clearer about the intent to run linting on a project level personally

kirkwaiblinger · 2025-05-28T16:29:05Z

My only question with the project-level configs is - won't the root eslint config still apply to the projects/workspaces when executing eslint? Or does nx infer a lint task for the root that excludes subprojects that have an eslint config?

aryaemami59 · 2025-05-28T16:33:17Z

@kirkwaiblinger

My only question with the project-level configs is - won't the root eslint config still apply to the projects/workspaces when executing eslint? Or does nx infer a lint task for the root that excludes subprojects that have an eslint config?

The project level lint script will be some thing like:

eslint --config=${PROJECT_CWD}/eslint.config.mjs ${INIT_CWD}

kirkwaiblinger · 2025-05-28T16:48:56Z

My concern is that executing that verbatim will lint the packages/**/* as well unless we exclude them, which duplicates work with the package-level tasks. We used to have an ignore pattern for that, see

typescript-eslint/project.json

Line 20 in 1c0e1ae

"lintFilePatterns": ["{workspaceRoot}/!packages"]

(changed in https://github.com/typescript-eslint/typescript-eslint/pull/11226/files#diff-7680eb66f8e7b2155dfc25c4aa16a606a8fd3decb988265f218f3e11a8afa2beL20)

and before that,

typescript-eslint/project.json

Line 12 in b2be3dc

"command": "eslint . --ignore-pattern=packages --cache"

(changed in https://github.com/typescript-eslint/typescript-eslint/pull/11135/files#diff-7680eb66f8e7b2155dfc25c4aa16a606a8fd3decb988265f218f3e11a8afa2beL12-L13)

aryaemami59 · 2025-05-28T17:34:50Z

@kirkwaiblinger

My concern is that executing that verbatim will lint the packages/**/* as well unless we exclude them, which duplicates work with the package-level tasks. We used to have an ignore pattern for that, see

typescript-eslint/project.json

Line 20 in 1c0e1ae

"lintFilePatterns": ["{workspaceRoot}/!packages"]
(changed in https://github.com/typescript-eslint/typescript-eslint/pull/11226/files#diff-7680eb66f8e7b2155dfc25c4aa16a606a8fd3decb988265f218f3e11a8afa2beL20)

and before that,

typescript-eslint/project.json

Line 12 in b2be3dc

"command": "eslint . --ignore-pattern=packages --cache"
(changed in https://github.com/typescript-eslint/typescript-eslint/pull/11135/files#diff-7680eb66f8e7b2155dfc25c4aa16a606a8fd3decb988265f218f3e11a8afa2beL12-L13)

Here is what they would look like:

In our nx.json We have these defaults.

Our root lint task

Our root lint script

Our project-level lint task

Our project-level lint script

aryaemami59 added triage Waiting for team members to take a look repo maintenance things to do with maintenance of the repo, and not with code/docs labels May 20, 2025

aryaemami59 linked a pull request May 21, 2025 that will close this issue

chore: fix issues introduced by updated nx configuration #11230

Draft

3 tasks

kirkwaiblinger added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels May 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Repo: address issues introduced by updated `nx` configuration #11229

Repo: address issues introduced by updated `nx` configuration #11229

aryaemami59 commented May 20, 2025

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

aryaemami59 commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

kirkwaiblinger commented May 28, 2025

Uh oh!

aryaemami59 commented May 28, 2025

Uh oh!

kirkwaiblinger commented May 28, 2025

Uh oh!

aryaemami59 commented May 28, 2025

Uh oh!

Uh oh!

Repo: address issues introduced by updated nx configuration #11229

Repo: address issues introduced by updated nx configuration #11229

Comments

aryaemami59 commented May 20, 2025

Suggestion

Overview

1. Plugin Option Overriding

Current (Incorrect):

Expected (Correct):

2. @nx/eslint:lint – Config Path Was Correct

3. Type Tests and Why utils:test Depends on build and typecheck

4. Missing --config=vitest.config.mts Flag

Additional Info

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

aryaemami59 commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

JamesHenry commented May 20, 2025

Uh oh!

kirkwaiblinger commented May 28, 2025

Uh oh!

aryaemami59 commented May 28, 2025

Uh oh!

kirkwaiblinger commented May 28, 2025

Uh oh!

aryaemami59 commented May 28, 2025

Uh oh!

Repo: address issues introduced by updated `nx` configuration #11229

Repo: address issues introduced by updated `nx` configuration #11229

2. `@nx/eslint:lint` – Config Path Was Correct

3. Type Tests and Why `utils:test` Depends on `build` and `typecheck`

4. Missing `--config=vitest.config.mts` Flag