Validators

September 25, 2023 ยท View on GitHub

Below, you can find a list of all validators that are used by the workspace validation.

IdNameDescription
check-boundaries-configCheck Boundaries Linting ConfigurationTBD
check-eol-is-lfCheck EOF is LFThis validator checks whether the EOF is defined correctly.
check-eslint-configCheck ESLint ConfigsThis 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-importsCheck External ImportsTBD
check-gulp-usageCheck Gulp UsageIn 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-jsonCheck Nx scripts in package.jsonThis validator should compare the root package.json scripts with the frontend monorepo ones.
check-prettier-configCheck Prettier ConfigurationThe goal of that validator is to check that prettier is correctly configured in the current repository.
check-root-tsconfig-baseCheck root tsconfig.base.jsonThe goal of that validator is to check that the main typescript configurations is correctly configured in the current repository.
check-ts-compiler-optionsCheck Typescript Compiler OptionsTBD
check-tsconfig-pathsCheck tsconfig pathsThis validator checks that the main typescript configuration is containing valid path configurations. To do so, wildcard paths are not allowed.
check-tsconfig-per-projectCheck Boundaries Linting ConfigurationTBD
check-tslint-not-usedCheck TSLint is not usedThis validator checks whether the repository has no tslint dependency installed and configured.
check-version-mismatchCheck Version MismatchThis validator checks that all the packages that are used in the repository are aligned with the dependency from the monorepo dependencies.
check-webpack-configCheck Webpack ConfigThis validator checks if Angular applications are using the shared Webpack configuration from the dev-kit.
check-yarn-configCheck Yarn ConfigThis validator checks that the repository is using yarn as the package manager and that it's configured correctly.
no-package-json-placeholderNo package.json placeholderThis validator checks that a project's package.json file does not contain any placeholders instead of a real version number.
use-common-publish-targetUse Common Publish TargetThis validator checks if projects are using common publish executor from the @frontend/dev-kit plugin.
use-common-release-targetUse Common Release TargetThis validator checks if projects are using common release executor from the @frontend/dev-kit plugin.
use-nx-cloudUse Nx CloudThis validator checks that the workspace is using Nx Cloud.
use-output-distUse output distThis validator checks whether each target's outputs array in project.json contains a path that is equal to {workspaceRoot}/dist/${target}/{projectRoot}.
use-project-configUse project configurationThis validator checks that everything that could be considered as a Nx project should contain a file project.json.
use-publishable-libraryUse publishable libraryTBD
use-single-entry-fileUse single entry fileTBD
use-workspace-layoutUse workspace folder structureThis validator checks whether a workspace folder structure fits the monorepo one.

This list was generated by using the script

    node update-README.js