46 Commits

Author SHA1 Message Date
Jason Jean
381efa8e0d
fix(core): show target description, add metadata to schema, and docum… (#27131)
…ent it

<!-- 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 -->

Target description is not shown in the PDV.

Also, being able to set a description in `project.json` is not in the
schema nor is it documented.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Target descriptions are shown in the PDV.

Also, being able to set a description in `project.json` is in the schema
and documented on
https://nx-dev-git-metadata-docs-nrwl.vercel.app/project-configuration#target-metadata


![image](https://github.com/user-attachments/assets/2037eca8-d516-4513-81fd-12b8384a9411)


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

Fixes https://github.com/nrwl/nx/issues/19355
2024-07-31 11:45:56 -04:00
Alice Kile
acd9bb7748
docs(core): document wildcard support for dependsOn field (#27029)
<!-- 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 -->
This feature is not yet documented...

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Document wildcard support in `dependsOn` field for project
configurations.

Note: Reading through the PR below that impls. this wildcard support, I
couldn't quite figure out if it was actually able to also work in case
of object syntax and whether this will also work for `targetDefaults`...
so if you know any better, please lemme know so I can update this PR 🙏

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

documents #19611
2024-07-29 17:08:31 -05:00
Emily Xiong
627504d8d3
docs(core): add docs for parallelism (#26950)
<!-- 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 -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

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

Fixes #
2024-07-22 17:42:03 -04:00
Isaac Mann
1277b22ce4
docs(core): link to pass args recipe (#26276)
Link to the `Pass Arguments to Commands` recipe
2024-05-30 13:31:27 -04:00
Chabbey François
32030435b7
docs(core): fix dependsOn snippet in project configuration reference (#23668)
I'm not totally sure, but by reading the docs, the intent of the first
example is to say that the test target depends of the build target.
Otherwise, it would mean that the build target depends of the build
target, which does not make sense. Or did I misunderstood something in
the doc ?

Co-authored-by: U812320 <francoisjulien.chabbey@mobi.ch>
2024-05-22 14:42:18 +02:00
Emily Xiong
fd5ea92062
fix(nx-dev): fix project details in nx dev (#23175)
<!-- 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` -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
fix project details in nx dev
add metadata to nx dev's project details json

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

Fixes #
2024-05-03 20:07:32 -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
Isaac Mann
5f255c5a43
docs(core): editor setup in getting started (#22416)
Co-authored-by: Leosvel Pérez Espinosa <leosvel.perez.espinosa@gmail.com>
2024-04-02 11:56:42 -04: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
Zachary DeRose
92ade5f9a1
docs(misc): add picture-in-picture shorts on select pages (#19974) 2023-11-03 13:29:29 -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
Benny Neugebauer
190bc8b707
docs(core): replace Github with GitHub (#19397) 2023-10-02 14:44:31 -04:00
MaxKless
f639883786
docs(core): add examples for runtime & env inputs (#19129) 2023-09-12 13:29:04 -04:00
Isaac Mann
77bc1e8778
feat(nx-dev): highlight lines in code samples (#18690) 2023-08-18 10:59:18 -04:00
Isaac Mann
8c723380a7
docs(core): rename enforce project boundaries (#18421) 2023-08-01 11:36:28 -04:00
Jonathan Cammisuli
b6db266c9e
fix(core): handle complex glob patterns within rust (#18242) 2023-07-25 11:11:22 -04:00
Miroslav Jonaš
331707d6eb
docs(nx-dev): make more concepts submenu (#18266) 2023-07-24 14:20:48 +00:00
Miroslav Jonas
2fc3e2e485 docs(nx-dev): move plugin features under core features 2023-07-24 14:13:24 +02:00
Jonathan Cammisuli
fef5b65b45
fix(core): migrate old invalid glob syntax in target outputs (#18191) 2023-07-20 10:04:01 -04:00
Miroslav Jonas
2dc12acf0c fix(nx-dev): fix project config reference headlines 2023-07-19 16:46:38 +02:00
Miroslav Jonaš
1a7577ee1b
docs(core): replace run-commands with command in new input reference (#17700) 2023-06-21 08:10:54 -04:00
Miroslav Jonaš
ec4e85773d
feat(core): add dependentTasksOutputFiles input (#17314) 2023-06-08 09:45:07 -04:00
Isaac Mann
cd9f04109e
docs(core): expand json examples (#17388) 2023-06-02 14:39:34 -04:00
Roy Ling
e8375f254b
docs(misc): fixed wrong project.json examples (#17141) 2023-06-02 09:01:15 -04:00
Miroslav Jonaš
f5ae9958ef
feat(core): add commandExternalDependencies hash input (#16916)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-05-15 11:30:17 -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
Craigory Coppola
ac64773ffa
feat(core): update dependsOn configuration to use dependencies property (#16584) 2023-04-26 17:11:26 -04:00
Isaac Mann
64c35a6f8a
docs(core): task dependencies with single project (#16204) 2023-04-11 12:00:39 -04:00
Craigory Coppola
f2f6e356a7
feat(core): allow dependsOn to accept a single project dependency (#16100) 2023-04-10 13:12:16 -04:00
Isaac Mann
db20f655d9
docs(core): bad callout in project config page (#15930) 2023-03-28 12:31:07 -04:00
Isaac Mann
82170c85d8
docs(core): reference minimatch library (#15317) 2023-03-01 11:23:32 -05:00
Paul Eustice
cd20b6ed85
docs(core): fix implicitDependencies examples (#14539) 2023-01-23 11:51:39 -05:00
Josh Goldberg
6750f8b2d6
docs(core): mention outputs defaults in project-configuration (#14479)
Fixes https://github.com/nrwl/nx/issues/14472
2023-01-20 10:56:19 -05:00
Craigory Coppola
66a26583da
feat(core): add glob support for project-level implicit dependencies (#13138) 2022-12-29 17:37:28 -05:00
Zack DeRose
7daa2eb380 docs(core): rm typo - Project Configuration 2022-12-10 15:14:38 -05:00
Craigory Coppola
76c237bd2c
feat(core): add nx exec command (#13212) 2022-11-21 17:35:24 -05:00
Isaac Mann
204e64ac8c
docs(core): list which package.jsons are included (#13203)
Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
2022-11-17 15:33:30 -05:00
Craigory Coppola
0e3b0ef192
docs(core): document includeScripts property (#13182)
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2022-11-15 16:25:23 -05:00
Isaac Mann
702350d48a
docs(core): update caching and dte guides 2022-11-03 14:39:47 -04:00
Jason Jean
bc28a16649
docs(core): change methodology for ignoring projects (#12956) 2022-11-02 23:43:17 +00: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
Jason Jean
292f0c14b1
feat(core): generate inputs configuration for new workspaces (#11856) 2022-09-07 22:32:59 -04:00
Jack Hsu
2c407791be
docs(misc): fix typo in project config doc (#11912) 2022-09-07 08:43:22 -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