Skip to content

Rename plugin to "Inline Glossary by Progress Planner" and reprefix to inline_glossary#55

Open
tacoverdo wants to merge 1 commit into
developfrom
rename/inline-glossary
Open

Rename plugin to "Inline Glossary by Progress Planner" and reprefix to inline_glossary#55
tacoverdo wants to merge 1 commit into
developfrom
rename/inline-glossary

Conversation

@tacoverdo

Copy link
Copy Markdown
Contributor

Prepares the plugin for its WordPress.org release by changing the slug, all identifier prefixes, and the public display name.

Display name

GlossaryInline Glossary by Progress Planner (plugin header, readme.txt title, README.md, phpcs project name).

Identifier renames (all four casing/separator forms)

Form Old New Covers
Namespace / classes PP_Glossary Inline_Glossary 9 classes, autoloader, @package
Constants PP_GLOSSARY_ INLINE_GLOSSARY_ *_VERSION, *_PLUGIN_DIR, *_PLUGIN_URL
Snake case pp_glossary inline_glossary functions, post type, option *_settings, meta _*_data, filters, field/nonce ids
Hyphen case pp-glossary inline-glossary text domain, script/style handles, CSS classes, HTML ids, block name inline-glossary/glossary-list

Main file renamed: pp-glossary.phpinline-glossary.php.

Deliberately left unchanged

  • --glossary-* CSS custom properties — they use a glossary prefix, not pp_glossary, so they're outside the scope of this rename and changing them is unnecessary.

  • CPT admin menu label (Glossary) — that's UI copy, not an identifier.

  • External URLs that a code change can't actually rename, kept pointing at the real resources:

    • GitHub Plugin URIgithub.com/progressplanner/pp-glossary
    • Two changelog issue links → github.com/ProgressPlanner/pp-glossary/issues/...
    • Blueprint import → progressplanner.com/research/pp-glossary.xml

    If/when the GitHub repo and that hosted XML are renamed, update these four references in a follow-up.

⚠️ Data migration note

The post type (inline_glossary), post meta key (_inline_glossary_data), and option (inline_glossary_settings) are stored in the database. Any existing install on the old identifiers will orphan its data on upgrade. This is fine for the pre-.org-release rebrand (no .org users yet), but any test/staging site with real entries needs a data migration before activating this build. No user-facing changelog entry was added since no version has shipped to .org and there's nothing for an end user to act on.

Verification

composer lint, composer phpstan, and composer check-cs all pass.

🤖 Generated with Claude Code

…o inline_glossary

Prepares the plugin for its WordPress.org release by changing the slug and all
identifier prefixes, and updating the display name.

Identifier changes (all forms):
- Namespace/classes:  PP_Glossary  -> Inline_Glossary
- Constants:          PP_GLOSSARY_ -> INLINE_GLOSSARY_
- Functions/CPT/meta/options/hooks/ids: pp_glossary -> inline_glossary
- Text domain, handles, CSS classes, block name, HTML ids: pp-glossary -> inline-glossary
- Main file renamed:  pp-glossary.php -> inline-glossary.php
- Display name:       "Glossary" -> "Inline Glossary by Progress Planner"

Deliberately left unchanged:
- The --glossary-* CSS custom properties (not part of the pp_glossary prefix).
- The CPT admin menu label ("Glossary").
- External URLs pointing at existing resources that a code change cannot rename:
  the GitHub repo (progressplanner/pp-glossary), the two changelog issue links,
  and the hosted blueprint import (research/pp-glossary.xml).

Verified: composer lint, composer phpstan, and composer check-cs all pass.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ilicfilip

Copy link
Copy Markdown
Contributor

@tacoverdo , do we want to migrate the data for the existing installs: #56 ?

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