1
0

117616: Added support to alias-import to disallow aliasing certain imports

This commit is contained in:
Alexandre Vryghem
2025-04-21 14:58:34 +02:00
parent aed0460cfe
commit f0a00aca95
13 changed files with 379 additions and 47 deletions

View File

@@ -270,7 +270,7 @@
{ {
"package": "rxjs", "package": "rxjs",
"imported": "of", "imported": "of",
"local": "observableOf" "local": "of"
} }
] ]
} }

View File

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

View File

@@ -25,6 +25,7 @@ _______
<ds-test-themeable></ds-test-themeable> <ds-test-themeable></ds-test-themeable>
<ds-test-themeable [test]="something"></ds-test-themeable> <ds-test-themeable [test]="something"></ds-test-themeable>
``` ```
##### use no-prefix selectors in TypeScript templates ##### use no-prefix selectors in TypeScript templates
@@ -35,6 +36,7 @@ _______
class Test { class Test {
} }
``` ```
##### use no-prefix selectors in TypeScript test templates ##### use no-prefix selectors in TypeScript test templates
@@ -47,6 +49,7 @@ Filename: `lint/test/fixture/src/test.spec.ts`
class Test { class Test {
} }
``` ```
##### base selectors are also allowed in TypeScript test templates ##### base selectors are also allowed in TypeScript test templates
@@ -59,6 +62,7 @@ Filename: `lint/test/fixture/src/test.spec.ts`
class Test { class Test {
} }
``` ```
@@ -71,6 +75,9 @@ class Test {
<ds-themed-test-themeable/> <ds-themed-test-themeable/>
<ds-themed-test-themeable></ds-themed-test-themeable> <ds-themed-test-themeable></ds-themed-test-themeable>
<ds-themed-test-themeable [test]="something"></ds-themed-test-themeable> <ds-themed-test-themeable [test]="something"></ds-themed-test-themeable>
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -93,6 +100,9 @@ Result of `yarn lint --fix`:
<ds-base-test-themeable/> <ds-base-test-themeable/>
<ds-base-test-themeable></ds-base-test-themeable> <ds-base-test-themeable></ds-base-test-themeable>
<ds-base-test-themeable [test]="something"></ds-base-test-themeable> <ds-base-test-themeable [test]="something"></ds-base-test-themeable>
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -32,6 +32,42 @@ A list of all the imports that you want to alias for clarity. Every alias should
```typescript ```typescript
import { of as observableOf } from 'rxjs'; 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"
}
]
}
```
@@ -42,6 +78,9 @@ import { of as observableOf } from 'rxjs';
```typescript ```typescript
import { of } from 'rxjs'; import { of } from 'rxjs';
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -58,6 +97,9 @@ import { of as observableOf } from 'rxjs';
```typescript ```typescript
import { of as ofSomething } from 'rxjs'; import { of as ofSomething } from 'rxjs';
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -70,4 +112,37 @@ 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';
```

View File

@@ -44,6 +44,7 @@ Whether the last import should have a trailing comma (only applicable for multil
}) })
export class AppComponent {} export class AppComponent {}
``` ```
##### should not inlines singular imports when maxItems is 0 ##### should not inlines singular imports when maxItems is 0
@@ -59,6 +60,7 @@ export class AppComponent {}
}) })
export class AppComponent {} export class AppComponent {}
``` ```
##### should inline singular imports when maxItems is 1 ##### should inline singular imports when maxItems is 1
@@ -72,6 +74,15 @@ export class AppComponent {}
}) })
export class AppComponent {} export class AppComponent {}
``` ```
With options:
```json
{
"maxItems": 1
}
```
@@ -92,6 +103,9 @@ export class AppComponent {}
], ],
}) })
export class AppComponent {} export class AppComponent {}
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -125,6 +139,9 @@ export class AppComponent {}
imports: [RootComponent], imports: [RootComponent],
}) })
export class AppComponent {} export class AppComponent {}
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -159,6 +176,17 @@ export class AppComponent {}
], ],
}) })
export class AppComponent {} export class AppComponent {}
With options:
```json
{
"maxItems": 1
}
```
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -189,6 +217,9 @@ export class AppComponent {}
imports: [AsyncPipe, RootComponent], imports: [AsyncPipe, RootComponent],
}) })
export class AppComponent {} export class AppComponent {}
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -28,6 +28,7 @@ _______
class Something { class Something {
} }
``` ```
##### Base component ##### Base component
@@ -39,6 +40,7 @@ class Something {
class TestThemeableComponent { class TestThemeableComponent {
} }
``` ```
##### Wrapper component ##### Wrapper component
@@ -55,6 +57,7 @@ Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
##### Override component ##### Override component
@@ -68,6 +71,7 @@ Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.t
class Override extends BaseComponent { class Override extends BaseComponent {
} }
``` ```
@@ -82,6 +86,9 @@ class Override extends BaseComponent {
}) })
class TestThemeableComponent { class TestThemeableComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -109,6 +116,9 @@ Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
}) })
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -139,6 +149,9 @@ Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
}) })
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -173,6 +186,9 @@ import { SomethingElse } from './somewhere-else';
}) })
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -209,6 +225,9 @@ import { Something, SomethingElse } from './somewhere-else';
}) })
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -239,6 +258,9 @@ Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.t
}) })
class Override extends BaseComponent { class Override extends BaseComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -33,6 +33,7 @@ _______
class Something { class Something {
} }
``` ```
##### Themeable component selector should replace the original version, unthemed version should be changed to ds-base- ##### Themeable component selector should replace the original version, unthemed version should be changed to ds-base-
@@ -55,6 +56,7 @@ class ThemedSomething extends ThemedComponent<Something> {
class OverrideSomething extends Something { class OverrideSomething extends Something {
} }
``` ```
##### Other themed component wrappers should not interfere ##### Other themed component wrappers should not interfere
@@ -71,6 +73,7 @@ class Something {
class ThemedSomethingElse extends ThemedComponent<SomethingElse> { class ThemedSomethingElse extends ThemedComponent<SomethingElse> {
} }
``` ```
@@ -87,6 +90,9 @@ Filename: `lint/test/fixture/src/app/test/test-themeable.component.ts`
}) })
class TestThemeableComponent { class TestThemeableComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -113,6 +119,9 @@ Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
}) })
class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> { class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -139,6 +148,9 @@ Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.t
}) })
class TestThememeableComponent extends BaseComponent { class TestThememeableComponent extends BaseComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -32,6 +32,7 @@ const config = {
b: ChipsComponent, b: ChipsComponent,
} }
``` ```
##### allow base class in class declaration ##### allow base class in class declaration
@@ -39,6 +40,7 @@ const config = {
export class TestThemeableComponent { export class TestThemeableComponent {
} }
``` ```
##### allow inheriting from base class ##### allow inheriting from base class
@@ -48,6 +50,7 @@ import { TestThemeableComponent } from './app/test/test-themeable.component';
export class ThemedAdminSidebarComponent extends ThemedComponent<TestThemeableComponent> { export class ThemedAdminSidebarComponent extends ThemedComponent<TestThemeableComponent> {
} }
``` ```
##### allow base class in ViewChild ##### allow base class in ViewChild
@@ -58,6 +61,7 @@ export class Something {
@ViewChild(TestThemeableComponent) test: TestThemeableComponent; @ViewChild(TestThemeableComponent) test: TestThemeableComponent;
} }
``` ```
##### allow wrapper selectors in test queries ##### allow wrapper selectors in test queries
@@ -67,6 +71,7 @@ Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
By.css('ds-themeable'); By.css('ds-themeable');
By.css('#test > ds-themeable > #nest'); By.css('#test > ds-themeable > #nest');
``` ```
##### allow wrapper selectors in cypress queries ##### allow wrapper selectors in cypress queries
@@ -76,6 +81,7 @@ Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
By.css('ds-themeable'); By.css('ds-themeable');
By.css('#test > ds-themeable > #nest'); By.css('#test > ds-themeable > #nest');
``` ```
@@ -92,6 +98,9 @@ const config = {
a: TestThemeableComponent, a: TestThemeableComponent,
b: TestComponent, b: TestComponent,
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -122,6 +131,9 @@ const config = {
b: TestComponent, b: TestComponent,
c: Something, c: Something,
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -152,6 +164,9 @@ const DECLARATIONS = [
Something, Something,
ThemedTestThemeableComponent, ThemedTestThemeableComponent,
]; ];
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -175,6 +190,9 @@ Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
```typescript ```typescript
By.css('ds-themed-themeable'); By.css('ds-themed-themeable');
By.css('#test > ds-themed-themeable > #nest'); By.css('#test > ds-themed-themeable > #nest');
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -196,6 +214,9 @@ Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
```typescript ```typescript
By.css('ds-base-themeable'); By.css('ds-base-themeable');
By.css('#test > ds-base-themeable > #nest'); By.css('#test > ds-base-themeable > #nest');
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -217,6 +238,9 @@ Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
```typescript ```typescript
cy.get('ds-themed-themeable'); cy.get('ds-themed-themeable');
cy.get('#test > ds-themed-themeable > #nest'); cy.get('#test > ds-themed-themeable > #nest');
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -238,6 +262,9 @@ Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
```typescript ```typescript
cy.get('ds-base-themeable'); cy.get('ds-base-themeable');
cy.get('#test > ds-base-themeable > #nest'); cy.get('#test > ds-base-themeable > #nest');
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -268,6 +295,9 @@ import { TestThemeableComponent } from '../../../../app/test/test-themeable.comp
}) })
export class UsageComponent { export class UsageComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -308,6 +338,9 @@ import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-t
}) })
export class UsageComponent { export class UsageComponent {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -29,6 +29,7 @@ Filename: `lint/test/fixture/src/themes/test/app/dynamic-component/dynamic-compo
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
##### plain file declares no theme in @listableObjectComponent ##### plain file declares no theme in @listableObjectComponent
@@ -39,6 +40,7 @@ Filename: `lint/test/fixture/src/app/dynamic-component/dynamic-component.ts`
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
##### plain file declares explicit undefined theme in @listableObjectComponent ##### plain file declares explicit undefined theme in @listableObjectComponent
@@ -49,6 +51,7 @@ Filename: `lint/test/fixture/src/app/dynamic-component/dynamic-component.ts`
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
##### test file declares theme outside of theme directory ##### test file declares theme outside of theme directory
@@ -59,6 +62,7 @@ Filename: `lint/test/fixture/src/app/dynamic-component/dynamic-component.spec.ts
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
##### only track configured decorators ##### only track configured decorators
@@ -69,6 +73,7 @@ Filename: `lint/test/fixture/src/app/dynamic-component/dynamic-component.ts`
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
@@ -83,6 +88,9 @@ Filename: `lint/test/fixture/src/themes/test/app/dynamic-component/dynamic-compo
@listableObjectComponent(something, somethingElse, undefined, 'test-2') @listableObjectComponent(something, somethingElse, undefined, 'test-2')
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -105,6 +113,9 @@ Filename: `lint/test/fixture/src/app/dynamic-component/dynamic-component.ts`
@listableObjectComponent(something, somethingElse, undefined, 'test-2') @listableObjectComponent(something, somethingElse, undefined, 'test-2')
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -127,6 +138,9 @@ Filename: `lint/test/fixture/src/themes/test-2/app/dynamic-component/dynamic-com
@listableObjectComponent(something, somethingElse, undefined) @listableObjectComponent(something, somethingElse, undefined)
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -149,6 +163,9 @@ Filename: `lint/test/fixture/src/themes/test-2/app/dynamic-component/dynamic-com
@listableObjectComponent(something, somethingElse, undefined, undefined) @listableObjectComponent(something, somethingElse, undefined, undefined)
export class Something extends SomethingElse { export class Something extends SomethingElse {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -23,6 +23,7 @@ export class TTest extends ThemedComponent<Test> {
test; test;
} }
``` ```
##### Regular class defines an input with a default value ##### Regular class defines an input with a default value
@@ -33,6 +34,7 @@ export class Test {
test = 'test'; test = 'test';
} }
``` ```
@@ -56,6 +58,9 @@ test2: number = 123;
@Input() @Input()
test3: number[] = [1,2,3]; test3: number[] = [1,2,3];
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```
@@ -74,6 +79,9 @@ export class TTest extends ThemedComponent<Test> {
@Input() @Input()
test = undefined; test = undefined;
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -43,6 +43,7 @@ export class C {
export class C { export class C {
} }
``` ```
##### unchecked decorator, some repetitions ##### unchecked decorator, some repetitions
@@ -55,6 +56,7 @@ export class A {
export class B { export class B {
} }
``` ```
@@ -71,6 +73,9 @@ export class A {
@listableObjectComponent(a) @listableObjectComponent(a)
export class B { export class B {
} }
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```

View File

@@ -13,9 +13,10 @@ import {
} from '../../util/structure'; } from '../../util/structure';
export enum Message { export enum Message {
NO_ALIAS = 'noAlias', MISSING_ALIAS = 'missingAlias',
WRONG_ALIAS = 'wrongAlias', WRONG_ALIAS = 'wrongAlias',
MULTIPLE_ALIASES = 'multipleAliases', MULTIPLE_ALIASES = 'multipleAliases',
UNNECESSARY_ALIAS = 'unnecessaryAlias',
} }
interface AliasImportOptions { interface AliasImportOptions {
@@ -39,9 +40,10 @@ export const info: DSpaceESLintRuleInfo<[AliasImportOptions], [AliasImportDocOpt
description: 'Unclear imports should be aliased for clarity', description: 'Unclear imports should be aliased for clarity',
}, },
messages: { messages: {
[Message.NO_ALIAS]: 'This import must be aliased', [Message.MISSING_ALIAS]: 'This import must be aliased',
[Message.WRONG_ALIAS]: 'This import uses the wrong alias (should be {{ local }})', [Message.WRONG_ALIAS]: 'This import uses the wrong alias (should be {{ local }})',
[Message.MULTIPLE_ALIASES]: 'This import was used twice with a different alias (should be {{ local }})', [Message.MULTIPLE_ALIASES]: 'This import was used twice with a different alias (should be {{ local }})',
[Message.UNNECESSARY_ALIAS]: 'This import should not use an alias',
}, },
fixable: 'code', fixable: 'code',
type: 'problem', type: 'problem',
@@ -103,6 +105,34 @@ export const tests: NamedTests = {
code: ` code: `
import { of as observableOf } from 'rxjs'; import { of as observableOf } from 'rxjs';
`, `,
options: [
{
aliases: [
{
package: 'rxjs',
imported: 'of',
local: 'observableOf',
},
],
},
],
},
{
name: 'enforce unaliased import',
code: `
import { combineLatest } from 'rxjs';
`,
options: [
{
aliases: [
{
package: 'rxjs',
imported: 'combineLatest',
local: 'combineLatest',
},
],
},
],
}, },
], ],
invalid: [ invalid: [
@@ -113,7 +143,7 @@ import { of } from 'rxjs';
`, `,
errors: [ errors: [
{ {
messageId: 'noAlias', messageId: 'missingAlias',
}, },
], ],
output: ` output: `
@@ -134,6 +164,31 @@ import { of as ofSomething } from 'rxjs';
import { of as observableOf } from 'rxjs'; import { of as observableOf } from 'rxjs';
`, `,
}, },
{
name: 'disallow aliasing import',
code: `
import { combineLatest as observableCombineLatest } from 'rxjs';
`,
errors: [
{
messageId: 'unnecessaryAlias',
},
],
output: `
import { combineLatest } from 'rxjs';
`,
options: [
{
aliases: [
{
package: 'rxjs',
imported: 'combineLatest',
local: 'combineLatest',
},
],
},
],
},
], ],
}; };
@@ -145,56 +200,94 @@ import { of as observableOf } from 'rxjs';
* @param node The incorrect import node that should be fixed * @param node The incorrect import node that should be fixed
*/ */
function handleUnaliasedImport(context: TSESLint.RuleContext<Message, unknown[]>, option: AliasImportOption, node: TSESTree.ImportSpecifier): void { function handleUnaliasedImport(context: TSESLint.RuleContext<Message, unknown[]>, option: AliasImportOption, node: TSESTree.ImportSpecifier): void {
const hasAliasedImport: boolean = (node.parent as TSESTree.ImportDeclaration).specifiers.find((specifier: TSESTree.ImportClause) => specifier.local.name === option.local && specifier.type === AST_NODE_TYPES.ImportSpecifier && (specifier as TSESTree.ImportSpecifier).imported.name === option.imported) !== undefined; const hasCorrectAliasedImport: boolean = (node.parent as TSESTree.ImportDeclaration).specifiers.find((specifier: TSESTree.ImportClause) => specifier.local.name === option.local && specifier.type === AST_NODE_TYPES.ImportSpecifier && (specifier as TSESTree.ImportSpecifier).imported.name === option.imported) !== undefined;
if (option.imported === option.local) {
if (hasCorrectAliasedImport) {
context.report({
messageId: Message.MULTIPLE_ALIASES,
data: { local: option.local },
node: node,
fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
if (hasAliasedImport) { const commaAfter = context.sourceCode.getTokenAfter(node, {
context.report({ filter: (token: TSESTree.Token) => token.value === ',',
messageId: Message.MULTIPLE_ALIASES, });
data: { local: option.local }, if (commaAfter) {
node: node, fixes.push(fixer.removeRange([node.range[0], commaAfter.range[1]]));
fix(fixer: TSESLint.RuleFixer) { } else {
const fixes: TSESLint.RuleFix[] = []; fixes.push(fixer.remove(node));
}
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local));
const commaAfter = context.sourceCode.getTokenAfter(node, { return fixes;
filter: (token: TSESTree.Token) => token.value === ',', },
}); });
if (commaAfter) { } else {
fixes.push(fixer.removeRange([node.range[0], commaAfter.range[1]])); context.report({
} else { messageId: Message.UNNECESSARY_ALIAS,
fixes.push(fixer.remove(node)); data: { local: option.local },
} node: node,
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local)); fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
return fixes; fixes.push(fixer.replaceText(node, option.imported));
}, fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local));
});
} else if (node.local.name === node.imported.name) {
context.report({
messageId: Message.NO_ALIAS,
node: node,
fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
fixes.push(fixer.replaceText(node.local, `${option.imported} as ${option.local}`)); return fixes;
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local)); },
});
return fixes; }
},
});
} else { } else {
context.report({ if (hasCorrectAliasedImport) {
messageId: Message.WRONG_ALIAS, context.report({
data: { local: option.local }, messageId: Message.MULTIPLE_ALIASES,
node: node, data: { local: option.local },
fix(fixer: TSESLint.RuleFixer) { node: node,
const fixes: TSESLint.RuleFix[] = []; fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
fixes.push(fixer.replaceText(node.local, option.local)); const commaAfter = context.sourceCode.getTokenAfter(node, {
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local)); filter: (token: TSESTree.Token) => token.value === ',',
});
if (commaAfter) {
fixes.push(fixer.removeRange([node.range[0], commaAfter.range[1]]));
} else {
fixes.push(fixer.remove(node));
}
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local));
return fixes; return fixes;
}, },
}); });
} else if (node.local.name === node.imported.name) {
context.report({
messageId: Message.MISSING_ALIAS,
node: node,
fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
fixes.push(fixer.replaceText(node.local, `${option.imported} as ${option.local}`));
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local));
return fixes;
},
});
} else {
context.report({
messageId: Message.WRONG_ALIAS,
data: { local: option.local },
node: node,
fix(fixer: TSESLint.RuleFixer) {
const fixes: TSESLint.RuleFix[] = [];
fixes.push(fixer.replaceText(node.local, option.local));
fixes.push(...retrieveUsageReplacementFixes(context, fixer, node, option.local));
return fixes;
},
});
}
} }
} }

View File

@@ -24,6 +24,13 @@ Filename: `<%- test.filename %>`
```<%- plugin.language.toLowerCase() %> ```<%- plugin.language.toLowerCase() %>
<%- test.code.trim() %> <%- test.code.trim() %>
``` ```
<% if (test?.options?.length > 0) { %>
With options:
```json
<%- JSON.stringify(test.options[0], null, 2) %>
```
<% }%>
<% }) %> <% }) %>
<% } %> <% } %>
@@ -36,6 +43,15 @@ Filename: `<%- test.filename %>`
<% } %> <% } %>
```<%- plugin.language.toLowerCase() %> ```<%- plugin.language.toLowerCase() %>
<%- test.code.trim() %> <%- test.code.trim() %>
<% if (test?.options?.length > 0) { %>
With options:
```json
<%- JSON.stringify(test.options[0], null, 2) %>
```
<% }%>
``` ```
Will produce the following error(s): Will produce the following error(s):
``` ```