Skip to content

no-system-props: Always ignore size prop #31

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 3 commits into from
Feb 17, 2022
Merged

no-system-props: Always ignore size prop #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e68db9
Always ignore size prop
colebemis Feb 17, 2022
a64413a
Create tender-humans-rest.md
colebemis Feb 17, 2022
d2e7495
Update no-system-props.test.js
colebemis Feb 17, 2022
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/tender-humans-rest.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
---

`no-system-props`: Always ignore `size` prop
3 changes: 2 additions & 1 deletion src/rules/__tests__/no-system-props.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ ruleTester.run('no-system-props', rule, {
`import {Box} from '@primer/react'; <Box width={200} />`,
`import {ProgressBar} from '@primer/react'; <ProgressBar bg="howdy" />`,
`import {Button} from '@primer/react'; <Button {...someExpression()} />`,
`import {Button} from '@primer/react'; <Button variant="large" />`
`import {Button} from '@primer/react'; <Button variant="large" />`,
`import {Button} from '@primer/react'; <Button size="large" />`,
],
invalid: [
{
Expand Down
5 changes: 1 addition & 4 deletions src/rules/no-system-props.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,12 @@ const utilityComponents = new Set(['Box', 'Text'])
// Components for which we allow a set of prop names
const excludedComponentProps = new Map([
['AnchoredOverlay', new Set(['width', 'height'])],
['Avatar', new Set(['size'])],
['Dialog', new Set(['width', 'height'])],
['ProgressBar', new Set(['bg'])],
['Spinner', new Set(['size'])],
['StyledOcticon', new Set(['size'])],
['PointerBox', new Set(['bg'])]
])

const alwaysExcludedProps = new Set(['variant'])
const alwaysExcludedProps = new Set(['variant', 'size'])

module.exports = {
meta: {
Expand Down