Modernize Tanach API with TypeScript, Vite, and optimized data format #10
Conversation
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
Major changes: - Migrated to TypeScript with full type safety - Set up Vite for modern build tooling - Compressed data format (25.6% size reduction: 8.46 MB → 6.30 MB) - Converted to ES modules (package.json "type": "module") - Replaced Mocha/Chai with Vitest for modern testing - Added new API methods: getChapter(), getBooks(), getBookMeta() - Improved data structure: nested by book/chapter for efficient lookups - Added comprehensive TypeScript types and interfaces - Updated documentation with modern usage examples Build output: - ES module: dist/tanach.es.js (4.03 MB, 1.45 MB gzipped) - CommonJS: dist/tanach.cjs.js (3.08 MB, 1.40 MB gzipped) - TypeScript definitions included All 13 tests passing. https://claude.ai/code/session_01KpVUKFoCnSW3VgCpNRYbe7
New workflows: - CI workflow: Tests on Node.js 18, 20, 22 for PRs and main branch - npm publish workflow: Auto-publish on releases or manual trigger - Coverage reporting to Codecov (optional) Documentation updates: - Added CONTRIBUTING.md with development guidelines - Updated README.md with publishing and CI/CD sections - Included setup instructions for NPM_TOKEN secret Features: - Automated testing on multiple Node.js versions - One-click npm publishing via GitHub releases - Manual workflow dispatch for emergency publishes - Build and test validation before publish https://claude.ai/code/session_01KpVUKFoCnSW3VgCpNRYbe7
sharshi
commented
Jan 29, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR modernizes the Tanach API library with a complete rewrite using TypeScript, modern tooling (Vite), and an optimized data format. The changes transform the project from a basic Node.js package into a production-ready, type-safe library with comprehensive test coverage.
Key Changes
getBooks()to list all available booksgetBookMeta()for book metadata queriesgetChapter()to retrieve entire chapterstorah(),neviim(),kesuvim()VerseResultinterfaceImplementation Details
{ [bookName]: { meta: {...}, chapters: { [chapterNum]: [[verseNum, text], ...] } } }for efficient lookupsBreaking Changes
@shafeh/tanachindex.jstodist/tanach.cjs.js(ordist/tanach.es.jsfor ESM)https://claude.ai/code/session_01KpVUKFoCnSW3VgCpNRYbe7