feat: v3.0.0-alpha.1 — modular build, ESM, TypeScript, multi-version docs#17
Merged
Merged
Conversation
…docs Build & Tooling: - Replace Grunt with Rollup for JS bundling (3 outputs: UMD min, UMD dev, ESM) - Replace Grunt sass/cssmin with sass CLI + PostCSS (autoprefixer + cssnano) - Add .browserslistrc for explicit browser targets - Add TypeScript declarations (dist/types/jquery.verticalscroll.d.ts) - Add package.json exports map, module field, types field - Update Node engine requirement to >=18 Source Architecture: - Modularize 1,105-line monolith into 9 focused ES modules: constants, utils, core, navigation, pagination, accessibility, input, auto-scroll, index - Add WeakMap instance storage with getInstance() static method - Add double-initialization prevention with console warning Documentation: - Add multi-version docs support (v2 + v3) with version switcher - Create v3 docs: migration guide, updated installation (ESM/TS), updated API (getInstance), updated contributing (Rollup build) - Move existing docs into v2/ directory (frozen) - Update coverpage and navbar for v3 Demo & CI: - Update demo to reference dist/ files instead of source - Update CI to build before deploying demo - Add build step before unit tests in CI All 152 existing tests pass. Bundle size: JS +9.5%, CSS -0.9%.
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
First milestone of the v3.0 upgrade — modernizes the build system, modularizes the source, and adds multi-version documentation.
Build & Tooling
dist/types/jquery.verticalscroll.d.ts).browserslistrc,exportsmap,module+typesfields in package.json>=18Source Architecture
getInstance(element)static methodDocumentation
getInstance), migration guide (v2→v3), contributing (Rollup build)docs/v2/Demo & CI
dist/files instead of sourceBackward Compatibility
Test plan
npm run build)