mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
move tslint ADF rules in principal repo (#3247)
* move tslint ADF rules in principal repo * fix style issues * change pacakge.json position * update to angular cli 6.0.0 * reorganization package.json * remove node modules2 folder * exclude integration * rollback alfresco-js-api * solve types problems * fix pdf test * fix errors and exclude two tests * fix e2e * fix test * copy all the new packages in node_modules * fix test * fix packaging script * scss issue fix * move test export in tools
This commit is contained in:
36
tools/tslint-rules/README.md
Normal file
36
tools/tslint-rules/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# adf-tslint-rules
|
||||
|
||||
|
||||
A set of [TSLint](https://github.com/palantir/tslint) rules used on [ADF](https://github.com/Alfresco/alfresco-ng2-components) project.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install adf-tslint-rules
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```javascript
|
||||
{
|
||||
"rulesDirectory": [
|
||||
"node_modules/codelyzer",
|
||||
"node_modules/adf-tslint-rules"
|
||||
],
|
||||
"rules": {
|
||||
"adf-file-name": true,
|
||||
"adf-class-name": true,
|
||||
"adf-no-on-prefix-output-name": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Supported Rules
|
||||
-----
|
||||
|
||||
Rule Name | Description |
|
||||
---------- | ------------ |
|
||||
`adf-file-name` | The name of the File should not start with ADF Alfresco or Activiti prefix |
|
||||
`adf-class-name` | The name of the class should not start with ADF Alfresco or Activiti prefix |
|
||||
`adf-no-on-prefix-output-name` | Angular allows for an alternative syntax on-*. If the event itself was prefixed with on this would result in an on-onEvent binding expression |
|
||||
|
|
Reference in New Issue
Block a user