Shebang Removal While Adding Copyright Header in Shell Scripts

Aperta
#2,270 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
shell
Ambito
tooling

Direzione di ricerca

Inizia riproducendo la configurazione Spotless Maven fornita sugli script shell, utilizzando Maven 3.8.8 e le impostazioni shell licenseHeader. Traccia come interagiscono setLicenseHeaderYearsFromGitHistory e skipLinesMatching, quindi verifica che l'applicazione del formatter preservi lo shebang di ogni script.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Java
Stelle
5.7k
Fork
560
Merge medio
1g 13h
PR unite (30g)
43

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di diffplug/spotless

Tutte le issue di diffplug/spotless

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.