Nx 18: Is there a way to disable a target for a specific app? #22183
Replies: 5 comments 12 replies
-
|
I have just found out that I can override a target in an actual package (under |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
What do you mean by wrapping approach? 🤔 I know of no solution or workaround of this issue, apart from the one described in the OP (renaming the workspace-level |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, I didn't use the same terminology. I meant the Custom plugin, the one you implemented:
Is this working for you? |
Beta Was this translation helpful? Give feedback.
-
|
Oh, no, it didn’t work, I only fixed the typings (a bit). The error is all the same whenever I use a custom plugin from your article. Note that I haven’t tested it with a package-level |
Beta Was this translation helpful? Give feedback.
-
|
I have just tested this in a non-vanilla Nx workspace to override the Next to test this in a vanilla Nx repo … |
Beta Was this translation helpful? Give feedback.
-
|
Disabling Note that I have tested it on Linux in Bash and that I used #!/usr/bin/env bash
# Note: Tested with `[email protected]`
# Variables
repo_parent_folder='/home/ts/git/test' # optional; by default, CWD is used
app_name='disable-nx-target'
workspace_name='test-workspace'
# Define `$repo_parent_folder` if not defined
repo_parent_folder="$(realpath "${repo_parent_folder:-$PWD}")"
# Create an Nx monorepo workspace
cd "$repo_parent_folder" && pnpx create-nx-workspace@latest \
--appName "$app_name" \
--defaultBase main \
--docker true \
--e2eTestRuner playwright \
--framework nestjs \
--name "$workspace_name" \
--nxCloud skip \
--nx_docker false \
--pm pnpm \
--preset nest \
--workspaceType integrated
cd "$repo_parent_folder/$workspace_name" && \
pnpm i && \
pnpm -D i @nx/devkit
mkdir -p "$repo_parent_folder/$workspace_name/tools/nx-plugins"
# Configure the override
cat << EOF > "$repo_parent_folder/$workspace_name/tools/nx-plugins/skip-jest-plugin.ts"
import {readdirSync} from 'node:fs'
import {dirname, join} from 'node:path'
import {
CreateNodes,
CreateNodesContext,
CreateNodesResult,
joinPathFragments,
ProjectConfiguration,
readJsonFile
} from '@nx/devkit'
import {
createNodes as createJestNodes,
JestPluginOptions
} from '@nx/jest/plugin'
type NoopSkipProjects = {
/**
* List of projects for which a particular target should be disabled
*/
skipProjects?: string[]
}
export const createNodes: CreateNodes<
JestPluginOptions & {skipProjects: string[]}
> = [
createJestNodes[0],
async (
configFilePath: string,
options: (JestPluginOptions & NoopSkipProjects) | undefined,
context: CreateNodesContext
): Promise<CreateNodesResult> => {
const projectRoot: string = dirname(configFilePath)
const siblingFiles = readdirSync(join(context.workspaceRoot, projectRoot))
if (!siblingFiles.includes('project.json')) {
return {}
}
const path = joinPathFragments(projectRoot, 'project.json')
const projectJson = readJsonFile<ProjectConfiguration>(path)
if (options.skipProjects.includes(projectJson.name)) {
return {}
}
return createJestNodes[1](configFilePath, options, context)
}
]
EOF
# Disable the `test` target for the app
skipProjectsPlugin="[{
\"plugin\": \"./tools/nx-plugins/skip-jest-plugin.ts\",
\"options\": {
\"targetName\": \"test\",
\"skipProjects\": [\"$app_name\"]
}
}]"
cat <<< "$(jq --argjson skipProjectsPlugin "$skipProjectsPlugin" '.plugins += $skipProjectsPlugin' "$repo_parent_folder/$workspace_name/nx.json")" > "$repo_parent_folder/$workspace_name/nx.json" |
Beta Was this translation helpful? Give feedback.
-
|
In #22099 (the discussion description), the following is wrong:
Adding |
Beta Was this translation helpful? Give feedback.
-
|
@FrozenPandaz, sorry to ping you, however, no one from Nx contributors reacted on this discussion (you all are busy, presumably). Basically, in Nx 18 (with Crystal), I’d like to be able to disable a target for specific app (e.g. Thanks in advance! 🙏 Note that I have re-tested this and the target inferring still works like this in Nx 18.3.2. |
Beta Was this translation helpful? Give feedback.
-
|
This still does not work in /cc @FrozenPandaz, @vsavkin, @jaysoo, @meeroslav, sorry to ping you, however, I wish some of you responded. Maybe it is already possible to exclude a default target in the workspace-level |
Beta Was this translation helpful? Give feedback.
-
|
Hey @tukusejssirs, did you check the new properties |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, @jogelin, for trying to help me! 🙏 I have just tried to add the following to {
// ...
"plugins": [
// ...
{
"exclude": [
// Neither of these exclude the `test` target from the workspace-level `project.json`.
".",
"${workspace_name}",
// This does not exclude the `test` target from `$some_app` either.
"apps/${some_app}/**/*"
],
"options": {
"targetName": "test"
},
"plugin": "@nx/jest/plugin"
}
]
}I still get the I also tried the {
// ...
"plugins": [
// ...
{
"include": [
// Neither of these include the `test` target for the PHP apps.
// I have also tried to exclude them in the `@nx/jest/plugin` plugin definition above.
"apps/*-php/**/*",
"apps/${some_app}-php/**/*"
],
"options": {
"targetName": "test"
},
"plugin": "@nx-php/phpunit:phpunit"
}
] |
Beta Was this translation helpful? Give feedback.
-
|
Even if I exclude |
Beta Was this translation helpful? Give feedback.
-
|
In my case I had a dangling Unwanted libs would show up when running I still left |
Beta Was this translation helpful? Give feedback.
-
Related: #22099
I want to disable an automatically interred target (like
test) for a project.More specifically, my use case is
@jscutlery/semver. This plugin uses a workspace-levelproject.jsonfile (I use synced versioning, i.e. one version for all packages). It works as expected, however due to having aproject.jsonin the workspace root folder, Nx considers that folder a package root folder and thus shows it innx show projects.It also infers the following
testtarget:Note that I already create some custom targets using
@jscutler/semverwhich are not shown innx show project $workspace($workspacebeing the value ofname in the workspace-levelproject.json`).I tried to overried the
testtarget using the following one, however, it is ignored andnx show project $workspacestill returns the target above.Ideally, I don’t want to infer any task to the workspace-level
project.json(i.e. it should be used by Nx to run the explicitly specified targets only).A consequence of this is that now I cannot use
nx generatecommand, as it throws an error:The only way to work around the issue is to (temporarily) rename the workspace-level
project.json, for example:mv package.json{,.bak};nx reset;nx generate;mv package.json{.bak,}).I suggest to add a concreate example how to override a target/task in the docs. You actually link to that page from Overriding Inferred Task Configuration, however, nothing works for me in this case.
Beta Was this translation helpful? Give feedback.
All reactions