Skip to content
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 license and link to library for easier license compliance #48

Open
Calinou opened this issue Jan 5, 2021 · 8 comments
Open

Add license and link to library for easier license compliance #48

Calinou opened this issue Jan 5, 2021 · 8 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Calinou
Copy link
Contributor

Calinou commented Jan 5, 2021

Currently, the files in dist/js only state the following:

/**
 * tobii 2.0.0-beta 
 *
 */

I suggest changing it to something like this:

/**
 * tobii 2.0.0-beta 
 * Licensed under the MIT license.
 * https://github.com/midzer/tobii
 */

The header should also be added to the CSS. This way, people using the library can comply with the license more easily. Thanks in advance 🙂

@midzer
Copy link
Owner

midzer commented Jan 6, 2021

Hey @Calinou
Yup, good point. This should be done before v2 release

@midzer midzer added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 6, 2021
@midzer
Copy link
Owner

midzer commented Jul 2, 2021

Current dist files contain no comments at all. Is this possible with microbundle, @ocean90 ?

@midzer midzer removed the good first issue Good for newcomers label Jul 2, 2021
@ocean90
Copy link
Collaborator

ocean90 commented Jul 5, 2021

No, but you can probably add a postbuild script running something like this.

@midzer
Copy link
Owner

midzer commented Jul 5, 2021

Good advice, awesome :)
We'll do this in the upcoming version.

@midzer midzer added this to the v3.0.0 milestone Jul 5, 2021
@midzer midzer modified the milestones: v3.0.0, v2.3.0 Jul 29, 2021
@midzer midzer self-assigned this Jul 29, 2021
@midzer
Copy link
Owner

midzer commented Jul 30, 2021

@ocean90 I've spent some time trying to get this to work according to your example.

Too bad, with postbuild you can't pipe the banner properly in the file: js content is replaced and processing does not continue for other files.

There is a way to do it in BASH https://www.cyberciti.biz/faq/bash-prepend-text-lines-to-file/ but it is kinda ugly to put the whole banner in package.json several times.

Do you wanna try it? Otherwise I would leave this one as "wontfix".

@midzer midzer removed their assignment Jul 30, 2021
@viliusle
Copy link
Collaborator

It is not only for license compliance, minified resource should include name, version and URL. Problem, that we have 5 js files in dist folder, do we really need all of them?

@viliusle
Copy link
Collaborator

viliusle commented Aug 5, 2021

Related question, why we have both dist/tobii.js and dist/tobii.min.js, if both are minified?

p.s. first file is smaller.

@midzer
Copy link
Owner

midzer commented Aug 5, 2021

Maybe @ocean90 has more info about those microbundle dist files

@midzer midzer modified the milestones: v2.3.0, v3.0.0 Aug 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants