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

Added a DeprecatedTags check #50

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Conversation

haribshahbaz
Copy link
Contributor

@haribshahbaz haribshahbaz commented Aug 29, 2023

Resolves https://github.com/Shopify/theme-check-js/issues/47

What are you adding in this PR?

This PR is adding a DeprecatedTags check (for more context on why I took this approach, please read this comment). Under the deprecated tags check, we can add specific cases to deprecated tags that we would like to check for. This PR adds the ConvertIncludeToRender check which essentially converts a liquid tag that uses include to use render as include is deprecated.

What's next? Any followup issues?

If we need to check for any other deprecated tags, it should be written under this check as a specific case.

TopHat Screenshots

Screenshot 2023-08-29 at 2 29 29 PM Screenshot 2023-08-29 at 2 29 46 PM Screenshot 2023-08-29 at 2 30 03 PM

Before you deploy

  • This PR includes a new checks
    • I included a minor bump changeset
    • It's in the allChecks array in src/checks/index.ts
    • I ran yarn update-configs and committed the updated configuration files

@haribshahbaz haribshahbaz changed the title Completed ConvertIncludeToRender check Added a DeprecatedTags check Aug 29, 2023
@haribshahbaz haribshahbaz marked this pull request as ready for review August 29, 2023 23:51
'@shopify/theme-check-docs-updater': minor
---

Add `DeprecatedTags` check
Copy link
Contributor

Choose a reason for hiding this comment

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

Glad to see this working for ya now!

albchu
albchu previously requested changes Aug 30, 2023
Copy link
Contributor

@albchu albchu left a comment

Choose a reason for hiding this comment

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

Once you add the doc url here, we can get this merged. All other code changes LGTM.

Then you'd just need to do the fast follow task. Lemme know if you need help setting that up.

meta: {
code: 'DeprecatedTags',
name: 'Deprecated Tags',
docs: {
Copy link
Contributor

Choose a reason for hiding this comment

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

For the doc url, may we add: https://shopify.dev/docs/themes/tools/theme-check/checks/deprecated-tags here?

As a fast followup, you will also need to do some light housekeeping on the dev docs.

Basically what we need is:

  • convert-include-to-render docs copied for a new link address https://shopify.dev/docs/themes/tools/theme-check/checks/deprecated-tags with light modifications.
  • The old convert-include-to-render docs should get a new banner saying that the check has been migrated to typescript as deprecated-tags (with a link to the new documentation)

@albchu albchu dismissed their stale review August 31, 2023 16:16

Spoke with Harib and he would like to wait on some followup input from CP regarding some bonus objectives for this change.

@haribshahbaz
Copy link
Contributor Author

haribshahbaz commented Sep 5, 2023

Spoke to CP regarding the bonus requirements for this check. He mentioned it being overly complicated at the moment, and that we would get back to it when time permits.

@haribshahbaz haribshahbaz merged commit cbea119 into main Sep 7, 2023
8 checks passed
@haribshahbaz haribshahbaz deleted the convert-include-to-render branch September 7, 2023 17:42
@shopify-shipit shopify-shipit bot temporarily deployed to production September 22, 2023 15:54 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants