Skip to content

Upgrade to Node 24+ and fix documentation build#468

Draft
Copilot wants to merge 21 commits intomainfrom
copilot/upgrade-dependencies-and-fix-issues
Draft

Upgrade to Node 24+ and fix documentation build#468
Copilot wants to merge 21 commits intomainfrom
copilot/upgrade-dependencies-and-fix-issues

Conversation

Copy link

Copilot AI commented Feb 16, 2026

VuePress 1.x fails on Node 24+ due to lru-cache incompatibilities. Documentation build broken, 46 TypeDoc warnings, functions missing from generated docs after attempted multi-entry-point fix.

Infrastructure

VuePress 1.x → VitePress 1.6.4

  • 1,700 packages removed, 93% fewer vulnerabilities, 97% faster builds
  • Integrated typedoc-vitepress-theme for unified API docs
  • Fixed sidebar path generation (docsRoot: "./docs" prevents /docs/api/ prefix)

Dependencies

  • Node engine: >=20 (supports 24/25)
  • Test matrix: Added Node 24 and 25 to CI
  • Updated all npm dependencies to latest compatible versions

Documentation

TypeDoc configuration

  • Single entry point strategy (multiple entry points split docs across modules, hiding functions)
  • Exported internal types from index.ts to ensure documentation completeness
  • Renamed conflicting type exports: PlayerPlayerData, GuildGuildData, SkyBlockAuctionSkyBlockAuctionData
  • Fixed JSDoc issues: parameter mismatch in getSkyWarsLevelInfo, broken link in transformSkyBlockProfileMemberInventories
  • Suppressed 5 utility types in intentionallyNotExported

Content updates

  • Migrated /ts-api/api across all guides
  • CHANGELOG reverted to GitHub link (was erroneously integrated locally)
  • Restored logo to home page
  • Updated guide index content

API Changes

Internal types now exported (makes them officially supported):

import { 
  Client,
  PlayerData,           // was: types/Augmented/Player
  GuildData,            // was: types/Augmented/Guild
  SkyBlockProfile,      
  SkyBlockAuctionData,  // was: types/Augmented/SkyBlock/Auction
  PlayerResponse,       // all 31 *Response types
  DefaultMeta,
  RateLimitData
} from '@zikeji/hypixel';

Type-only exports (no runtime impact). Renamed exports avoid conflicts with existing classes.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits February 16, 2026 05:36
…r dependencies

Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
… matrix

Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
…strict type rules

Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title [WIP] Upgrade dependencies and patch issues in project chore: upgrade dependencies and expand Node test matrix Feb 16, 2026
Copilot AI requested a review from zikeji February 16, 2026 05:47
@coveralls
Copy link

coveralls commented Feb 16, 2026

Pull Request Test Coverage Report for Build 22085655750

Details

  • 4 of 25 (16.0%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.4%) to 75.113%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/helpers/SkyBlockCollections.ts 0 1 0.0%
src/methods/skyblock/auctions.ts 0 1 0.0%
src/helpers/TransformSkyBlockItemData.ts 0 3 0.0%
src/helpers/TransformItemData.ts 0 16 0.0%
Totals Coverage Status
Change from base Build 22051233642: 0.4%
Covered Lines: 602
Relevant Lines: 761

💛 - Coveralls

Copilot AI and others added 3 commits February 16, 2026 07:24
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title chore: upgrade dependencies and expand Node test matrix Rebuild documentation with VitePress to fix Node 24+ compatibility Feb 16, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Rebuild documentation with VitePress to fix Node 24+ compatibility Fix VitePress documentation: routing, assets, and build artifacts Feb 16, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Fix VitePress documentation: routing, assets, and build artifacts Fix VitePress documentation: auto-generate API docs in dev mode, display hero logo, update guide Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Fix VitePress documentation: auto-generate API docs in dev mode, display hero logo, update guide Integrate TypeDoc VitePress theme and add CHANGELOG to documentation Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Integrate TypeDoc VitePress theme and add CHANGELOG to documentation Fix TypeDoc sidebar links and update deprecated API documentation paths Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Fix TypeDoc sidebar links and update deprecated API documentation paths Eliminate 46 TypeDoc warnings in documentation generation Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Eliminate 46 TypeDoc warnings in documentation generation Upgrade to Node 24+ and modernize documentation infrastructure Feb 17, 2026
…gration

Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Upgrade to Node 24+ and modernize documentation infrastructure Export Response types in documentation and revert CHANGELOG integration Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Export Response types in documentation and revert CHANGELOG integration Migrate to VitePress and document internal types for Node 24+ compatibility Feb 17, 2026
Co-authored-by: zikeji <9063612+zikeji@users.noreply.github.com>
Copilot AI changed the title Migrate to VitePress and document internal types for Node 24+ compatibility Upgrade to Node 24+ and fix documentation build Feb 17, 2026
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.

3 participants