Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/biophoton/nx-validators
https://github.com/biophoton/nx-validators
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/biophoton/nx-validators
- Owner: BioPhoton
- Created: 2023-08-29T09:25:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-28T11:16:57.000Z (about 1 year ago)
- Last Synced: 2024-10-15T10:24:04.217Z (3 months ago)
- Language: TypeScript
- Size: 1.56 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Workspace Validation
## Getting Started
Workspace validation utilizes the power of [Nx generators](https://nx.dev/core-features/plugin-features/use-code-generators) behind the scenes. To initiate the migration validation, run the following command:
```
nx g @nx-validators/migration-kit:validate-workspace
```
## How does it work?
```mermaid
flowchart TB
A[1. Validation] --> A1[Prompt: Run All?]
A1 -->|yes| A2[Select All]
A1 -->|no| A3[Prompt: Select Validations]
A3 --> A4[Run Selected Validations]
A2 --> A4
A4 --> A5[Run Validators]
B[2. Result] --> B1[Create a structure based on validations]
B1 --> B2[For each validator]
B2 --> B3[no-run]
B2 --> B4[success]
B2 --> B5[failed/error]
C[3. Report] --> C1[Generate report based on result]
C1 --> C2[json]
C1 --> C3[console]
D[4. Solution] --> D1[For each failed validator]
D1 --> D2[provide link to documentation]
D2 --> D3[manual Fix]
D2 -->|optional| D4[automatic Fix by using migrations]
```
### 1) Validation Phase
**The first phase** is responsible for running all generators that verify if the workspace adheres to the rules and conventions specified in the **Internal Nx Framework**.
The validators dictionary structure looks like this:
```typescript
export const WORKSPACE_VALIDATIONS: WorkspaceValidation = {
'validation-one': {
name: 'Validation One',
description: 'Validate multiple rules to align a context',
validatorIds: ['validator-one', 'validator-two'],
},
'validation-two': {
name: 'Validation Two',
description: 'Validate multiple rules to align a context',
validatorIds: ['validator-three'],
},
};
```
The structure explained:
- A `Workspace Validation` consists of multiple `Validation` sets.
- A `Validation` represents a state that needs to be followed to be compliant with the **Internal Nx Architecture**.
- A `Validator` is implemented as an [Nx generator](https://nx.dev/core-features/plugin-features/use-code-generators) and validates one specific rule. It includes documentation with explanations and solutions to address the `Validation`.
For the complete implementation of this structure, refer to the file [workspace-validations.ts](packages/migration-kit/src/workspace-validation/validate-workspace/workspace-validations.ts).
### 2) Result Phase
**The second phase** provides the output of the first phase. It generates a result for each validator, allowing us to report and propose solutions for failed validations.
The result structure is as follows:
```typescript
const result = {
created: 1690288298447,
validationResults: {
'validation-one': {
name: 'Validation One',
description: 'Validate multiple rules to align a context',
status: 'failed',
validatorResults: {
'validator-generator-id-one': {
status: 'failed',
data: ['Validator started', 'Cannot find file test.ts', 'Validator failed'],
documentation:
'packages/migration-kit/src/workspace-validation/validators/validator-generator-id-one/README.md',
},
'validator-generator-id-two': {
status: 'success',
data: ['Validator started', 'Workspace is respecting the lint configurations'],
documentation:
'packages/migration-kit/src/workspace-validation/validators/validator-generator-id-two/README.md',
},
},
},
'validation-two': {
name: 'Validation Two',
description: 'Validate multiple rules to align a context',
status: 'success',
validatorResults: {
'validator-generator-id-three': {
status: 'failed',
data: ['Validator started', 'Cannot request the server http://....', 'Validator error'],
documentation:
'/tree/master/Client/migration-kit/src/workspace-validation/validators/validator-generator-id-thee/README.md',
},
},
},
},
};
```
### 3) Report Phase
Based on the above result, we can generate a list of reports. You can configure the reports when executing the `validate-workspace` generator:
```
nx g @nx-validators/migration-kit:validate-workspace --reports=json,console
```
The available report formats are:
- `JSON`: The json report mirrors the structure of the result above.
- `CONSOLE`: The console report also displays the result in a similar format.
Additional report formats like `HTML` and `Markdown` are yet to be implemented.
### 4) Solution Phase
Following the validation result, for each `Validator` that failed, we propose documentation related to the `Validator` containing solutions to address the issues.
You can find the list of Validators and documentation here: [Validators List](packages/migration-kit/src/workspace-validation/validators/README.md)