Adds new fixable lint rule to rewrite src/ imports

Author: eamodio

eslint.config.mjs

@@ -6,6 +6,7 @@ import antiTrojanSource from 'eslint-plugin-anti-trojan-source';
 import importX from 'eslint-plugin-import-x';
 import { configs as litConfigs } from 'eslint-plugin-lit';
 import { configs as wcConfigs } from 'eslint-plugin-wc';
+import noSrcImports from './scripts/eslint-rules/no-src-imports.js';
 
 export default ts.config(
 	js.configs.recommended,
@@ -20,8 +21,14 @@ export default ts.config(
 		plugins: {
 			'import-x': importX,
 			'anti-trojan-source': antiTrojanSource,
+			'@gitlens': {
+				rules: {
+					'no-src-imports': noSrcImports,
+				},
+			},
 		},
 		rules: {
+			'@gitlens/no-src-imports': 'error',
 			'anti-trojan-source/no-bidi': 'error',
 			curly: ['error', 'multi-line', 'consistent'],
 			eqeqeq: ['error', 'always', { null: 'ignore' }],
@@ -250,10 +257,6 @@ export default ts.config(
 							group: ['**/env/**/*'],
 							message: 'Use @env/ instead',
 						},
-						{
-							group: ['src/*'],
-							message: 'Use relative paths instead',
-						},
 						{
 							group: ['react-dom'],
 							importNames: ['Container'],
@@ -340,10 +343,6 @@ export default ts.config(
 				'error',
 				{
 					patterns: [
-						{
-							group: ['src/*'],
-							message: 'Use relative paths instead',
-						},
 						{
 							group: ['react-dom'],
 							importNames: ['Container'],
@@ -419,10 +418,6 @@ export default ts.config(
 				'error',
 				{
 					patterns: [
-						{
-							group: ['src/*'],
-							message: 'Use relative paths instead',
-						},
 						{
 							group: ['react-dom'],
 							importNames: ['Container'],

scripts/eslint-rules/no-src-imports.js

@@ -0,0 +1,32 @@
+const path = require('path');
+
+module.exports = {
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Disallow import statements that start with src/',
+			recommended: true,
+		},
+		fixable: 'code',
+		schema: [],
+	},
+	create(context) {
+		return {
+			ImportDeclaration(node) {
+				const importPath = node.source.value;
+				if (importPath.startsWith('src/')) {
+					context.report({
+						node,
+						message: 'Import from src/ should be rewritten to a relative path',
+						fix(fixer) {
+							const importPathAbsolute = path.resolve('.', importPath);
+							const relativePath = path.relative(path.dirname(context.getFilename()), importPathAbsolute);
+							const normalizedPath = path.normalize(relativePath).replace(/\\/g, '/');
+							return fixer.replaceText(node.source, `'${normalizedPath}'`);
+						},
+					});
+				}
+			},
+		};
+	},
+};