Skip to content
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.

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

[LOOM-1341]: update eslint-config-skyscanner@18 & include forbid rule #3343

Merged
merged 10 commits into from
Apr 11, 2024

Conversation

mungodewar
Copy link
Contributor

@mungodewar mungodewar commented Apr 9, 2024

Tasks:

  • add forbid-props rule and inline ignore className usage with TODO statement to be removed in future work

Changes:

  • Refactored commonButtonTests into an actual test that imports different buttons, rather than exporting a test helper that was used in each button test suite. This was because we have a *test* regex and commonButtonTests wasn't matching this. It was an unusual pattern of testing and I thought it cleaner to remove it and have a single place for testing the common tests for Button instead.

Remember to include the following changes:

  • Ensure the PR title includes the name of the component you are changing so it's clear in the release notes for consumers of the changes in the version e.g [KOA-123][BpkButton] Updating the colour
  • README.md (If you have created a new component)
  • Component README.md
  • Tests
  • Storybook examples created/updated
  • Type declaration (.d.ts) files updated
  • For breaking changes or deprecating components/properties, migration guides added to the description of the PR. If the guide has large changes, consider creating a new Markdown page inside the component's docs folder and link it here

@mungodewar mungodewar added the patch Patch production bug label Apr 9, 2024
Copy link

github-actions bot commented Apr 9, 2024

Warnings
⚠️

Package source files (e.g. packages/package-name/src/Component.tsx) were updated, but type files weren't. Have you checked that no types have changed?

Browser support

If this is a visual change, make sure you've tested it in multiple browsers.

Generated by 🚫 dangerJS against a9b08b3

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

@mungodewar mungodewar changed the title update linter and --fix [LOOM-1341]: update linter and --fix Apr 9, 2024
},
"overrides": [
{
"files": ["*test*", "*examples*"],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We want to continue using Bpk components within our tests and examples as our consumers are, so we are not interested in disallowing className usage there.

@@ -0,0 +1,96 @@
### Avoid className props
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Docs basically ripped from banana

Copy link

github-actions bot commented Apr 9, 2024

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

@mungodewar mungodewar changed the title [LOOM-1341]: update linter and --fix [LOOM-1341]: update eslint-config-skyscanner@18 & include forbid rule Apr 10, 2024
@mungodewar mungodewar marked this pull request as ready for review April 10, 2024 14:33
Copy link

Visit https://backpack.github.io/storybook-prs/3343 to see this build running in a browser.

Copy link
Contributor

@metalix2 metalix2 left a comment

Choose a reason for hiding this comment

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

Looks fine to me 👍

@mungodewar mungodewar merged commit e1d0e51 into main Apr 11, 2024
9 checks passed
@mungodewar mungodewar deleted the loom-1341 branch April 11, 2024 15:00
FireRedNinja pushed a commit that referenced this pull request Apr 15, 2024
…#3343)

* update linter and --fix

* update ts-expect-error lines

* update ts-expect-error lines

* inline ignore className usage

* add missing snaps

* align all comments to the same TODO

* remove unused comments

* lock file update
KathyWang0208 pushed a commit that referenced this pull request May 27, 2024
…#3343)

* update linter and --fix

* update ts-expect-error lines

* update ts-expect-error lines

* inline ignore className usage

* add missing snaps

* align all comments to the same TODO

* remove unused comments

* lock file update
KathyWang0208 pushed a commit that referenced this pull request May 27, 2024
…#3343)

* update linter and --fix

* update ts-expect-error lines

* update ts-expect-error lines

* inline ignore className usage

* add missing snaps

* align all comments to the same TODO

* remove unused comments

* lock file update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Patch production bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants