117616: Created custom sort-standalone-imports rule

Author: alexandrevryghem

.eslintrc.json

@@ -295,6 +295,15 @@
               "listableObjectComponent"
             ]
           }
+        ],
+        "dspace-angular-ts/sort-standalone-imports": [
+          "error",
+          {
+            "locale": "en-US",
+            "maxItems": 0,
+            "indent": 2,
+            "trailingComma": true
+          }
         ]
       }
     },

docs/lint/ts/index.md

@@ -2,6 +2,7 @@
 _______
 
 - [`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

docs/lint/ts/rules/sort-standalone-imports.md

@@ -0,0 +1,214 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/sort-standalone-imports`
+_______
+
+Sorts the standalone `@Component` imports alphabetically
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/sort-standalone-imports.ts)
+
+
+### Options
+
+#### `locale`
+
+The locale used to sort the imports.,
+#### `maxItems`
+
+The maximum number of imports that should be displayed before each import is separated onto its own line.,
+#### `indent`
+
+The indent used for the project.,
+#### `trailingComma`
+
+Whether the last import should have a trailing comma (only applicable for multiline imports).
+
+
+### Examples
+
+
+#### Valid code
+    
+##### should sort multiple imports on separate lines
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    AsyncPipe,
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+    
+##### should not inlines singular imports when maxItems is 0
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+    
+##### should inline singular imports when maxItems is 1
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [RootComponent],
+})
+export class AppComponent {}
+```
+    
+
+
+
+#### Invalid code  & automatic fixes
+    
+##### should sort multiple imports alphabetically
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    RootComponent,
+    AsyncPipe,
+  ],
+})
+export class AppComponent {}
+```
+Will produce the following error(s):
+```
+Standalone imports should be sorted alphabetically
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    AsyncPipe,
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+        
+    
+##### should not put singular imports on one line when maxItems is 0
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [RootComponent],
+})
+export class AppComponent {}
+```
+Will produce the following error(s):
+```
+Standalone imports should be sorted alphabetically
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+        
+    
+##### should not put singular imports on a separate line when maxItems is 1
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+Will produce the following error(s):
+```
+Standalone imports should be sorted alphabetically
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [RootComponent],
+})
+export class AppComponent {}
+```
+        
+    
+##### should not display multiple imports on the same line
+        
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [AsyncPipe, RootComponent],
+})
+export class AppComponent {}
+```
+Will produce the following error(s):
+```
+Standalone imports should be sorted alphabetically
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-app',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.scss'],
+  standalone: true,
+  imports: [
+    AsyncPipe,
+    RootComponent,
+  ],
+})
+export class AppComponent {}
+```
+        
+    
+

lint/src/rules/ts/index.ts

@@ -11,6 +11,7 @@ import {
 } from '../../util/structure';
 /* eslint-disable import/no-namespace */
 import * as aliasImports from './alias-imports';
+import * as sortStandaloneImports from './sort-standalone-imports';
 import * as themedComponentClasses from './themed-component-classes';
 import * as themedComponentSelectors from './themed-component-selectors';
 import * as themedComponentUsages from './themed-component-usages';
@@ -20,6 +21,7 @@ import * as uniqueDecorators from './unique-decorators';
 
 const index = [
   aliasImports,
+  sortStandaloneImports,
   themedComponentClasses,
   themedComponentSelectors,
   themedComponentUsages,