mirror of
https://github.com/cse110-fa22-group29/cse110-fa22-group29.git
synced 2024-12-27 09:29:10 +00:00
Merge pull request #58 from cse110-fa22-group29/updated-documentation
Added ADR for HTMLhint and Stylelint
This commit is contained in:
commit
ad723543e8
@ -31,6 +31,9 @@ So far the features listed below have been completed to some degree:
|
|||||||
- Linting (JS)
|
- Linting (JS)
|
||||||
- Implemented: ction triggers on any PR, uses eslint to perform style enforcement on all JS components
|
- Implemented: ction triggers on any PR, uses eslint to perform style enforcement on all JS components
|
||||||
- ToDo: trigger workflow only on certain PRs which relate to JS code
|
- ToDo: trigger workflow only on certain PRs which relate to JS code
|
||||||
|
- Linting (HTML)
|
||||||
|
- Implemented: action triggers on any PR, uses HTMLhint to perform style enforcement on all HTML components
|
||||||
|
- Linting (CSS)
|
||||||
|
- Implemented: action triggers on any PR, uses Stylelint to perform style enforcement on all CSS components
|
||||||
|
|
||||||
## Planned Features and Timeline
|
## Planned Features and Timeline
|
19
specs/adrs/111422-csslinting-stylelint.md
Normal file
19
specs/adrs/111422-csslinting-stylelint.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Use Stylelint for CSS linting framework
|
||||||
|
|
||||||
|
- Status: accept
|
||||||
|
- Deciders: Arthur Lu, Marc Reta
|
||||||
|
- Date: 11 / 14 / 22
|
||||||
|
|
||||||
|
## Decision Drivers
|
||||||
|
|
||||||
|
- Need linting to work with multiple style standards
|
||||||
|
- Need linting to be fast and informative
|
||||||
|
|
||||||
|
## Considered Options
|
||||||
|
|
||||||
|
- Stylelint
|
||||||
|
- Prettier
|
||||||
|
|
||||||
|
## Decision Outcome
|
||||||
|
|
||||||
|
Chosen Option: Stylelint for its easy installation and unopinionated.
|
19
specs/adrs/111422-htmllinting-htmlhint.md
Normal file
19
specs/adrs/111422-htmllinting-htmlhint.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Use HTMLhint for HTML linting framework
|
||||||
|
|
||||||
|
- Status: accept
|
||||||
|
- Deciders: Arthur Lu, Marc Reta
|
||||||
|
- Date: 11 / 14 / 22
|
||||||
|
|
||||||
|
## Decision Drivers
|
||||||
|
|
||||||
|
- Need linting to work with multiple style standards
|
||||||
|
- Need linting to be fast and informative
|
||||||
|
|
||||||
|
## Considered Options
|
||||||
|
|
||||||
|
- HTMLhint
|
||||||
|
- HTML-validate
|
||||||
|
|
||||||
|
## Decision Outcome
|
||||||
|
|
||||||
|
Chosen Option: HTMLhint for its low configuration complexity.
|
Loading…
Reference in New Issue
Block a user