forked from nrwl/nx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(graph): move dep-graph-client to graph-client (nrwl#11792)
- Loading branch information
1 parent
3be16a8
commit 6c3ef9d
Showing
122 changed files
with
7,157 additions
and
5,078 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,19 +12,26 @@ Watch this 5-minute video: | |
|
|
||
| ## Got a Question? | ||
|
|
||
| We are trying to keep GitHub issues for bug reports and feature requests. Using the `nrwl` tag on [Stack Overflow](https://stackoverflow.com/questions/tagged/nrwl) is a much better place to ask general questions about how to use Nx. | ||
| We are trying to keep GitHub issues for bug reports and feature requests. Using the `nrwl` tag | ||
| on [Stack Overflow](https://stackoverflow.com/questions/tagged/nrwl) is a much better place to ask general questions | ||
| about how to use Nx. | ||
|
|
||
| ## Found an Issue? | ||
|
|
||
| If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-issue) to [our GitHub Repository](https://github.com/nrwl/nx). Even better, you can [submit a Pull Request](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-pr) with a fix. | ||
| If you find a bug in the source code or a mistake in the documentation, you can help us | ||
| by [submitting an issue](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-issue) | ||
| to [our GitHub Repository](https://github.com/nrwl/nx). Even better, you | ||
| can [submit a Pull Request](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#submit-pr) with a fix. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| Source code and documentation are included in the top-level folders listed below. | ||
|
|
||
| - `docs` - Markdown and configuration files for documentation including tutorials, guides for each supported platform, and API docs. | ||
| - `docs` - Markdown and configuration files for documentation including tutorials, guides for each supported platform, | ||
| and API docs. | ||
| - `e2e` - E2E tests. | ||
| - `packages` - Source code for Nx packages such as Angular, React, Web, NestJS, Next and others including generators and executors (or builders). | ||
| - `packages` - Source code for Nx packages such as Angular, React, Web, NestJS, Next and others including generators and | ||
| executors (or builders). | ||
| - `scripts` - Miscellaneous scripts for project tasks such as building documentation, testing, and code formatting. | ||
| - `tmp` - Folder used by e2e tests. If you are a WebStorm user, make sure to mark this folder as excluded. | ||
|
|
||
|
|
@@ -64,7 +71,8 @@ yarn local-registry disable | |
| To publish packages to a local registry, do the following: | ||
|
|
||
| - Run `yarn local-registry start` in Terminal 1 (keep it running) | ||
| - Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to be logged in. You can use test/test/[email protected].) | ||
| - Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to | ||
| be logged in. You can use test/test/[email protected].) | ||
| - Run `yarn local-registry enable` in Terminal 2 | ||
| - Run `yarn nx-release 999.9.9 --local` in Terminal 2 | ||
| - Run `cd ./tmp` in Terminal 2 | ||
|
|
@@ -85,7 +93,8 @@ Yarn Berry operates slightly differently than Yarn Classic. In order to publish | |
| - localhost | ||
| ``` | ||
| - Run `yarn local-registry start` in Terminal 1 (keep it running) | ||
| - If you are creating nx workspace outside of your nx repo, make sure to add npm registry info to your root yarnrc (usually in ~/.yarnrc.yml). The file should look something like this: | ||
| - If you are creating nx workspace outside of your nx repo, make sure to add npm registry info to your root yarnrc ( | ||
| usually in ~/.yarnrc.yml). The file should look something like this: | ||
|
|
||
| ```yml | ||
| npmRegistries: | ||
|
|
@@ -98,7 +107,9 @@ Yarn Berry operates slightly differently than Yarn Classic. In order to publish | |
| - localhost | ||
| ``` | ||
|
|
||
| - Run `yarn nx-release --local` in Terminal 2 to publish next minor version. If this version already exists, you can bump the minor version in `lerna.json` to toggle the next minor. The output will report the version of published packages. | ||
| - Run `yarn nx-release --local` in Terminal 2 to publish next minor version. If this version already exists, you can | ||
| bump the minor version in `lerna.json` to toggle the next minor. The output will report the version of published | ||
| packages. | ||
| - Go to your target folder (e.g. `cd ./tmp`) in Terminal 2 | ||
| - Run `yarn dlx [email protected]` in Terminal 2 (replace `123.4.5` with the version that got published). | ||
|
|
||
|
|
@@ -136,41 +147,51 @@ nx e2e e2e-cli -t versions # I often add qqqq to my test name so I can use -t qq | |
|
|
||
| To build Nx on Windows, you need to use WSL. | ||
|
|
||
| - Run `yarn install` in WSL. Yarn will compile several dependencies. If you don't run `install` in WSL, they will be compiled for Windows. | ||
| - Run `yarn install` in WSL. Yarn will compile several dependencies. If you don't run `install` in WSL, they will be | ||
| compiled for Windows. | ||
| - Run `nx affected --target=test` and other commands in WSL. | ||
|
|
||
| ## Documentation Contributions | ||
|
|
||
| We would love for you to contribute to our documentation as well! Please feel welcome to submit fixes or enhancements to our existing documentation pages and the `nx-dev` application in this repo. | ||
| We would love for you to contribute to our documentation as well! Please feel welcome to submit fixes or enhancements to | ||
| our existing documentation pages and the `nx-dev` application in this repo. | ||
|
|
||
| ### Documentation Structure | ||
|
|
||
| #### Documentation Pages | ||
|
|
||
| Our documentation pages can be found within this repo under the `docs` directory. | ||
|
|
||
| The `docs/map.json` file is considered our source of truth for our site's structure, and should be updated when adding a new page to our documentation to ensure that it is included in the documentation site. We also run automated scripts based on this `map.json` data to safeguard against common human errors that could break our site. | ||
| The `docs/map.json` file is considered our source of truth for our site's structure, and should be updated when adding a | ||
| new page to our documentation to ensure that it is included in the documentation site. We also run automated scripts | ||
| based on this `map.json` data to safeguard against common human errors that could break our site. | ||
|
|
||
| #### Nx-Dev Application | ||
|
|
||
| Our public `nx.dev` documentation site is a [Next.js](https://nextjs.org/) application, that can be found in the `nx-dev` directory of this repo. | ||
| The documentation site is consuming the `docs/` directly by copy-ing its content while deploying, so the website is always in sync and reflects the latest version of `docs/`. | ||
| Our public `nx.dev` documentation site is a [Next.js](https://nextjs.org/) application, that can be found in | ||
| the `nx-dev` directory of this repo. | ||
| The documentation site is consuming the `docs/` directly by copy-ing its content while deploying, so the website is | ||
| always in sync and reflects the latest version of `docs/`. | ||
|
|
||
| Jump to [Running the Documentation Site Locally](#running-the-documentation-site-locally) to see how to preview your changes while serving. | ||
| Jump to [Running the Documentation Site Locally](#running-the-documentation-site-locally) to see how to preview your | ||
| changes while serving. | ||
|
|
||
| ### Changing Generated API documentation | ||
|
|
||
| `.md` files documenting the API for our CLI (including executor and generator API docs) are generated via the corresponding `schema.json` file for the given command. | ||
| `.md` files documenting the API for our CLI (including executor and generator API docs) are generated via the | ||
| corresponding `schema.json` file for the given command. | ||
|
|
||
| After adjusting the `schema.json` file, `.md` files for these commands can be generated by running: | ||
|
|
||
| ```bash | ||
| yarn documentation | ||
| ``` | ||
|
|
||
| This will update the corresponding contents of the `docs` directory. These are generated automatically on push (via husky) as well. | ||
| This will update the corresponding contents of the `docs` directory. These are generated automatically on push (via | ||
| husky) as well. | ||
|
|
||
| Note that adjusting the `schema.json` files will also affect the CLI manuals and Nx Console behavior, in addition to adjusting the docs. | ||
| Note that adjusting the `schema.json` files will also affect the CLI manuals and Nx Console behavior, in addition to | ||
| adjusting the docs. | ||
|
|
||
| ### Running the Documentation Site Locally | ||
|
|
||
|
|
@@ -184,7 +205,9 @@ You can then access the application locally at `localhost:4200`. | |
|
|
||
| #### Troubleshooting: `JavaScript heap out of memory` | ||
|
|
||
| If you see an error that states: `FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory`, you need to [increase the max memory size of V8's old memory section](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes): | ||
| If you see an error that states: `FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory`, | ||
| you need | ||
| to [increase the max memory size of V8's old memory section](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes): | ||
|
|
||
| ```bash | ||
| export NODE_OPTIONS="--max-old-space-size=4096" | ||
|
|
@@ -194,25 +217,34 @@ After configuring this, try to run `npx nx serve nx-dev` again. | |
|
|
||
| ### PR Preview | ||
|
|
||
| When submitting a PR, this repo will automatically generate a preview of the `nx-dev` application based on the contents of your pull request. | ||
| When submitting a PR, this repo will automatically generate a preview of the `nx-dev` application based on the contents | ||
| of your pull request. | ||
|
|
||
| Once the preview site is launched, a comment will automatically be added to your PR with the link your PR's preview. To check your docs changes, make sure to select `Preview` from the version selection box of the site. | ||
| Once the preview site is launched, a comment will automatically be added to your PR with the link your PR's preview. To | ||
| check your docs changes, make sure to select `Preview` from the version selection box of the site. | ||
|
|
||
| ## Submission Guidelines | ||
|
|
||
| ### <a name="submit-issue"></a> Submitting an Issue | ||
|
|
||
| Before you submit an issue, please search the issue tracker. An issue for your problem may already exist and has been resolved, or the discussion might inform you of workarounds readily available. | ||
| Before you submit an issue, please search the issue tracker. An issue for your problem may already exist and has been | ||
| resolved, or the discussion might inform you of workarounds readily available. | ||
|
|
||
| We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. Having a reproducible scenario gives us wealth of important information without going back and forth with you requiring additional information, such as: | ||
| We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. Having a | ||
| reproducible scenario gives us wealth of important information without going back and forth with you requiring | ||
| additional information, such as: | ||
|
|
||
| - the output of `nx report` | ||
| - `yarn.lock` or `package-lock.json` | ||
| - and most importantly - a use-case that fails | ||
|
|
||
| A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. | ||
| A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are | ||
| fixing the right problem. | ||
|
|
||
| We will be insisting on a minimal reproduction in order to save maintainers' time and ultimately be able to fix more bugs. Interestingly, from our experience, users often find coding problems themselves while preparing a minimal reproduction repository. We understand that sometimes it might be hard to extract essentials bits of code from a larger codebase, but we really need to isolate the problem before we can fix it. | ||
| We will be insisting on a minimal reproduction in order to save maintainers' time and ultimately be able to fix more | ||
| bugs. Interestingly, from our experience, users often find coding problems themselves while preparing a minimal | ||
| reproduction repository. We understand that sometimes it might be hard to extract essentials bits of code from a larger | ||
| codebase, but we really need to isolate the problem before we can fix it. | ||
|
|
||
| You can file new issues by filling out our [issue form](https://github.com/nrwl/nx/issues/new/choose). | ||
|
|
||
|
|
@@ -222,7 +254,8 @@ Please follow the following guidelines: | |
|
|
||
| - Make sure unit tests pass (`nx affected --target=test`) | ||
| - Target a specific project with: `nx run proj:test` (i.e. `nx run angular:test` to target `packages/angular`) | ||
| - Target a specific unit test file (i.e. `packages/angular/src/utils/ast-command-line-utils.spec.ts`) with `npx jest angular/src/utils/ast-utils` or `npx jest packages/angular/src/utils/ast-utils` | ||
| - Target a specific unit test file (i.e. `packages/angular/src/utils/ast-command-line-utils.spec.ts`) | ||
| with `npx jest angular/src/utils/ast-utils` or `npx jest packages/angular/src/utils/ast-utils` | ||
| - For more options on running tests - check `npx jest --help` or visit [jestjs.io](https://jestjs.io/) | ||
| - Debug with `node --inspect-brk ./node_modules/jest/bin/jest.js build/packages/angular/src/utils/ast-utils.spec.js` | ||
| - Make sure e2e tests pass (this can take a while, so you can always let CI check those) (`yarn e2e`) | ||
|
|
@@ -247,9 +280,12 @@ body | |
|
|
||
| The type must be one of the following: | ||
|
|
||
| - feat - New or improved behavior being introduced (e.g. Updating to new versions of React or Jest which bring in new features) | ||
| - fix - Fixes the current unexpected behavior to match expected behavior (e.g. Fixing the library generator to create the proper named project) | ||
| - cleanup - Code Style changes that have little to no effect on the user (e.g. Refactoring some functions into a different file) | ||
| - feat - New or improved behavior being introduced (e.g. Updating to new versions of React or Jest which bring in new | ||
| features) | ||
| - fix - Fixes the current unexpected behavior to match expected behavior (e.g. Fixing the library generator to create | ||
| the proper named project) | ||
| - cleanup - Code Style changes that have little to no effect on the user (e.g. Refactoring some functions into a | ||
| different file) | ||
| - docs - Changes to the documentation (e.g. Adding more details into the getting started guide) | ||
| - chore - Changes that have absolutely no effect on users (e.g. Updating the version of Nx used to build the repo) | ||
|
|
||
|
|
@@ -259,7 +295,7 @@ The scope must be one of the following: | |
|
|
||
| - angular - anything Angular specific | ||
| - core - anything Nx core specific | ||
| - dep-graph - anything dep-graph app specific | ||
| - graph - anything graph app specific | ||
| - detox - anything Detox specific | ||
| - devkit - devkit-related changes | ||
| - express - anything Express specific | ||
|
|
@@ -280,7 +316,8 @@ The scope must be one of the following: | |
|
|
||
| ##### Subject and Body | ||
|
|
||
| The subject must contain a description of the change, and the body of the message contains any additional details to provide more context about the change. | ||
| The subject must contain a description of the change, and the body of the message contains any additional details to | ||
| provide more context about the change. | ||
|
|
||
| Including the issue number that the PR relates to also helps with tracking. | ||
|
|
||
|
|
@@ -297,4 +334,5 @@ Closes #157 | |
| #### Commitizen | ||
|
|
||
| To simplify and automate the process of committing with this format, | ||
| **Nx is a [Commitizen](https://github.com/commitizen/cz-cli) friendly repository**, just do `git add` and execute `yarn commit`. | ||
| **Nx is a [Commitizen](https://github.com/commitizen/cz-cli) friendly repository**, just do `git add` and | ||
| execute `yarn commit`. | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.