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

Internal (find-and-replace): Bulk find and replace utils into plugin #13226

Merged
merged 1 commit into from
Jan 13, 2023

Conversation

kbinieda
Copy link
Contributor

@kbinieda kbinieda commented Jan 8, 2023

Suggested merge commit message (convention)

Internal (find-and-replace): Bulk find and replace utils into plugin. Closes #13225.

@kbinieda kbinieda requested a review from scofalik January 8, 2023 11:15
Copy link
Contributor

@scofalik scofalik left a comment

Choose a reason for hiding this comment

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

We did analogical changes in documents lists utils, but now I am having some doubts.

First, the tests... Added only for code coverage purposes, OTOH, may do more harm than good in future (the tests don't even check if the "aliased" function is called, because it is not possible to spy/stub them).

Second, docs duplication. In documents lists, the original utils functions are marked as protected so at the very least they are not displayed in docs by default. Another idea would be to use @see tag.

However, after some time, I think it was a better idea to move the whole code to the plugin. It is only a bit more effort but the result, I believe will be better. Let's do this for F+R and document lists (in a separate issue). For document lists it will not even be a breaking change because the utils were protected. For F+R we can consider marking this a minor breaking change but given how niche these utils are, I'd even skip that.

Copy link
Contributor

@scofalik scofalik left a comment

Choose a reason for hiding this comment

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

Please squash commits and rename test file to findandreplaceutils.js so it matches the source file and it will be ready for merge.

@kbinieda kbinieda force-pushed the ck/13225-find-and-replace-utils branch from 359b431 to 0c37667 Compare January 13, 2023 08:03
@scofalik scofalik merged commit e2cf011 into master Jan 13, 2023
@scofalik scofalik deleted the ck/13225-find-and-replace-utils branch January 13, 2023 15:57
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.

Make plugin out of find and replace utils functions
2 participants