Skip to content

Fix for deprecated and experimental import paths #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

Fix for deprecated and experimental import paths #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64e3cbd
Fix for deprecated and experimental import paths
jonrohan Sep 12, 2025
0159ee3
Update eslint-plugin-primer-react import paths
jonrohan Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/cyan-carrots-boil.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"eslint-plugin-primer-react": patch
---

Fix for deprecated and experimental import paths
20 changes: 20 additions & 0 deletions src/rules/__tests__/use-styled-react-import.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,26 @@ ruleTester.run('use-styled-react-import', rule, {
],
},

// Invalid: Imports from /experimental and /deprecated paths
{
code: `import { Button } from '@primer/react/experimental'
import { Box } from '@primer/react/deprecated'
const Component = () => <Box sx={{ color: 'red' }}><Button sx={{ margin: 2 }}>Click me</Button></Box>`,
output: `import { Button } from '@primer/styled-react/experimental'
import { Box } from '@primer/styled-react/deprecated'
const Component = () => <Box sx={{ color: 'red' }}><Button sx={{ margin: 2 }}>Click me</Button></Box>`,
errors: [
{
messageId: 'useStyledReactImport',
data: {componentName: 'Button'},
},
{
messageId: 'useStyledReactImport',
data: {componentName: 'Box'},
},
],
},

