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

change: [M3-8552] - eslint - mark formik as deprecated #10944

Merged
merged 5 commits into from
Sep 17, 2024

Conversation

abailly-akamai
Copy link
Contributor

@abailly-akamai abailly-akamai commented Sep 16, 2024

Description 📝

See linode/eslint-plugin-cloud-manager#6 for details about the new plugin

Changes 🔄

  • bump @linode/eslint-plugin-cloud-manager to ^0.0.4
  • Update documentation

Preview 📷

Screenshot 2024-09-16 at 11 00 10

Screenshot 2024-09-16 at 11 00 01

How to test 🧪

Verification steps

  • Pull code locally, restart eslint in your IDE (or restart IDE) and confirm formik is now shown as deprecated
  • run yarn docs and verify the new "Composition" section of our developer documentation

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@abailly-akamai abailly-akamai self-assigned this Sep 16, 2024
@abailly-akamai abailly-akamai marked this pull request as ready for review September 16, 2024 16:50
@abailly-akamai abailly-akamai requested a review from a team as a code owner September 16, 2024 16:50
@abailly-akamai abailly-akamai requested review from bnussman-akamai and coliu-akamai and removed request for a team September 16, 2024 16:50
Copy link

github-actions bot commented Sep 16, 2024

Coverage Report:
Base Coverage: 86.7%
Current Coverage: 86.7%

Copy link
Contributor

@coliu-akamai coliu-akamai left a comment

Choose a reason for hiding this comment

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

✅ confirmed formik shown as deprecated
👀 confirmed composition section in the docs, but it shows up as 'Page Composition':
image
(we could also change Api to API 👀)

left a few small suggestions but lowkey lemme double check on the grammar 😓 (and lemme @mjac0bs 😆 🙏 )

docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

@coliu-akamai is the latest Hawkeye! 👁️ 🥇

docs/development-guide/15-page-composition.md Outdated Show resolved Hide resolved
@abailly-akamai
Copy link
Contributor Author

@mjac0bs @coliu-akamai thanks for the attention to copy details!

Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

Thank you for doing this, @abailly-akamai, and thanks for the great docs!

My only additional thought was: would it be useful to update the linter warning message to include a link the Form Composition section of the docs? If users are trying to use Formik, their next question might be: what are the patterns for RHF?

@mjac0bs mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Sep 17, 2024
Copy link
Contributor

@coliu-akamai coliu-akamai left a comment

Choose a reason for hiding this comment

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

Thanks Alban! 🎉

@coliu-akamai coliu-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! labels Sep 17, 2024
@abailly-akamai
Copy link
Contributor Author

My only additional thought was: would it be useful to update the linter warning message to include a link the Form Composition section of the docs? If users are trying to use Formik, their next question might be: what are the patterns for RHF?

oops, I missed this one. I think that's a worthwhile update. will add before merging - thx for the suggestion @mjac0bs

@abailly-akamai abailly-akamai merged commit df32f28 into linode:develop Sep 17, 2024
19 of 20 checks passed
nikhagra-akamai pushed a commit to nikhagra-akamai/manager that referenced this pull request Sep 23, 2024
* initial commit: eslintrc rule

* use eslint-plugin-cloud-manager

* Documentation

* Added changeset: Mark formik as deprecated

* feedback @coliu-akamai
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Multiple approvals and ready to merge!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants