feat(eslint-plugin-import): implement import/no-self-import rule (#215)

Author: colinaaa

cmd/rslint/api.go

@@ -17,57 +17,6 @@ import (
 	rslintconfig "github.com/web-infra-dev/rslint/internal/config"
 	"github.com/web-infra-dev/rslint/internal/linter"
 	"github.com/web-infra-dev/rslint/internal/rule"
-	"github.com/web-infra-dev/rslint/internal/rules/adjacent_overload_signatures"
-	"github.com/web-infra-dev/rslint/internal/rules/array_type"
-	"github.com/web-infra-dev/rslint/internal/rules/await_thenable"
-	"github.com/web-infra-dev/rslint/internal/rules/class_literal_property_style"
-	"github.com/web-infra-dev/rslint/internal/rules/no_array_delete"
-	"github.com/web-infra-dev/rslint/internal/rules/no_base_to_string"
-	"github.com/web-infra-dev/rslint/internal/rules/no_confusing_void_expression"
-	"github.com/web-infra-dev/rslint/internal/rules/no_duplicate_type_constituents"
-	"github.com/web-infra-dev/rslint/internal/rules/no_empty_function"
-	"github.com/web-infra-dev/rslint/internal/rules/no_empty_interface"
-	"github.com/web-infra-dev/rslint/internal/rules/no_floating_promises"
-	"github.com/web-infra-dev/rslint/internal/rules/no_for_in_array"
-	"github.com/web-infra-dev/rslint/internal/rules/no_implied_eval"
-	"github.com/web-infra-dev/rslint/internal/rules/no_meaningless_void_operator"
-	"github.com/web-infra-dev/rslint/internal/rules/no_misused_promises"
-	"github.com/web-infra-dev/rslint/internal/rules/no_misused_spread"
-	"github.com/web-infra-dev/rslint/internal/rules/no_mixed_enums"
-	"github.com/web-infra-dev/rslint/internal/rules/no_namespace"
-	"github.com/web-infra-dev/rslint/internal/rules/no_redundant_type_constituents"
-	"github.com/web-infra-dev/rslint/internal/rules/no_require_imports"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unnecessary_boolean_literal_compare"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unnecessary_template_expression"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unnecessary_type_arguments"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unnecessary_type_assertion"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_argument"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_assignment"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_call"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_enum_comparison"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_member_access"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_return"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_type_assertion"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unsafe_unary_minus"
-	"github.com/web-infra-dev/rslint/internal/rules/no_unused_vars"
-	"github.com/web-infra-dev/rslint/internal/rules/no_useless_empty_export"
-	"github.com/web-infra-dev/rslint/internal/rules/no_var_requires"
-	"github.com/web-infra-dev/rslint/internal/rules/non_nullable_type_assertion_style"
-	"github.com/web-infra-dev/rslint/internal/rules/only_throw_error"
-	"github.com/web-infra-dev/rslint/internal/rules/prefer_as_const"
-	"github.com/web-infra-dev/rslint/internal/rules/prefer_promise_reject_errors"
-	"github.com/web-infra-dev/rslint/internal/rules/prefer_reduce_type_parameter"
-	"github.com/web-infra-dev/rslint/internal/rules/prefer_return_this_type"
-	"github.com/web-infra-dev/rslint/internal/rules/promise_function_async"
-	"github.com/web-infra-dev/rslint/internal/rules/related_getter_setter_pairs"
-	"github.com/web-infra-dev/rslint/internal/rules/require_array_sort_compare"
-	"github.com/web-infra-dev/rslint/internal/rules/require_await"
-	"github.com/web-infra-dev/rslint/internal/rules/restrict_plus_operands"
-	"github.com/web-infra-dev/rslint/internal/rules/restrict_template_expressions"
-	"github.com/web-infra-dev/rslint/internal/rules/return_await"
-	"github.com/web-infra-dev/rslint/internal/rules/switch_exhaustiveness_check"
-	"github.com/web-infra-dev/rslint/internal/rules/unbound_method"
-	"github.com/web-infra-dev/rslint/internal/rules/use_unknown_in_catch_callback_variable"
 	"github.com/web-infra-dev/rslint/internal/utils"
 )
 
@@ -107,73 +56,19 @@ func (h *IPCHandler) HandleLint(req api.LintRequest) (*api.LintResponse, error)
 	}
 
 	// Initialize rule registry with all available rules
-	rslintconfig.RegisterAllTypeScriptEslintPluginRules()
+	rslintconfig.RegisterAllRules()
 
 	// Load rslint configuration and determine which tsconfig files to use
 	_, tsConfigs, configDirectory := rslintconfig.LoadConfigurationWithFallback(req.Config, currentDirectory, fs)
 
-	// Create rules
-	var origin_rules = []rule.Rule{
-		adjacent_overload_signatures.AdjacentOverloadSignaturesRule,
-		array_type.ArrayTypeRule,
-		await_thenable.AwaitThenableRule,
-		class_literal_property_style.ClassLiteralPropertyStyleRule,
-		no_array_delete.NoArrayDeleteRule,
-		no_base_to_string.NoBaseToStringRule,
-		no_confusing_void_expression.NoConfusingVoidExpressionRule,
-		no_duplicate_type_constituents.NoDuplicateTypeConstituentsRule,
-		no_empty_function.NoEmptyFunctionRule,
-		no_empty_interface.NoEmptyInterfaceRule,
-		no_floating_promises.NoFloatingPromisesRule,
-		no_for_in_array.NoForInArrayRule,
-		no_implied_eval.NoImpliedEvalRule,
-		no_meaningless_void_operator.NoMeaninglessVoidOperatorRule,
-		no_misused_promises.NoMisusedPromisesRule,
-		no_misused_spread.NoMisusedSpreadRule,
-		no_mixed_enums.NoMixedEnumsRule,
-		no_namespace.NoNamespaceRule,
-		no_redundant_type_constituents.NoRedundantTypeConstituentsRule,
-		no_require_imports.NoRequireImportsRule,
-		no_unnecessary_boolean_literal_compare.NoUnnecessaryBooleanLiteralCompareRule,
-		no_unnecessary_template_expression.NoUnnecessaryTemplateExpressionRule,
-		no_unnecessary_type_arguments.NoUnnecessaryTypeArgumentsRule,
-		no_unnecessary_type_assertion.NoUnnecessaryTypeAssertionRule,
-		no_unsafe_argument.NoUnsafeArgumentRule,
-		no_unsafe_assignment.NoUnsafeAssignmentRule,
-		no_unsafe_call.NoUnsafeCallRule,
-		no_unsafe_enum_comparison.NoUnsafeEnumComparisonRule,
-		no_unsafe_member_access.NoUnsafeMemberAccessRule,
-		no_unsafe_return.NoUnsafeReturnRule,
-		no_unsafe_type_assertion.NoUnsafeTypeAssertionRule,
-		no_unsafe_unary_minus.NoUnsafeUnaryMinusRule,
-		no_unused_vars.NoUnusedVarsRule,
-		no_useless_empty_export.NoUselessEmptyExportRule,
-		no_var_requires.NoVarRequiresRule,
-		non_nullable_type_assertion_style.NonNullableTypeAssertionStyleRule,
-		only_throw_error.OnlyThrowErrorRule,
-		prefer_as_const.PreferAsConstRule,
-		prefer_promise_reject_errors.PreferPromiseRejectErrorsRule,
-		prefer_reduce_type_parameter.PreferReduceTypeParameterRule,
-		prefer_return_this_type.PreferReturnThisTypeRule,
-		promise_function_async.PromiseFunctionAsyncRule,
-		related_getter_setter_pairs.RelatedGetterSetterPairsRule,
-		require_array_sort_compare.RequireArraySortCompareRule,
-		require_await.RequireAwaitRule,
-		restrict_plus_operands.RestrictPlusOperandsRule,
-		restrict_template_expressions.RestrictTemplateExpressionsRule,
-		return_await.ReturnAwaitRule,
-		switch_exhaustiveness_check.SwitchExhaustivenessCheckRule,
-		unbound_method.UnboundMethodRule,
-		use_unknown_in_catch_callback_variable.UseUnknownInCatchCallbackVariableRule,
-	}
 	type RuleWithOption struct {
 		rule   rule.Rule
 		option interface{}
 	}
 	rulesWithOptions := []RuleWithOption{}
 	// filter rule based on request.RuleOptions
 	if len(req.RuleOptions) > 0 {
-		for _, r := range origin_rules {
+		for _, r := range rslintconfig.GlobalRuleRegistry.GetAllRules() {
 			if option, ok := req.RuleOptions[r.Name]; ok {
 				rulesWithOptions = append(rulesWithOptions, RuleWithOption{
 					rule:   r,

cmd/rslint/cmd.go

@@ -408,7 +408,7 @@ func runCMD() int {
 	fs := bundled.WrapFS(cachedvfs.From(osvfs.FS()))
 
 	// Initialize rule registry with all available rules
-	rslintconfig.RegisterAllTypeScriptEslintPluginRules()
+	rslintconfig.RegisterAllRules()
 	var rslintConfig rslintconfig.RslintConfig
 	var tsConfigs []string
 	// Load rslint configuration and determine which rules to enable

cmd/rslint/lsp.go

@@ -247,7 +247,7 @@ func (s *LSPServer) runDiagnostics(ctx context.Context, uri lsproto.DocumentUri,
 	}
 
 	// Initialize rule registry with all available rules (ensure it's done once)
-	config.RegisterAllTypeScriptEslintPluginRules()
+	config.RegisterAllRules()
 
 	// Convert URI to file path
 	filePath := uriToPath(uriString)
@@ -496,7 +496,7 @@ func runLintWithPrograms(uri lsproto.DocumentUri, programs []*compiler.Program,
 	}
 
 	// Initialize rule registry with all available rules
-	config.RegisterAllTypeScriptEslintPluginRules()
+	config.RegisterAllRules()
 
 	// Collect diagnostics
 	var diagnostics []rule.RuleDiagnostic

internal/config/config.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/bmatcuk/doublestar/v4"
+	importPlugin "github.com/web-infra-dev/rslint/internal/plugins/import"
 	"github.com/web-infra-dev/rslint/internal/rule"
 	"github.com/web-infra-dev/rslint/internal/rules/adjacent_overload_signatures"
 	"github.com/web-infra-dev/rslint/internal/rules/array_type"
@@ -167,9 +168,14 @@ func (rc *RuleConfig) GetSeverity() rule.DiagnosticSeverity {
 	return rule.ParseSeverity(rc.Level)
 }
 func GetAllRulesForPlugin(plugin string) []rule.Rule {
-	if plugin == "@typescript-eslint" {
+	switch plugin {
+	case "@typescript-eslint":
 		return getAllTypeScriptEslintPluginRules()
-	} else {
+	case "eslint-plugin-import":
+		return importPlugin.GetAllRules()
+	case "eslint-plugin-import/recommended":
+		return importPlugin.GetRecommendedRules()
+	default:
 		return []rule.Rule{} // Return empty slice for unsupported plugins
 	}
 }
@@ -266,8 +272,13 @@ func (config RslintConfig) GetRulesForFile(filePath string) map[string]*RuleConf
 	return enabledRules
 }
 
-// RegisterAllTypeScriptEslintPluginRules registers all available rules in the global registry
-func RegisterAllTypeScriptEslintPluginRules() {
+func RegisterAllRules() {
+	registerAllTypeScriptEslintPluginRules()
+	registerAllEslintImportPluginRules()
+}
+
+// registerAllTypeScriptEslintPluginRules registers all available rules in the global registry
+func registerAllTypeScriptEslintPluginRules() {
 	GlobalRuleRegistry.Register("@typescript-eslint/adjacent-overload-signatures", adjacent_overload_signatures.AdjacentOverloadSignaturesRule)
 	GlobalRuleRegistry.Register("@typescript-eslint/array-type", array_type.ArrayTypeRule)
 	GlobalRuleRegistry.Register("@typescript-eslint/await-thenable", await_thenable.AwaitThenableRule)
@@ -321,6 +332,12 @@ func RegisterAllTypeScriptEslintPluginRules() {
 	GlobalRuleRegistry.Register("@typescript-eslint/use-unknown-in-catch-callback-variable", use_unknown_in_catch_callback_variable.UseUnknownInCatchCallbackVariableRule)
 }
 
+func registerAllEslintImportPluginRules() {
+	for _, rule := range importPlugin.GetAllRules() {
+		GlobalRuleRegistry.Register(rule.Name, rule)
+	}
+}
+
 // getAllTypeScriptEslintPluginRules returns all registered rules (for backward compatibility when no config is provided)
 func getAllTypeScriptEslintPluginRules() []rule.Rule {
 	allRules := GlobalRuleRegistry.GetAllRules()

internal/config/config_test.go

@@ -204,6 +204,46 @@ func TestGetRulesForFileWithIgnores(t *testing.T) {
 	}
 }
 
+func TestGetImportPluginRules(t *testing.T) {
+	baseConfig := ConfigEntry{
+		Language: "typescript",
+		Files:    []string{"**/*.ts", "**/*.tsx"},
+		Ignores:  []string{"**/*.test.ts", "node_modules/**"},
+		Rules:    Rules{},
+	}
+
+	tests := []struct {
+		rulesCount int
+		plugin     string
+	}{
+		{
+			rulesCount: 1,
+			plugin:     "eslint-plugin-import",
+		},
+		{
+			rulesCount: 0,
+			plugin:     "eslint-plugin-import/recommended",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.plugin, func(t *testing.T) {
+			config := RslintConfig{
+				baseConfig,
+				{
+					Plugins: []string{tt.plugin},
+				},
+			}
+			rules := config.GetRulesForFile("foo.ts")
+
+			if len(rules) != tt.rulesCount {
+				t.Errorf("GetRulesForFile(foo.ts) with plugin %v ruleCount = %v, expected %v (rules: %v)",
+					tt.plugin, len(rules), tt.rulesCount, rules)
+			}
+		})
+	}
+}
+
 func TestParseArrayRuleConfig(t *testing.T) {
 	tests := []struct {
 		name            string

internal/plugins/import/all.go

@@ -0,0 +1,12 @@
+package import_plugin
+
+import (
+	"github.com/web-infra-dev/rslint/internal/plugins/import/rules/no_self_import"
+	"github.com/web-infra-dev/rslint/internal/rule"
+)
+
+func GetAllRules() []rule.Rule {
+	return []rule.Rule{
+		no_self_import.NoSelfImportRule,
+	}
+}

internal/plugins/import/recommended.go

@@ -0,0 +1,9 @@
+package import_plugin
+
+import (
+	"github.com/web-infra-dev/rslint/internal/rule"
+)
+
+func GetRecommendedRules() []rule.Rule {
+	return []rule.Rule{}
+}

internal/plugins/import/rules/no_self_import/no_self_import.go

@@ -0,0 +1,34 @@
+package no_self_import
+
+import (
+	"github.com/microsoft/typescript-go/shim/ast"
+	"github.com/web-infra-dev/rslint/internal/plugins/import/utils"
+	"github.com/web-infra-dev/rslint/internal/rule"
+)
+
+// See: https://github.com/import-js/eslint-plugin-import/blob/01c9eb04331d2efa8d63f2d7f4bfec3bc44c94f3/src/rules/no-self-import.js
+var NoSelfImportRule = rule.Rule{
+	Name: "import/no-self-import",
+	Run: func(ctx rule.RuleContext, options any) rule.RuleListeners {
+		return utils.VisitModules(func(source, node *ast.Node) {
+			isImportingSelf(ctx, source, node)
+		}, utils.VisitModulesOptions{
+			Commonjs: true,
+			ESModule: true,
+		})
+	},
+}
+
+// https://github.com/import-js/eslint-plugin-import/blob/01c9eb04331d2efa8d63f2d7f4bfec3bc44c94f3/src/rules/no-self-import.js#L12-L22
+func isImportingSelf(ctx rule.RuleContext, source *ast.StringLiteralLike, node *ast.ImportSpecifierNode) {
+	filePath := utils.GetPhysicalFilename(ctx)
+
+	if resolvedPath, ok := utils.Resolve(source, ctx); ok {
+		if /** filePath != "<text>" && */ filePath == resolvedPath {
+			ctx.ReportNode(node, rule.RuleMessage{
+				Id:          "import/no-self-import",
+				Description: "Module imports itself.",
+			})
+		}
+	}
+}

internal/plugins/import/rules/no_self_import/no_self_import_test.go

@@ -0,0 +1,72 @@
+package no_self_import_test
+
+import (
+	"testing"
+
+	"github.com/web-infra-dev/rslint/internal/plugins/import/rules/no_self_import"
+	"github.com/web-infra-dev/rslint/internal/rule_tester"
+	"github.com/web-infra-dev/rslint/internal/rules/fixtures"
+)
+
+func TestNoSelfImportRule(t *testing.T) {
+	errors := make([]rule_tester.InvalidTestCaseError, 6)
+	for i, err := range errors {
+		err.MessageId = "import/no-self-import"
+		err.Line = i + 2
+		err.Column = 1
+		errors[i] = err
+	}
+
+	rule_tester.RunRuleTester(
+		fixtures.GetRootDir(),
+		"tsconfig.json",
+		t,
+		&no_self_import.NoSelfImportRule,
+		[]rule_tester.ValidTestCase{
+			{Code: `import { bar } from "./bar.ts"`, FileName: "foo.ts"},
+			{Code: `import { bar } from "./bar.json" with { type: "json" }`, FileName: "foo.ts"},
+			{Code: `require("./bar.ts")`, FileName: "foo.ts"},
+			{Code: `require()`, FileName: "foo.ts"},
+			{Code: `require(123)`, FileName: "foo.ts"},
+			{Code: `require("./foo.ts", 123)`, FileName: "foo.ts"},
+		},
+		[]rule_tester.InvalidTestCase{
+			{
+				Code: `
+import './foo.ts';
+import * as fooStar from './foo.ts';
+import fooDefault from './foo.ts';
+import { foo } from './foo.ts';
+import('./foo.ts');
+import('./foo.ts', { with: { type: 'module' } });
+`,
+				FileName: "foo.ts",
+				Errors:   errors,
+			},
+			{
+				Code: `
+import './foo.js';
+import * as fooStar from './foo.js';
+import fooDefault from './foo.js';
+import { foo } from './foo.js';
+import('./foo.js');
+import('./foo.js', { with: { type: 'module' } });
+`,
+				FileName: "foo.ts",
+				Errors:   errors,
+			},
+			{
+				Code: `
+import './foo';
+import * as fooStar from './foo';
+import fooDefault from './foo';
+import { foo } from './foo';
+import('./foo');
+import('./foo', { with: { type: 'module' } });
+`,
+				FileName: "foo.ts",
+				Errors:   errors,
+			},
+		},
+	)
+}