Validators
September 25, 2023 ยท View on GitHub
Below, you can find a list of all validators that are used by the workspace validation.
| Id | Name | Description |
|---|---|---|
| check-boundaries-config | Check Boundaries Linting Configuration | TBD |
| check-eol-is-lf | Check EOF is LF | This validator checks whether the EOF is defined correctly. |
| check-eslint-config | Check ESLint Configs | This validator checks for the eslint package existence in the target's project repository. It also compares eslint configuration with the expected one, and generates a report with the diff object of the configurations. |
| check-external-imports | Check External Imports | TBD |
| check-gulp-usage | Check Gulp Usage | In a Nx architecture, Gulp is not needed anymore because Nx Tasks will be used instead to standardize the executions you can have on each project. |
| check-nx-scripts-in-package-json | Check Nx scripts in package.json | This validator should compare the root package.json scripts with the frontend monorepo ones. |
| check-prettier-config | Check Prettier Configuration | The goal of that validator is to check that prettier is correctly configured in the current repository. |
| check-root-tsconfig-base | Check root tsconfig.base.json | The goal of that validator is to check that the main typescript configurations is correctly configured in the current repository. |
| check-ts-compiler-options | Check Typescript Compiler Options | TBD |
| check-tsconfig-paths | Check tsconfig paths | This validator checks that the main typescript configuration is containing valid path configurations. To do so, wildcard paths are not allowed. |
| check-tsconfig-per-project | Check Boundaries Linting Configuration | TBD |
| check-tslint-not-used | Check TSLint is not used | This validator checks whether the repository has no tslint dependency installed and configured. |
| check-version-mismatch | Check Version Mismatch | This validator checks that all the packages that are used in the repository are aligned with the dependency from the monorepo dependencies. |
| check-webpack-config | Check Webpack Config | This validator checks if Angular applications are using the shared Webpack configuration from the dev-kit. |
| check-yarn-config | Check Yarn Config | This validator checks that the repository is using yarn as the package manager and that it's configured correctly. |
| no-package-json-placeholder | No package.json placeholder | This validator checks that a project's package.json file does not contain any placeholders instead of a real version number. |
| use-common-publish-target | Use Common Publish Target | This validator checks if projects are using common publish executor from the @frontend/dev-kit plugin. |
| use-common-release-target | Use Common Release Target | This validator checks if projects are using common release executor from the @frontend/dev-kit plugin. |
| use-nx-cloud | Use Nx Cloud | This validator checks that the workspace is using Nx Cloud. |
| use-output-dist | Use output dist | This validator checks whether each target's outputs array in project.json contains a path that is equal to {workspaceRoot}/dist/${target}/{projectRoot}. |
| use-project-config | Use project configuration | This validator checks that everything that could be considered as a Nx project should contain a file project.json. |
| use-publishable-library | Use publishable library | TBD |
| use-single-entry-file | Use single entry file | TBD |
| use-workspace-layout | Use workspace folder structure | This validator checks whether a workspace folder structure fits the monorepo one. |
This list was generated by using the script
node update-README.js