headroom: License Header Manager
Would you like to have nice, up-to-date license/copyright headers in your source code files but hate to manage them by hand? Then Headroom is the right tool for you! Now you can define your license header as Mustache template, put all the variables (such as author's name, year, etc.) into the YAML config file and Headroom will take care to add such license headers to all your source code files.
[Skip to Readme]
Modules
[Index] [Quick Jump]
- Headroom
- Headroom.Command
- Headroom.Configuration
- Data
- Headroom.Embedded
- Headroom.FileSupport
- Headroom.FileSupport.C
- Headroom.FileSupport.CPP
- Headroom.FileSupport.CSS
- Headroom.FileSupport.Go
- Headroom.FileSupport.HTML
- Headroom.FileSupport.Haskell
- Headroom.FileSupport.JS
- Headroom.FileSupport.Java
- Headroom.FileSupport.PureScript
- Headroom.FileSupport.Rust
- Headroom.FileSupport.Scala
- Headroom.FileSupport.Shell
- Headroom.FileSupport.TemplateData
- Headroom.FileSupport.Types
- Headroom.FileSystem
- Headroom.FileType
- Headroom.Header
- Headroom.HeaderFn
- Headroom.Meta
- Headroom.Serialization
- Headroom.SourceCode
- Headroom.Template
- Headroom.Types
- Headroom.UI
- Headroom.Variables
Downloads
- headroom-0.4.1.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
| Versions [RSS] | 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.1.3.0, 0.2.0.0, 0.2.1.0, 0.2.1.1, 0.2.2.0, 0.2.2.1, 0.3.0.0, 0.3.1.0, 0.3.2.0, 0.4.0.0, 0.4.1.0, 0.4.2.0, 0.4.3.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson, base (>=4.7 && <5), either, file-embed, generic-data, headroom, microlens, microlens-th, mtl, mustache, optparse-applicative, pcre-heavy, pcre-light, rio, string-interpolate, template-haskell, time, yaml [details] |
| License | BSD-3-Clause |
| Copyright | Copyright (c) 2019-2021 Vaclav Svejcar |
| Author | Vaclav Svejcar |
| Maintainer | vaclav.svejcar@gmail.com |
| Category | Utils |
| Home page | https://github.com/vaclavsvejcar/headroom |
| Bug tracker | https://github.com/vaclavsvejcar/headroom/issues |
| Source repo | head: git clone https://github.com/vaclavsvejcar/headroom |
| Uploaded | by xwinus at 2021-03-14T15:26:20Z |
| Distributions | NixOS:0.4.3.0 |
| Executables | headroom |
| Downloads | 3503 total (40 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2021-03-14 [all 1 reports] |
Readme for headroom-0.4.1.0
[back to package description]Would you like to have nice, up-to-date license/copyright headers in your source code files but hate to manage them manually? Then Headroom is the right tool for you. Define your license header as Mustache template, put any template variables into YAML configuarion file, and you're ready to go!
Headroom also offers much more than just adding, replacing or dropping license headers. It can also update years in copyrights for you, provides content-aware templates for some source code file types, and much more!
Main Features
- License Header Management - Add, replace or drop license headers in your source code files with a single command. What's more, contrary to many similar tools, Headroom allows you to also replace/drop headers that weren't previously generated by Headroom, using smart header auto-detection.
- Powerful Customization - Default configuration should cover most use-cases, but if you need to put empty lines before/after generated header, use different comment style of headers, you can customize the configuration to match exactly your needs.
- Built-in OSS License Headers - If you want to use license header for one of the popular OSS licenses, then Headroom can generate them for you - no need to search for them on web.
- Automatic Initialization for OSS Projects - Setting up external tools like Headroom for your project can be boring. Fortunately, Headroom can initialize itself for your project, by generating configuration file and template files.
- Content-aware Templates - for selected file types, Headroom exposes additional info about processed file using template variables, so you can use info like Java package name in your templates.
- Copyright Year Updater - Headroom is good not only for basic license header management, but also for further processing of generated headers. Do you need to update years in your copyrights? No problem!
Installation
You can get Headroom via one of the following options:
- download pre-built binary for GNU/Linux or macOS (x64) from releases page
- install using Homebrew:
brew install norcane/tools/headroom - build from source code - see project microsite for more details
Adopters
Here is the list of projects using Headroom. If you're using Headroom and aren't on the list, feel free to submit new issue or pull request.
- kowainik/hit-on - Kowainik Git Workflow Helper Tool
- kowainik/summoner - Tool for scaffolding batteries-included production-level Haskell projects
- wireapp/wire-server - Wire back-end services (https://wire.com)
Documentation
- for end-user documentation, official project microsite
- for Haskell API documentation, see Headroom on Hackage
Running microsite locally
If you need to show microsite documetation for unreleased version of Headroom (e.g. for master branch), you can run it locally using MkDocs tool:
$ cd doc/microsite/
$ mkdcs serve
Documentation is then available on http://127.0.0.1:8000.