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

PRO-2340 Renames methods #11

Merged
merged 1 commit into from
Dec 7, 2021
Merged

PRO-2340 Renames methods #11

merged 1 commit into from
Dec 7, 2021

Conversation

abea
Copy link
Contributor

@abea abea commented Nov 30, 2021

This renames export methods so they are not likely to conflict with project-level code or other module code. This is a risk since the exporter module "improves" piece type modules.

@abea abea requested a review from ValJed November 30, 2021 22:16
@abea abea self-assigned this Nov 30, 2021
@linear
Copy link

linear bot commented Nov 30, 2021

PRO-2340 Exporter methods & handlers should be renamed with 'export' prefix before stable release

The methods:

https://github.com/apostrophecms/piece-type-exporter/blob/main/lib/export.js

Contain a lot of names not prefixed with export which invites conflict with piece-type core or project level subclasses. Our policy when writing improve modules has been to prefix throughout, i.e. exportCleanup not just cleanup, because we are running the risk of introducing unnecessary incompatibilities with project level or core code.

This is something we need to do before declaring this module stable.

I gave Val an equivalent note on a current PR for the importer.

@abea abea merged commit 94d7280 into main Dec 7, 2021
@abea abea deleted the PRO-2340-renaming branch December 7, 2021 17:54
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.

2 participants