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 style sh (shell) #1110

Open
xenoterracide opened this issue Nov 27, 2024 · 2 comments
Open

add style sh (shell) #1110

xenoterracide opened this issue Nov 27, 2024 · 2 comments

Comments

@xenoterracide
Copy link

xenoterracide commented Nov 27, 2024

reuse annotate --license 'MIT' --copyright 'Caleb Cushing' --copyright-prefix spdx-string-symbol --merge-copyrights --style sh .config/git/hooks/*
Error: Invalid value for '--style' / '-s': 'sh' is not one of 'applescript', 'aspx', 'bat', 'bibtex', 'c', 'cpp', 'cppsingle', 'f', 'ftl', 'handlebars', 'haskell', 'html', 'jinja', 'julia', 'lisp', 'm4', 'ml', 'f90', 'plantuml', 'python', 'rst', 'semicolon', 'tex', 'man', 'vst', 'vim', 'xquery'.
#!/bin/sh

[ -n "$CI" ] && exit 0

npx lint-staged

the output I would expect

#!/bin/sh
# SPDX-FileCopyrightText: Copyright © 2024 Caleb Cushing
#
# SPDX-License-Identifier: MIT
[ -n "$CI" ] && exit 0

npx lint-staged
reuse, version 5.0.2

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
@carmenbianca
Copy link
Member

The style you are looking for is called python. This is poorly documented here: https://reuse.readthedocs.io/en/stable/api/reuse.comment.html

The documentation could be better…

@xenoterracide
Copy link
Author

xenoterracide commented Dec 2, 2024

that sounds very very strange... I mean I know python has the same comment style. Don't know if alias's are possible... but maybe you could still add an "sh" style that is simply a reference in some way to python (I believe that style predates pythons existence). Anyways, thanks for the info!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants