refactor: cache getVersion() and add JSDoc to display utilities#79
Open
KernelCode wants to merge 1 commit intomainfrom
Open
refactor: cache getVersion() and add JSDoc to display utilities#79KernelCode wants to merge 1 commit intomainfrom
KernelCode wants to merge 1 commit intomainfrom
Conversation
getVersion() was reading package.json from disk on every call even though the version cannot change at runtime. Cache the result after the first read. Also add JSDoc comments to all previously undocumented exported functions for better IDE support and maintainability. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
getVersion(): Previously readpackage.jsonfrom disk on every call. Since the version cannot change at runtime, the result is now cached after the first read — avoiding repeated synchronous I/O.getLocalIp(),showLogo(),showStartupCheck(),showStartupComplete(),showSuccess(),showError(),createSpinner(), andshowCharacterGallery()now have proper JSDoc with parameter types and return descriptions.Test plan
node -cnpm start)getVersion()returns the correct version on first and subsequent calls🤖 Generated with Claude Code