48 Commits

Author SHA1 Message Date
Jack Hsu
2f8eb24504
docs(core): add docs for tui options in nx.json (#31459)
This PR adds the missing `tui` property in `nx.json` on this page:
https://nx.dev/reference/nx-json

<img width="884" alt="Screenshot 2025-06-04 at 1 10 04 PM"
src="https://github.com/user-attachments/assets/d7edb8dd-7b1a-4e3e-a738-4eb0dbb1feba"
/>

Preview:
https://nx-dev-git-docs-add-tui-option-nrwl.vercel.app/reference/nx-json
2025-06-05 08:29:57 -04:00
James Henry
ee097a8e10
feat(release)!: useLegacyVersioning is false by default, migrate config (#30838)
This PR updates `nx release` to use the revamped versioning
implementation by default. It also updates and adds relevant
documentation, and provides an automated migration for the new
configuration structure.

For anyone exclusively versioning TS/JS packages, there should be no
real difference to your experience (although a number of bugs have been
fixed and new features around updating multiple `package.json` files at
once are now available to you with this change).

For the lifecycle of Nx v21, `release.version.useLegacyVersioning` will
remain as a option that can be set to `true` to revert to the old
behavior and configuration structure.

NOTE: This should only be a temporary solution, for example if one of
the plugins you use does provide a `VersionActions` based versioning
implementation yet. The option and legacy implementation will be removed
entirely in Nx v22 (in ~6 months).

BREAKING CHANGE:

**⚠️ For any early adopters of `VersionActions` in Nx 20.8 when it was
opt-in, there are breaking changes to the abstract class here as well.**

`manifestRootsToUpdate` has gone from `string[]` to `manifestsToUpdate:
{ manifestPath: string; preserveLocalDependencyProtocols: boolean; }[]`
to support controlling the local dependency updates per manifest in
order to support advanced source vs dist scenarios, and correspondingly
`isLocalDependencyProtocol` has been removed from the abstract class and
the method will no longer be called from the core logic. It should be
thought of as an implementation detail of `updateProjectDependencies`
instead.
2025-04-24 22:09:38 -04:00
Leosvel Pérez Espinosa
fed4da8651
feat(misc): remove generation of target defaults for atomized e2e tasks (#30730)
## Current Behavior

A target default (`dependsOn: [^build]`) for atomized e2e tasks is
always generated to work around a previous limitation where tasks
couldn't depend on continuous tasks. That meant we couldn't add the
dependency to the app's serve task and had to add it to the build task.

With continuous tasks now working, that limitation no longer exists.
We're now able to correctly infer the task dependency on the app's serve
task, and therefore, we can and need to remove the generation of
`dependsOn: [^build]` in target defaults so it doesn't override what the
Cypress and Playwright plugins infers.

## Expected Behavior

A target default (`dependsOn: [^build]`) for atomized e2e tasks should
not be generated. Instead, the Cypress and Playwright plugins will infer
the correct `dependsOn` for the task(s) run in the configured web server
command.

## Related Issue(s)

Fixes #
2025-04-17 13:27:24 +02:00
Craigory Coppola
e329acaf77
docs(core): fix invalid markup in max cache size docs (#30628)
Small typo in docs
2025-04-08 09:14:46 -04:00
Craigory Coppola
f5d3ba5dcd
docs(core): add some docs for maxCacheSize (#30569)
## Current Behavior
`maxCacheSize` is not documented

## Expected Behavior
`maxCacheSize` is documented

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2025-04-01 16:35:44 -04:00
Juri
437bad4aac docs(misc): add description frontmatter for better SEO 2025-03-04 16:58:14 +01:00
Caleb Ukle
6a46030995
docs(core): update e2e-ci glob example (#29150)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->
the glob pattern in the e2e-ci example is incorrect for nested
directories example mentioned.
## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
when using nested directories the **/** pattern is needed, so the
example was incorrect
it's also confusing why something wouldn't work, so added more info as
to the different common glob patterns (`**/*`, `**/**`) to be more clear

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

---------

Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2024-12-02 14:56:12 -05:00
Isaac Mann
4517d9f721
docs(core): nx sync (#27825)
- Adds nx sync to command reference
- Updates nx.json reference
- Update project configuration reference
- Adds a sync generators concept page
- Adds a Register a Sync Generator recipe under Extending Nx Recipes

---------

Co-authored-by: James Henry <james@henry.sc>
2024-09-12 07:30:46 -04:00
Isaac Mann
332a20fd08
docs(core): updates for login/logout (#27838)
Replaces references to `nxCloudAccessToken` with `nxCloudId`
Adds login/logout to the commands landing page
2024-09-09 16:14:57 -04:00
Craigory Coppola
a07aa5e966
docs(core): add blurb about pattern matched target defaults (#27242)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
Pattern matched target defaults are not documented

## Expected Behavior
There is some documentation explaining target defaults w/ glob patterns

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-08-02 09:52:53 -04:00
James Henry
ee2c41b75d
feat(release): allow {releaseGroupName} to be interpolated in releaseTagPattern (#27190) 2024-07-30 01:55:06 +04:00
James Henry
9e6c7fa6e3
Revert "feat(release): allow {releaseGroupName} to be interpolated in releaseTagPattern" (#27189)
Reverts nrwl/nx#27188
2024-07-29 20:31:43 +04:00
James Henry
0b9672b4e6
feat(release): allow {releaseGroupName} to be interpolated in tag pattern (#27188) 2024-07-29 20:31:17 +04:00
Isaac Mann
5b44085c81
docs(core): remove tasksRunnerOptions (#26615)
Remove the tasksRunnerOptions section in the nx.json docs
2024-06-21 07:40:05 -04:00
Isaac Mann
d48fb54d56
docs(core): restrict plugin inferred tasks (#22986) 2024-04-25 12:52:34 -04:00
Leosvel Pérez Espinosa
9d8335110c
docs(misc): add recipe on how to pass args to commands (#22284)
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2024-04-09 15:06:53 +02:00
Leosvel Pérez Espinosa
0f4d005ef5
docs(misc): improve docs around target defaults (#22456) 2024-03-27 02:46:44 -07:00
Isaac Mann
f98b18d4a2
docs(core): various references to Nx Cloud (#22237) 2024-03-08 09:41:18 -05:00
Isaac Mann
e732e7116f
docs(core): default cache directory update (#22023) 2024-02-27 11:40:33 -05:00
Craigory Coppola
95b77f8fb0
feat(core): flatten default base config to base (#19964) 2024-02-22 16:50:25 -05:00
Isaac Mann
61436a64ef
docs(core): inferred targets (#21167)
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: Colum Ferry <cferry09@gmail.com>
Co-authored-by: Emily Xiong <xiongemi@gmail.com>
Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
Co-authored-by: Victor Savkin <mail@vsavkin.com>
Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2024-02-03 00:14:05 -05:00
James Henry
d819e6cee8
fix(release): capture all release titles during parse (#20864) 2023-12-21 23:22:23 +00:00
Austin Fahsl
82fb2da5d2
fix(release): add overall nx release command (#20535)
Co-authored-by: James Henry <james@henry.sc>
Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
2023-12-20 08:42:20 -05:00
Craigory Coppola
74b095ff64
docs(core): update documentation for nx plugin options (#19808) 2023-10-23 17:15:14 -04:00
Isaac Mann
cc8d8e8f4c
docs(core): deprecate workspaceLayout (#19767) 2023-10-23 11:55:34 -04:00
Juri
68064b53b0 docs(core): improve core features and concepts 2023-10-19 23:17:27 +02:00
Craigory Coppola
f98ab3f820
docs(core): update docs for new tasks runner opts (#19647)
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2023-10-18 18:33:09 -04:00
Jason Jean
d0005c954f
feat(core): remove deprecated defaultCollection and npmScope nx.json … (#19708) 2023-10-18 18:03:57 -04:00
Benny Neugebauer
190bc8b707
docs(core): replace Github with GitHub (#19397) 2023-10-02 14:44:31 -04:00
Isaac Mann
d1fe398ea0
docs(core): packages to api (#19281) 2023-09-22 14:24:35 -04:00
Isaac Mann
c2c664a055
docs(core): add directory flag to all project generators (#18977) 2023-09-07 09:36:25 -04:00
Philip Fulcher
768a0d2b7c
docs(core): remove references to --all for run-many (#18663) 2023-08-18 16:01:32 -04:00
Isaac Mann
77bc1e8778
feat(nx-dev): highlight lines in code samples (#18690) 2023-08-18 10:59:18 -04:00
Miroslav Jonaš
331707d6eb
docs(nx-dev): make more concepts submenu (#18266) 2023-07-24 14:20:48 +00:00
Isaac Mann
afd3cfd8c0
docs(core): deprecate npmScope (#17321) 2023-06-02 17:07:43 -04:00
Isaac Mann
afa5eb59fa
docs(core): document the @nrwl => @nx rescope (#16403)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-04-27 18:14:59 -04:00
Victor Savkin
1fb9edc460 feat(core): support both @nrwl/nx-cloud and nx-cloud 2023-04-13 10:59:31 -04:00
Victor Savkin
2bc33f14d7
docs(core): use -t and -p instead of --targets and --projects 2023-04-10 13:30:17 -04:00
Isaac Mann
a5a64cd5be
docs(core): nx.json extends property (#15393) 2023-03-02 19:59:36 -05:00
Craigory Coppola
c783ac5e9a
feat(core): merge more target options from targetDefaults (#12435)
Fixes https://github.com/nrwl/nx/issues/12433
2022-12-29 23:13:53 +00:00
Isaac Mann
569c2d3c03
docs(core): deprecate global implicit dependencies (#13642) 2022-12-07 12:54:10 -05:00
Isaac Mann
702350d48a
docs(core): update caching and dte guides 2022-11-03 14:39:47 -04:00
Benjamin Cabanes
db7951ffac
docs(core): reformat doc with better code fences (#12584) 2022-10-13 16:20:04 -04:00
Isaac Mann
600b60db5b
docs(nxdev): customizing inputs guide (#12348)
* docs(nxdev): customizing inputs guide

* docs(nxdev): add documentation cards

* docs(nxdev): update title

* docs(nxdev): update callout titles
2022-10-05 09:36:40 -04:00
Peter Colapietro
29e777fe39 chore(typo): workspacRoot => workspaceRoot 2022-09-21 21:07:24 -04:00
Isaac Mann
5cab39b9aa
docs(nxdev): deprecated section (#12054) 2022-09-16 16:54:59 -04:00
Jason Jean
292f0c14b1
feat(core): generate inputs configuration for new workspaces (#11856) 2022-09-07 22:32:59 -04:00
Isaac Mann
e717660102
docs(nx-dev): diataxis restructure (#11649)
* docs(nxdev): restructure docs to diataxis style

* docs(nxdev): cleanup

* docs(nxdev): fix links

* chore(nxdev): format

* docs(nxdev): fix broken images

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): tweaks

* docs(nxdev): redirect rules

* docs(nxdev): fixes
2022-08-29 08:36:55 -04:00