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

chore: have check for license-text file-header #305

Closed
jkowalleck opened this issue Jun 3, 2022 · 0 comments · Fixed by #326
Closed

chore: have check for license-text file-header #305

jkowalleck opened this issue Jun 3, 2022 · 0 comments · Fixed by #326
Labels
Milestone

Comments

@jkowalleck
Copy link
Member

jkowalleck commented Jun 3, 2022

in the JavaScript/node ecosystem, it is common to pack/transpile/transform source code for a target system.
babel, webpack, esbuild, ... these tools are usually used for the tasks.

tools minify code by stripping comments.
a license-text-comment should not be stripped, but it should be kept.
therefore these tools do not touch block-comments that start with /*!. some tools replace these comments with a text that states in which file the original text can still be found. yet they respect the ! and keep the texts.

task: make all license-text comments be block-comments starting with an enforcer-mark !

@jkowalleck jkowalleck added this to the v4 milestone Jun 3, 2022
bmodotdev added a commit to bmodotdev/cyclonedx-node-module that referenced this issue Sep 4, 2022
Closes CycloneDX#305: In the JavaScript ecosystem, it is common to bundle or
minify code. During these processes, it is common to remove code
comments. Prefix license comment blocks with “/*!” to signal to these
tools that the license comment block should not be removed.

Signed-off-by: William E Little Jr <git@bmo.dev>
jkowalleck pushed a commit that referenced this issue Sep 5, 2022
Closes #305: In the JavaScript ecosystem, it is common to bundle or
minify code. During these processes, it is common to remove code
comments. Prefix license comment blocks with “/*!” to signal to these
tools that the license comment block should not be removed.

Signed-off-by: William E Little Jr <git@bmo.dev>

Signed-off-by: William E Little Jr <git@bmo.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant