Enhance `import-style` rule with auto-fix capability #2528

CasperEngl · 2025-01-17T14:54:36Z

Updated the import-style rule to include an autoFix option, allowing automatic fixing of import styles.
Modified the rule's documentation to reflect the new autoFix feature and its default behavior.
Added test cases to verify the functionality of the new auto-fix feature for various import scenarios.

This change improves usability by enabling automatic corrections for import style violations.

This fixes #963

rules/import-style.js

fisker · 2025-01-22T11:13:49Z

Can you try to reduce the diff? It's hard to see what's the change.

CasperEngl · 2025-01-23T01:07:43Z

I reverted a lot of changes (by using new commits), and now the diff looks much nicer. Let me know what you think!

rules/import-style.js

- Updated the `import-style` rule to include an `autoFix` option, allowing automatic fixing of import styles. - Modified the rule's documentation to reflect the new `autoFix` feature and its default behavior. - Added test cases to verify the functionality of the new auto-fix feature for various import scenarios. This change improves usability by enabling automatic corrections for import style violations.

…mentation - Removed the `autoFix` option from the `import-style` rule, simplifying its configuration. - Updated the documentation to reflect the removal of the `autoFix` feature. - Adjusted test cases to align with the new rule behavior, ensuring accurate error reporting without automatic fixes. This change streamlines the rule's functionality and clarifies its usage for developers.

… coverage - Refactored the `import-style` rule to better handle namespace imports, allowing for more flexible import declarations and `require` statements. - Introduced special cases for common libraries to automatically determine namespace identifiers. - Expanded test cases to cover a wide range of scenarios for namespace imports, ensuring accurate error reporting and compliance with the updated rule behavior. This update enhances the usability of the `import-style` rule by providing clearer guidelines for namespace imports and improving the overall robustness of the linting process.

…cases tests

…sions

…es has 'namespace' and does not have 'named'.

fisker · 2025-01-24T02:51:53Z

rules/import-style.js

+			// Skip rest patterns since they should be kept as is
+			if (importedName === undefined) {
+				continue;
+			}


Please help me understand this. Since you turn the VariableDeclarator into an identifier, so the RestElement just removed?

fisker · 2025-01-24T02:53:32Z

rules/import-style.js

+			const references = getAllReferences(programScope);
+
+			for (const reference of references) {
+				yield fixer.replaceText(reference.identifier, `${uniqueNamespaceIdentifier}.${importedName}`);


This is not the current fix.

import {bar} from 'foo' a = {bar}

will fix to

import foo from 'foo' a = {foo.bar} // Syntax error

You can use the existing renameVariable utility.

fisker · 2025-01-24T02:55:25Z

rules/import-style.js

+
+			const programScope = sourceCode.getScope(sourceCode.ast);
+
+			const getAllReferences = scope => {


This part should use sourceCode.getDeclaredVariables() to get variable from the ImportDeclaration and then we have all the references. Including child scopes.

consistent-assert has similar logic, you can take a look. https://github.com/sindresorhus/eslint-plugin-unicorn/pull/2535/files

fisker · 2025-01-24T02:57:53Z

rules/import-style.js

+				localName: specifier.local.name,
+				importedName: specifier.type === 'ImportDefaultSpecifier' ? 'default' : specifier.imported.name,
+			}));
+	} else if (node.type === 'VariableDeclarator' && node.id.type === 'ObjectPattern') {


I think we can focus on imports, leave require() alone, ESM should be preferred.

Yes, we no longer plan to handle anything CommonJS.

CasperEngl force-pushed the fix-import-style-autofix branch from 2162322 to d332fe4 Compare January 17, 2025 15:07

fisker reviewed Jan 17, 2025

View reviewed changes