inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

ACS-5520 add eslint-angular README, rephrase rule documentation (#8850)

Browse Source
This commit is contained in:
Grzegorz Jaśkowski 2023-08-25 16:44:31 +02:00 committed by GitHub
parent d839531d08
commit 885c5a52fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/eslint-angular/rules/use-none-component-view-encapsulation.md
View File

@ -7,11 +7,12 @@ Last reviewed: 2023-05-23
# [Use none component view encapsulation](../../../lib/eslint-angular/src/rules/use-none-component-view-encapsulation/use-none-component-view-encapsulation.ts "Defined in use-none-component-view-encapsulation.ts")
Custom ESLint rule which check if component uses ViewEncapsulation.None. It has been implemented because None encapsulation makes themes styling easier.
It also allows to autofix.
Custom ESLint rule that requires components to use ViewEncapsulation.None. It has been implemented because None encapsulation makes themes styling easier.
This rule allows autofix.
## Basic Usage
Put this rule in eslintrc.json in rules.
Put this rule in `.eslintrc.json` in `rules` section.
```json
{

42
lib/eslint-angular/README.md Normal file
View File

@ -0,0 +1,42 @@
# Alfresco ESlint Angular Library
Contains custom ESlint rules for Angular.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Documentation](#documentation)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [License](#license)
<!-- tocstop -->
<!-- markdown-toc end -->
## Documentation
See the [ADF ESlint Angular](../../docs/README.md#eslint-angular-api) section of the [docs index](../../docs/README.md)
for all available documentation on this library.
## Prerequisites
This library doesn't require any additional software. Just install it with `npm` command from Install section below.
## Install
```sh
npm install @alfresco/eslint-plugin-eslint-angular
```
## Usage
If you want to add your own custom ESlint rules for Angular, make sure you're familiar with `ESTree` and `JavaScript AST nodes`. For rule creation refer to [Angular ESlint documentation](https://github.com/angular-eslint/angular-eslint#readme) and [Writing custom TS ESlint rules for Angular guide](https://medium.com/bigpicture-one/writing-custom-typescript-eslint-rules-with-unit-tests-for-angular-project-f004482551db).
Custom rules need to be added to `rules` section of `.eslintrc.json` file. For example on how to do it refer to `Basic Usage` paragraph of [Use none component view encapsulation rule](../../docs/eslint-angular/rules/use-none-component-view-encapsulation.md#basic-usage).
## License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)