Wrong multi-line comment tag for bash - Githubissues

ymotongpoo / vsc-licenser

License handler extension for Visual Studio Code.

Apache License 2.0

45 stars 40 forks source link

Wrong multi-line comment tag for bash #85

Closed maximeB closed 3 years ago

maximeB commented 4 years ago

Runtime environment

OS (version): windows10
VS Code version: 1.48.2
VS Code build number (if possible):
other extensions installed: many, but it's not relevant here

Behaviors

Expected behavior

On bash script regardless of setting "licenser.useSingleLineStyle" license header shall always fallback to single line comment using #

Actual behavior

It uses multi-line comment with "<<LICENSE", ">>" as begin/end tag which is not valid (there is no multi-line comment in bash)

Steps to reproduce the issue

set "licenser.useSingleLineStyle" to false
open a bash script without license header
insert license header

Notes:

src/notation.ts defines multi-line comments' begin/end tag for shellscript

tevosouza commented 3 years ago

Hello @maximeB, By default, shell script doesn't support multi-line comments but exists one way to do it using HereDoc. Take a look here

I made a PR (#95) fixing this problem because I understand if the shell doesn't support it as a native feature I see no sense to create an optional dependency that breaks the extension feature.

Do you have any thoughts about it @ymotongpoo?