8000 GitHub - AdrianRomanski/gdg-wroclaw · GitHub
[go: up one dir, main page]

Skip to content

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

69 Commits

Folders and files

Repository files navigation

New Nx Repository

✨ Your new, shiny Nx workspace is ready ✨.

Learn more about this workspace setup and its capabilities or run npx nx graph to visually explore what was created. Now, let's get you up to speed!

Workspace structure

Applications live in apps/, libraries in libs/ (see ADR-0002). The UI stack is layered (see ADR-0013):

apps/
  events/                    the GDG Wrocław web app                       type:app
  storybook/                 the single Storybook + smoke tests            type:storybook
libs/
  design-system/
    tokens/                  @gdg-wroclaw/design-system-tokens             type:tokens
    components/              @gdg-wroclaw/design-system-components         type:components
  ui/                        @gdg-wroclaw/ui (composed GDG product UI)     type:ui

Dependencies only point down the stack (apps → ui → design-system components → tokens); @nx/enforce-module-boundaries fails lint otherwise. Run npx nx graph to explore it.

Generate a library

NX_IGNORE_UNSUPPORTED_TS_SETUP=true npx nx g @nx/angular:library libs/<scope>/<type>-<name> \
  --importPath=@gdg-wroclaw/<scope>-<type>-<name> --prefix=gdg --tags=scope:<scope>,type:<type>

Then align it with the existing libraries: a package.json instead of paths in tsconfig.base.json, and the test/Storybook tsconfig setup of libs/ui (see ADR-0004 and ADR-0013).

Run tasks

To build the library use:

npx nx run pkg1:build

To run any task with Nx use:

npx nx run <project-name>:<target>

These targets are either inferred automatically or defined in the project.json or package.json files.

More about running tasks in the docs »

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 »

Keep TypeScript project references up to date

Nx automatically updates TypeScript project references 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:

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:

npx nx sync:check

Learn more about nx sync

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 »

🔗 Learn More

💬 Community

Join the Nx community:

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0