Shebang Removal While Adding Copyright Header in Shell Scripts
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
Research direction
Start by reproducing the provided Spotless Maven configuration against the shell scripts, using Maven 3.8.8 and the shell licenseHeader settings. Trace how setLicenseHeaderYearsFromGitHistory and skipLinesMatching interact, then verify that applying the formatter preserves each script's shebang.
Written by the indexing model from the issue text.
Description
- summary of problem
I’m working on a project with shell scripts and trying to add a copyright header that includes the year range from the Git history using the setLicenseHeaderYearsFromGitHistory property.
The issue I’m facing is that the shebang (#!/bin/bash, etc.) is getting removed from the script files in the process. It seems there's something wrong with the code flow
- Gradle or Maven version - Maven 3.8.8
- spotless version - 2.43.0
- operating system and version - MacOS 14
- copy-paste your full Spotless configuration block(s), and a link to a public git repo that reproduces the problem if possible
<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>2.43.0</version>
<configuration>
<setLicenseHeaderYearsFromGitHistory>true</setLicenseHeaderYearsFromGitHistory>
<upToDateChecking>
<enabled>false</enabled>
</upToDateChecking>
<java>
<includes>
<include>src/main/java/**/*.java</include>
<include>src/test/java/**/*.java</include>
</includes>
<licenseHeader>
<content>
<![CDATA[
/**
****************************************************************************
** Copyright Header
****************************************************************************
**/]]>
</content>
<delimiter>package</delimiter>
</licenseHeader>
</java>
<shell>
<includes>
<include>**/*.sh</include>
</includes>
<licenseHeader>
<content>
<![CDATA[
#---------------------------------------------------------------------------
# Copyright Header
#---------------------------------------------------------------------------]]>
</content>
<delimiter>## Start</delimiter>
<skipLinesMatching>#\!/bin/sh</skipLinesMatching>
</licenseHeader>
</shell>
</configuration>
</plugin>
- copy-paste the full content of any console errors emitted by
gradlew spotless[Apply/Check] --stacktrace- maven plugin
Thanks in advance
- Dominant language
- Java
- Stars
- 5.7k
- Forks
- 560
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 43
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from diffplug/spotless
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 66/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
All issues in diffplug/spotless
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 90/100
apache/cloudstack#14222 ·
-
[BUG]茶杯方块在取茶时会引发崩溃 Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
1.0.0-alpha2 Type/Improvement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
wso2/dpdp-accelerator#272 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
area/frontend
Difficulty 2/5 1-3 hours Newbie friendliness 65/100