https://github.com/quantco/pre-commit-mirrors-insert-license

Pre-commit hook to insert a license disclaimer as a header comment in source files.
https://github.com/quantco/pre-commit-mirrors-insert-license

Last synced: about 2 months ago
JSON representation

Pre-commit hook to insert a license disclaimer as a header comment in source files.

• Host: GitHub
• URL: https://github.com/quantco/pre-commit-mirrors-insert-license
• Owner: Quantco
• License: bsd-3-clause
• Created: 2023-12-06T14:01:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-18T08:07:35.000Z (10 months ago)
• Last Synced: 2024-07-08T03:08:06.432Z (6 months ago)
• Size: 43 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# insert-license-header pre-commit hook

pre-commit hook of insert-license-header with conda as a `language` / package manager.

For pre-commit: see [here](https://github.com/pre-commit/pre-commit)

For insert-license-header: see [here](https://github.com/thomasmarwitz/insert-license-header)

## Using insert-license-header with pre-commit and conda:

Add this to your `.pre-commit-config.yaml`

```yaml

 - repo: https://github.com/quantco/pre-commit-mirrors-insert-license-header

   rev: ''  # Use the sha / tag you want to point at

   hooks:

     - id: insert-license-header-conda

```

> [!WARNING]

> In order for this hook to work properly, ensure that the entire git history is fetched during `pre-commit-checks`.

This hook uses our license header by default.

However, you can overwrite this default header by first creating your own base64 encoded string:

```

$ echo "Copyright (C) 2042, PearCorp, Inc.\nSPDX-License-Identifier: LicenseRef-PearCorp" | base64

Q29weXJpZ2h0IChDKSAyMDQyLCBQZWFyQ29ycCwgSW5jLgpTUERYLUxpY2Vuc2UtSWRlbnRpZmllcjogTGljZW5zZVJlZi1QZWFyQ29ycAo=

```

And then supplying it to the hook:

```

[...]

- id: insert-license

        types: [python]

        args:

          - --license-base64

          - "Q29weXJpZ2h0IChDKSAyMDQyLCBQZWFyQ29ycCwgSW5jLgpTUERYLUxpY2Vuc2UtSWRlbnRpZmllcjogTGljZW5zZVJlZi1QZWFyQ29ycAo="

          - --dynamic-years

          - --comment-style

          - "#"

```

Other comment styles:

For Java / Javascript / CSS/ C / C++ (multi-line comments) set: `/*| *| */`

For Java / Javascript / C / C++ (single line comments) set `//`

For HTML files: ``

To remove all license headers, temporarily add the `--remove-header` arg in

your `.pre-commit-config.yaml`. Run the hook on all files: `pre-commit run insert-license -a`.

For more configuration options see the conda-packaged tool [insert-license-header](https://github.com/thomasmarwitz/insert-license-header) that exposes the `insert-license-header` executable, the original repository [Lucas-C/pre-commit-hooks](https://github.com/Lucas-C/pre-commit-hooks) and [Pre-Commit](https://pre-commit.com/).