// Invalid: ActionList.Item with sx prop and ActionList imported from @primer/react
{
code: `import { ActionList } from '@primer/react'
Expand Down
57 changes: 31 additions & 26 deletions src/rules/use-styled-react-import.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ module.exports = {
ImportDeclaration(node) {
const importSource = node.source.value

if (importSource === '@primer/react') {
// Track imports from @primer/react
if (importSource === '@primer/react' || importSource.startsWith('@primer/react/')) {
// Track imports from @primer/react and its subpaths
for (const specifier of node.specifiers) {
if (specifier.type === 'ImportSpecifier') {
const importedName = specifier.imported.name
Expand All @@ -98,16 +98,16 @@ module.exports = {
styledTypes.has(importedName) ||
styledUtilities.has(importedName)
) {
primerReactImports.set(importedName, {node, specifier})
primerReactImports.set(importedName, {node, specifier, importSource})
Copy link

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding a comment explaining why importSource is now stored in the import info object, as this change enables proper subpath handling in the fix functions.

Copilot uses AI. Check for mistakes.

}
}
}
} else if (importSource === '@primer/styled-react') {
// Track what's imported from styled-react
} else if (importSource === '@primer/styled-react' || importSource.startsWith('@primer/styled-react/')) {
// Track what's imported from styled-react and its subpaths
for (const specifier of node.specifiers) {
if (specifier.type === 'ImportSpecifier') {
const importedName = specifier.imported.name
styledReactImports.set(importedName, {node, specifier})
styledReactImports.set(importedName, {node, specifier, importSource})
}
}
}
Expand Down Expand Up @@ -167,7 +167,7 @@ module.exports = {
messageId: 'useStyledReactImport',
data: {componentName},
fix(fixer) {
const {node: importNode} = importInfo
const {node: importNode, importSource} = importInfo
const changes = importNodeChanges.get(importNode)

if (!changes) {
Expand All @@ -190,21 +190,24 @@ module.exports = {
return !componentsToMove.has(name)
})

// Convert @primer/react path to @primer/styled-react path
const styledReactPath = importSource.replace('@primer/react', '@primer/styled-react')

// If no components remain, replace with new import directly
if (remainingSpecifiers.length === 0) {
const movedComponents = changes.toMove.join(', ')
fixes.push(fixer.replaceText(importNode, `import { ${movedComponents} } from '@primer/styled-react'`))
fixes.push(fixer.replaceText(importNode, `import { ${movedComponents} } from '${styledReactPath}'`))
} else {
// Otherwise, update the import to only include remaining components
const remainingNames = remainingSpecifiers.map(spec => spec.imported.name)
fixes.push(
fixer.replaceText(importNode, `import { ${remainingNames.join(', ')} } from '@primer/react'`),
fixer.replaceText(importNode, `import { ${remainingNames.join(', ')} } from '${importSource}'`),
)

// Add new styled-react import
const movedComponents = changes.toMove.join(', ')
fixes.push(
fixer.insertTextAfter(importNode, `\nimport { ${movedComponents} } from '@primer/styled-react'`),
fixer.insertTextAfter(importNode, `\nimport { ${movedComponents} } from '${styledReactPath}'`),
)
}

Expand Down Expand Up @@ -250,7 +253,7 @@ module.exports = {
messageId: 'usePrimerReactImport',
data: {componentName},
fix(fixer) {
const {node: importNode} = importInfo
const {node: importNode, importSource} = importInfo
const changes = styledReactImportNodeChanges.get(importNode)

if (!changes) {
Expand All @@ -273,6 +276,9 @@ module.exports = {
return !componentsToMove.has(name)
})

// Convert @primer/styled-react path to @primer/react path
const primerReactPath = importSource.replace('@primer/styled-react', '@primer/react')

// Check if there's an existing primer-react import to merge with
const existingPrimerReactImport = Array.from(primerReactImportNodes)[0]

Expand All @@ -286,7 +292,7 @@ module.exports = {
fixes.push(
fixer.replaceText(
existingPrimerReactImport,
`import { ${newSpecifiers.join(', ')} } from '@primer/react'`,
`import { ${newSpecifiers.join(', ')} } from '${primerReactPath}'`,
),
)
fixes.push(fixer.remove(importNode))
Expand All @@ -300,33 +306,29 @@ module.exports = {
fixes.push(
fixer.replaceText(
existingPrimerReactImport,
`import { ${newSpecifiers.join(', ')} } from '@primer/react'`,
`import { ${newSpecifiers.join(', ')} } from '${primerReactPath}'`,
),
)

const remainingNames = remainingSpecifiers.map(spec => spec.imported.name)
fixes.push(
fixer.replaceText(
importNode,
`import { ${remainingNames.join(', ')} } from '@primer/styled-react'`,
),
fixer.replaceText(importNode, `import { ${remainingNames.join(', ')} } from '${importSource}'`),
)
} else if (remainingSpecifiers.length === 0) {
// Case: No existing primer-react import, no remaining styled-react imports
const movedComponents = changes.toMove.join(', ')
fixes.push(fixer.replaceText(importNode, `import { ${movedComponents} } from '@primer/react'`))
fixes.push(fixer.replaceText(importNode, `import { ${movedComponents} } from '${primerReactPath}'`))
} else {
// Case: No existing primer-react import, some styled-react imports remain
const remainingNames = remainingSpecifiers.map(spec => spec.imported.name)
fixes.push(
fixer.replaceText(
importNode,
`import { ${remainingNames.join(', ')} } from '@primer/styled-react'`,
),
fixer.replaceText(importNode, `import { ${remainingNames.join(', ')} } from '${importSource}'`),
)

const movedComponents = changes.toMove.join(', ')
fixes.push(fixer.insertTextAfter(importNode, `\nimport { ${movedComponents} } from '@primer/react'`))
fixes.push(
fixer.insertTextAfter(importNode, `\nimport { ${movedComponents} } from '${primerReactPath}'`),
)
}

return fixes
Expand All @@ -343,13 +345,16 @@ module.exports = {
messageId: 'moveToStyledReact',
data: {importName},
fix(fixer) {
const {node: importNode, specifier} = importInfo
const {node: importNode, specifier, importSource} = importInfo
const otherSpecifiers = importNode.specifiers.filter(s => s !== specifier)

// Convert @primer/react path to @primer/styled-react path
const styledReactPath = importSource.replace('@primer/react', '@primer/styled-react')

// If this is the only import, replace the whole import
if (otherSpecifiers.length === 0) {
const prefix = styledTypes.has(importName) ? 'type ' : ''
return fixer.replaceText(importNode, `import { ${prefix}${importName} } from '@primer/styled-react'`)
return fixer.replaceText(importNode, `import { ${prefix}${importName} } from '${styledReactPath}'`)
}

// Otherwise, remove from current import and add new import
Expand Down Expand Up @@ -377,7 +382,7 @@ module.exports = {
// Add new import
const prefix = styledTypes.has(importName) ? 'type ' : ''
fixes.push(
fixer.insertTextAfter(importNode, `\nimport { ${prefix}${importName} } from '@primer/styled-react'`),
fixer.insertTextAfter(importNode, `\nimport { ${prefix}${importName} } from '${styledReactPath}'`),
)

return fixes
Expand Down