-
-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a non minified version of autoComplete.js #1008
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's time to define the procedure of how parts from other open source projects must be imported into OpenZIM &/| Kiwix projects. Questions to consider:
- How and where attribution should be made? Is a mention in README enough or we have to include it in every imported file? If more than one file is imported maybe we should place them under their own subdirectory and only add a single
ATTRIBUTION.md
file? Should there be any difference between files that are only used during build vs those files that are exposed to the end-user? - Similar questions for the license of imported files.
- Regarding sources (
autoComplete.js
in this case) and end-user-artifacts (autoComplete.min.js
in this case) - having both files without the process that produces the latter from the former doesn't fully meet the justification for preserving the original sources in our own project/repository. In the light of that argument, do we really have to import the sources too? If yes, in which situations?
static/skin/css/autoComplete.css
Outdated
@@ -1,3 +1,4 @@ | |||
/* Modified from https://github.com/TarekRaafat/autoComplete.js (version 1.2.6)*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The version string should be 10.2.6
- If attribution is going to be embedded into imported files it must be added to
autoComplete.js
andautoComplete.min.js
too. - This change should result in changed
KIWIXCACHEID
s - the unit tests must be updated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Done
autoComplete.css
is modified from originalautoComplete.css
so the small header. Other files (js) are not modified and so I prefer not change them.- Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems we should also put the license of this piece of code
This way we can easily identify which files is part of other project.
- LICENSE is the copy of LICENSE file in TarekRaafat/autoComplete.js - autoComplete.js is `https://cdn.jsdelivr.net/npm/@tarekraafat/autocomplete.js@10.2.6/dist/autoComplete.js`
06fd317
to
bcbdce6
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1008 +/- ##
=======================================
Coverage 38.92% 38.92%
=======================================
Files 58 58
Lines 3990 3990
Branches 2201 2201
=======================================
Hits 1553 1553
Misses 1090 1090
Partials 1347 1347 ☔ View full report in Codecov by Sentry. |
Fix #819