headroom

©️ Manager for license headers in source code files.

Monthly Downloads: 34

Programming language: Haskell

License: BSD 3-clause "New" or "Revised" License

Tags: Utils    

Latest version: v0.4.3.0

README

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:

1. download pre-built binary for GNU/Linux or macOS (x64) from releases page
2. install using Homebrew: brew install norcane/tools/headroom
3. 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)

Mentions

• Bind The Gap magazine, issue #2 has chapter dedicated to Headroom (pages 17-18).

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.