Document the vendored libraries and why some stay - #15
Merged
Merged
Conversation
The dependencies that matter here are files, not package.json entries, and until now nothing recorded what they are or why the old ones had not been replaced. That left every future reader to work it out again, and made "it is old" look like a sufficient reason to change something. docs/vendored-libraries.md splits them by what can actually be done with them: host-provided (jQuery, jQuery UI, FileSaver), maintained upstream (mousewheel, minicolors), and retained legacy with the reason in each case. jquery.hotkeys works on jQuery 3.7.1 and both halves of its contract are covered by tests. dragscrollable has had no release since 2009 and the copy here is not upstream's -- David Richard added delegateMode in 2011 -- so it is application source carrying a third-party header, not an upgradable dependency. The Aristo-derived stylesheet is the editor's appearance, and app.css carries the rules that adapt it to jQuery UI 1.14 markup. docs/jquery-tmpl-replacement.md is the one that needs evidence rather than a verdict, because it crosses repositories: the implementation is bundled here and the seven templates live in eXeLearning's editor page. It lists the eight call sites, the templates, and the three syntax features actually used out of everything the library offers -- four call sites pass no data at all. It also notes that #template-export-map is referenced but not present in eXeLearning's page, and that #template-open-table-item, the only one rendering a list, is the piece without test coverage and the place to start.
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.
The dependencies that matter in this repository are files, not
package.jsonentries, and nothing recorded what they are or why the old ones had not been replaced. That left every future reader to work it out again — and made "it is old" look like a sufficient reason to change something.docs/vendored-libraries.mdSplits them by what can actually be done with each:
Host-provided — jQuery 3.7.1, jQuery UI 1.14.1, FileSaver 2.0.5. Loaded by the page, deliberately not bundled, byte-identical to the npm releases and to what eXeLearning ships.
Maintained upstream — mousewheel 3.2.2, minicolors 2.3.6. Tracked by version, updated as normal maintenance.
Retained legacy, with the reason in each case:
ctrl+zundoes once, a shortcut typed into a caption does not fire). Replacing a working 80-line file that tests cover, because it is old, trades a known quantity for an unknown one.delegateModein 2011. An "update" would mean taking a different project and reapplying that change.app.csscarries the rules adapting it to jQuery UI 1.14 markup (controlgroups inline where buttonsets were; the.ui-frontstacking rule the theme predates, without which modal dialogs sit under their own overlay). Replacing it belongs to a visual redesign with screenshot coverage.docs/jquery-tmpl-replacement.mdThe one that needs evidence rather than a verdict, because it crosses repositories: the implementation is bundled here, the seven templates live in eXeLearning's
editor/index.html.It lists the eight call sites, the seven templates, and the syntax actually used —
${...}×13,{{if}}×2,{{html}}×2, and nothing else the library offers. Four of the eight call sites pass no data at all, so they are static markup that needs no template engine.Two findings worth having written down before anyone starts:
#template-export-mapis referenced byExportMap.jsbut is not among eXeLearning's templates — that command is not wired into its toolbar.#template-open-table-itemis the only template rendering a list and using$item, and the only one without browser coverage. That is where a replacement should start.No code changes.