SamProf / nx-reference

Just example repository to show issue in NX enviroment

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Import Issue

The problem is that I have configured in eslint that in the simplest case only the following dependencies are available: app -> feature -> core

Next, the developer created the file in lib/lib-feature1. libs/lib-feature1/src/lib/feature1-main/sex-enum.ts

Imagine he forgot to re-export it via libs/lib-feature1/src/index.ts

And just in WebStorm starts using this Enum in libs/lib-core/src/lib/main-service.ts

WebStorm immediately finds the direct path to this file and automatically corrupts this Enum by the relative path 'import {SexEnum} from "../../../lib-feature1/src/lib/feature1-main/sex-enum";'

And there are a few problems

  • The programmer did not re-export the required enum into the index.ts library
  • The path is not created on the result of a buildable library, but is probably compiled into this library directly.
  • Linter does not see this as a problem, although it is forbidden to link to the feature library from the core library.

NxReferences

This project was generated using Nx.

🔎 Smart, Fast and Extensible Build System

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • Angular
    • ng add @nrwl/angular
  • React
    • ng add @nrwl/react
  • Web (no framework frontends)
    • ng add @nrwl/web
  • Nest
    • ng add @nrwl/nest
  • Express
    • ng add @nrwl/express
  • Node
    • ng add @nrwl/node

There are also many community plugins you could add.

Generate an application

Run ng g @nrwl/angular:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run ng g @nrwl/angular:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from @nx-references/mylib.

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Distributed Computation Caching & Distributed Task Execution

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.

About

Just example repository to show issue in NX enviroment


Languages

Language:TypeScript 93.2%Language:JavaScript 5.7%Language:HTML 1.0%Language:SCSS 0.2%