Skip to content

Conversation

@imnasnainaec
Copy link
Contributor

@imnasnainaec imnasnainaec commented Jan 29, 2026

Resolves #3


This change is Reviewable

Summary by CodeRabbit

  • Chores
    • Rebranded extension to "Interlinearizer" — updated name, author, and publisher metadata and package info
    • Aligned internal type/module references and public type path to the new extension name
    • Added manifest entries for localized strings, themes, and activation events
  • Documentation
    • Updated README, descriptions, and display text to reflect Interlinearizer branding and messaging

✏️ Tip: You can customize this high-level summary in your review settings.

@imnasnainaec imnasnainaec self-assigned this Jan 29, 2026
@imnasnainaec imnasnainaec added the 🟨Medium Medium-priority PR label Jan 29, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 29, 2026

📝 Walkthrough

Walkthrough

The pull request renames the extension from "paranext-extension-template" to "interlinearizer" across config, docs, type declarations, and runtime log messages; updates publisher/author metadata; adds manifest entries for localizedStrings, themes, and activationEvents; and updates display and description assets.

Changes

Cohort / File(s) Summary
Configuration & Manifest
manifest.json, package.json
Renamed package/manifest name to interlinearizer; updated types path to src/types/interlinearizer.d.ts; changed publisher/author; added localizedStrings, themes, and activationEvents in manifest.
Documentation & Release
.github/assets/release-body.md, README.md, assets/descriptions/description-en.md
Replaced template references with Interlinearizer branding; updated README to reference new type path and revised descriptive text.
Display & Metadata
assets/displayData.json
Updated localized names/shortSummary to Interlinearizer; populated moreInfoUrl and supportUrl.
Type Definitions
src/types/interlinearizer.d.ts
Module declaration renamed from paranext-extension-template to interlinearizer.
Runtime
src/main.ts
Adjusted activation/deactivation log messages to reference Interlinearizer (no control-flow changes).
Tooling
cspell.json
Added word interlinearizer to spellcheck dictionary.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰
A name hopped over from old to new,
Letters changed and banners flew,
I nibbled docs, then polished a line,
Interlinearizer now wears the sign! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 3
❌ Failed checks (2 warnings, 1 inconclusive)
Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses issue #3 by updating extension branding throughout the codebase, but does not demonstrate README updates or commented template preservation as required. Update the README with the extension's name and purpose, and ensure template sections are commented out rather than deleted for future template sync compatibility.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Out of Scope Changes check ❓ Inconclusive The PR includes extensive in-scope renaming changes (extension name, author, types) aligned with template conversion, but the raw_summary lacks README modifications required by issue #3. Clarify whether README updates were included in this PR or deferred to another PR, and confirm template content preservation strategy was applied.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main objective of the PR: converting from the template by following README instructions.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 3-5: Update the README title string from "# interlinearizer" to "#
Interlinearizer" to match the project's branding; edit the top-level heading in
README.md so the capitalized title "Interlinearizer" is used consistently across
docs.
- Line 7: The README contains a nested HTML comment token ("<!-- <!--") that can
confuse renderers; update the Template Info opening comment so it uses a single
opening HTML comment token ("<!--") only, preserving the rest of the comment
text and surrounding markup (look for the line starting with the duplicated
"<!-- <!--" in the README and replace it with a single "<!--" to remove the
nested token).
🧹 Nitpick comments (1)
assets/descriptions/description-en.md (1)

1-3: Drop build-tooling details from the user-facing description.
Consider removing “Powered by webpack” so the description focuses on user value.

🧹 Proposed tweak
-Interlinearizer extension for Platform.Bible. Powered by webpack.
+Interlinearizer extension for Platform.Bible.

Copy link
Contributor

@jasonleenaylor jasonleenaylor left a comment

Choose a reason for hiding this comment

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

@jasonleenaylor partially reviewed 9 files and all commit messages, and made 2 comments.
Reviewable status: 9 of 10 files reviewed, all discussions resolved (waiting on @imnasnainaec).


README.md line 7 at r2 (raw file):

Interlinearizer extension for Platform.Bible

<!-- <!-- Opening comment tag for Template Info Section. Ignore this for now. More info in [Hide Template Info](#hide-template-info).

this could/should be removed also


README.md line 83 at r2 (raw file):

#### Hide Template Info

Once finished customizing this template to be your own, you can uncomment the [HTML comment tag](https://www.w3schools.com/html/html_comments.asp) above the [Template Info](#template-info) section to hide this template-related info in this readme. You can do this by clicking on the line and doing CTRL + / in VS Code. You can also do this manually by removing the first opening '&lt;!--' and the only closing '--&gt;' on the line. Leaving this info commented in your readme will hide it in your readme while avoiding merge conflicts if you decide to [update this extension from the template](#to-update-this-extension-from-the-template) in the future. If you never want to update this extension from the template, you can remove the [Template Info](#template-info) section and sub-sections of this readme.

as suggested

Copy link
Contributor

@jasonleenaylor jasonleenaylor left a comment

Choose a reason for hiding this comment

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

:lgtm:

@jasonleenaylor reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @imnasnainaec).

@imnasnainaec imnasnainaec merged commit c49c980 into main Jan 29, 2026
7 checks passed
@imnasnainaec imnasnainaec deleted the readme-init branch January 29, 2026 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🟨Medium Medium-priority PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README with name and purpose of the extension

2 participants