Skip to content

Latest commit

 

History

History
140 lines (95 loc) · 2.76 KB

commands.md

File metadata and controls

140 lines (95 loc) · 2.76 KB
Raw

Commands

This file describes the commands that can be run with the project.

To know more about this project, go here.

Table of commands

Nx Commands

This project uses Nx to manage the code. It gives access to a lot of commands.

However, it is recommended to use NPM commands as they are manually added and confirmed.
Nx can still be used. In fact if a running Nx command is really useful, it should probably be a NPM command too.

Nx Graph

The graph dependencies of all the applications can be shown with the following command:

nx graph

NPM commands

These commands are stored in the package.json file and mainly are shortcuts for Nx commands.

The real advantage is that, if a command exists in the file, then it can be run. Developers do not need to know all the combination that Nx offers to run the principals commands.

Lint

The linter in this project also formats, and it does for a lot of files:

  • Typescript
  • HTML
  • SCSS
  • JSON
  • Markdown
  • ...

There's 2 linters in the project:

  • ESLint: does most of the job.
  • Stylelint: Very similar to eslint but for stylesheet files (CSS, SCSS, ...).

There are 2 commands to run them both:

npm run lint

And its corrector:

npm run lint:fix

It is still possible to run them separately:

  • ESLint:
npm run lint:code

And its corrector:

npm run lint:code:fix
  • Stylelint:
npm run lint:style

And its corrector:

npm run lint:style:fix

Test

It is possible to run the tests of this project with 2 commands.

The first one runs the unit tests:

npm run test

And another for the e2e tests:

npm run test:e2e

Go here to know more about the tests.

These commands are not made to be developed with; It has no watch mode.

Comment coverage

Compodoc is a tool that generates documentation. It can also test if the comments have enough coverage in the project:

npm run compodoc:coverage

Specific applications

Check the following files for their specific commands.