Shebang Removal While Adding Copyright Header in Shell Scripts

Open
#2,270 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
shell
Domain
tooling

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

bug-unconfirmed
  • 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
image

  • 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.