Merge pull request #3390 from alexandrevryghem/w2p-117616_ported-custom-atmire-eslint-rules

Enforce DSpace-specific coding conventions

Author: tdonohue

.editorconfig

@@ -15,6 +15,10 @@ trim_trailing_whitespace = false
 
 [*.ts]
 quote_type = single
+ij_typescript_enforce_trailing_comma = whenmultiline
+
+[*.js]
+ij_javascript_enforce_trailing_comma = whenmultiline
 
 [*.json5]
 ij_json_keep_blank_lines_in_code = 3

.eslintrc.json

@@ -263,9 +263,48 @@
         "rxjs/no-nested-subscribe": "off",     // todo: go over _all_ cases
 
         // Custom DSpace Angular rules
+        "dspace-angular-ts/alias-imports": [
+          "error",
+          {
+            "aliases": [
+              {
+                "package": "rxjs",
+                "imported": "of",
+                "local": "of"
+              }
+            ]
+          }
+        ],
         "dspace-angular-ts/themed-component-classes": "error",
         "dspace-angular-ts/themed-component-selectors": "error",
-        "dspace-angular-ts/themed-component-usages": "error"
+        "dspace-angular-ts/themed-component-usages": "error",
+        "dspace-angular-ts/themed-decorators": [
+          "off",
+          {
+            "decorators": {
+              "listableObjectComponent": 3,
+              "rendersSectionForMenu": 2
+            }
+          }
+        ],
+        "dspace-angular-ts/themed-wrapper-no-input-defaults": "error",
+        "dspace-angular-ts/unique-decorators": [
+          "off",
+          {
+            "decorators": [
+              "listableObjectComponent"
+            ]
+          }
+        ],
+        "dspace-angular-ts/sort-standalone-imports": [
+          "error",
+          {
+            "locale": "en-US",
+            "maxItems": 0,
+            "indent": 2,
+            "trailingComma": true
+          }
+        ]
       }
     },
     {

docs/lint/html/rules/no-disabled-attribute-on-button.md

@@ -9,6 +9,8 @@ _______
 
 [Source code](../../../../lint/src/rules/html/no-disabled-attribute-on-button.ts)
 
+
+
 ### Examples
 
 
@@ -19,24 +21,28 @@ _______
 ```html
 <button [dsBtnDisabled]="true">Submit</button>
 ```
+        
 
 ##### disabled attribute is still valid on non-button elements
         
 ```html
 <input disabled>
 ```
+        
 
 ##### [disabled] attribute is still valid on non-button elements
         
 ```html
 <input [disabled]="true">
 ```
+        
 
 ##### angular dynamic attributes that use disabled are still valid
         
 ```html
 <button [class.disabled]="isDisabled">Submit</button>
 ```
+        
 
 
 
@@ -47,6 +53,9 @@ _______
         
 ```html
 <button disabled>Submit</button>
+
+        
+
 ```
 Will produce the following error(s):
 ```
@@ -63,6 +72,9 @@ Result of `yarn lint --fix`:
         
 ```html
 <button [disabled]="true">Submit</button>
+
+        
+
 ```
 Will produce the following error(s):
 ```

docs/lint/html/rules/themed-component-usages.md

@@ -11,6 +11,8 @@ _______
 
 [Source code](../../../../lint/src/rules/html/themed-component-usages.ts)
 
+
+
 ### Examples
 
 
@@ -23,6 +25,7 @@ _______
 <ds-test-themeable></ds-test-themeable>
 <ds-test-themeable [test]="something"></ds-test-themeable>
 ```
+        
 
 ##### use no-prefix selectors in TypeScript templates
         
@@ -33,6 +36,7 @@ _______
 class Test {
 }
 ```
+        
 
 ##### use no-prefix selectors in TypeScript test templates
         
@@ -45,6 +49,7 @@ Filename: `lint/test/fixture/src/test.spec.ts`
 class Test {
 }
 ```
+        
 
 ##### base selectors are also allowed in TypeScript test templates
         
@@ -57,6 +62,7 @@ Filename: `lint/test/fixture/src/test.spec.ts`
 class Test {
 }
 ```
+        
 
 
 
@@ -69,6 +75,9 @@ class Test {
 <ds-themed-test-themeable/>
 <ds-themed-test-themeable></ds-themed-test-themeable>
 <ds-themed-test-themeable [test]="something"></ds-themed-test-themeable>
+
+        
+
 ```
 Will produce the following error(s):
 ```
@@ -91,6 +100,9 @@ Result of `yarn lint --fix`:
 <ds-base-test-themeable/>
 <ds-base-test-themeable></ds-base-test-themeable>
 <ds-base-test-themeable [test]="something"></ds-base-test-themeable>
+
+        
+
 ```
 Will produce the following error(s):
 ```

docs/lint/ts/index.md

@@ -1,6 +1,11 @@
 [DSpace ESLint plugins](../../../lint/README.md) > TypeScript rules
 _______
 
+- [`dspace-angular-ts/alias-imports`](./rules/alias-imports.md): Unclear imports should be aliased for clarity
+- [`dspace-angular-ts/sort-standalone-imports`](./rules/sort-standalone-imports.md): Sorts the standalone `@Component` imports alphabetically
 - [`dspace-angular-ts/themed-component-classes`](./rules/themed-component-classes.md): Formatting rules for themeable component classes
 - [`dspace-angular-ts/themed-component-selectors`](./rules/themed-component-selectors.md): Themeable component selectors should follow the DSpace convention
 - [`dspace-angular-ts/themed-component-usages`](./rules/themed-component-usages.md): Themeable components should be used via their `ThemedComponent` wrapper class
+- [`dspace-angular-ts/themed-decorators`](./rules/themed-decorators.md): Entry components with theme support should declare the correct theme
+- [`dspace-angular-ts/themed-wrapper-no-input-defaults`](./rules/themed-wrapper-no-input-defaults.md): ThemedComponent wrappers should not declare input defaults (see [DSpace Angular #2164](https://github.com/DSpace/dspace-angular/pull/2164))
+- [`dspace-angular-ts/unique-decorators`](./rules/unique-decorators.md): Some decorators must be called with unique arguments (e.g. when they construct a mapping based on the argument values)

docs/lint/ts/rules/alias-imports.md

@@ -0,0 +1,148 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/alias-imports`
+_______
+
+Unclear imports should be aliased for clarity
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/alias-imports.ts)
+
+
+### Options
+
+#### `aliases`
+
+A list of all the imports that you want to alias for clarity. Every alias should be declared in the following format:
+```json
+{
+  "package": "rxjs",
+  "imported": "of",
+  "local": "observableOf"
+}
+```
+
+
+### Examples
+
+
+#### Valid code
+    
+##### correctly aliased imports
+        
+```typescript
+import { of as observableOf } from 'rxjs';
+```
+        
+With options:
+
+```json
+{
+  "aliases": [
+    {
+      "package": "rxjs",
+      "imported": "of",
+      "local": "observableOf"
+    }
+  ]
+}
+```
+        
+    
+##### enforce unaliased import
+        
+```typescript
+import { combineLatest } from 'rxjs';
+```
+        
+With options:
+
+```json
+{
+  "aliases": [
+    {
+      "package": "rxjs",
+      "imported": "combineLatest",
+      "local": "combineLatest"
+    }
+  ]
+}
+```
+        
+    
+
+
+
+#### Invalid code  & automatic fixes
+    
+##### imports without alias
+        
+```typescript
+import { of } from 'rxjs';
+
+        
+
+```
+Will produce the following error(s):
+```
+This import must be aliased
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { of as observableOf } from 'rxjs';
+```
+        
+    
+##### imports under the wrong alias
+        
+```typescript
+import { of as ofSomething } from 'rxjs';
+
+        
+
+```
+Will produce the following error(s):
+```
+This import uses the wrong alias (should be {{ local }})
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { of as observableOf } from 'rxjs';
+```
+        
+    
+##### disallow aliasing import
+        
+```typescript
+import { combineLatest as observableCombineLatest } from 'rxjs';
+
+        
+With options:
+
+```json
+{
+  "aliases": [
+    {
+      "package": "rxjs",
+      "imported": "combineLatest",
+      "local": "combineLatest"
+    }
+  ]
+}
+```
+        
+
+```
+Will produce the following error(s):
+```
+This import should not use an alias
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { combineLatest } from 'rxjs';
+```
+        
+    
+