Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/breezy-insects-scream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'eslint-plugin-primer-react': minor
---

Add eslint rule for discouraging use of wildcard imports from @primer/react
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**/dist/**
**/node_modules/**
25 changes: 25 additions & 0 deletions docs/rules/no-wildcard-imports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# No Wildcard Imports

## Rule Details

This rule enforces that no wildcard imports are used from `@primer/react`.

👎 Examples of **incorrect** code for this rule

```jsx
import {Dialog} from '@primer/react/lib-esm/Dialog/Dialog'

function ExampleComponent() {
return <Dialog>{/* ... */}</Dialog>
}
```

👍 Examples of **correct** code for this rule:

```jsx
import {Dialog} from '@primer/react/experimental'

function ExampleComponent() {
return <Dialog>{/* ... */}</Dialog>
}
```
1 change: 1 addition & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module.exports = {
'a11y-remove-disable-tooltip': require('./rules/a11y-remove-disable-tooltip'),
'a11y-use-next-tooltip': require('./rules/a11y-use-next-tooltip'),
'use-deprecated-from-deprecated': require('./rules/use-deprecated-from-deprecated'),
'no-wildcard-imports': require('./rules/no-wildcard-imports'),
'no-unnecessary-components': require('./rules/no-unnecessary-components'),
'prefer-action-list-item-onselect': require('./rules/prefer-action-list-item-onselect'),
},
Expand Down
Loading