text
_
_ _ ___ _____ ___| |_ ___
| | | | | .'| '_| -_|
|___|_|_|_|_|_|__,|_,_|___|
Work in progress
unmake is a makefile linter that promotes extreme portability.
Too many makefiles online are restricted to building only as Works On My Machine^TM.
unmake bucks this trend, encouraging the makefile author to think more critically about what level of platform support they want for their software builds.
Do you want to be able to build your software on macOS? On Linux? On FreeBSD? On Windows (Command Prompt, PowerShell, and/or WSL)? On fish terminals?
All of the above?
unmake can help to catch vendor-lock issues earlier in the SDLC process. So that your apps can build more reliably, for more contributors to enjoy.
```console $ cd fixtures
$ unmake valid/makefile
$ unmake invalid/for-loop.BSDmakefile error at 1:16: expected one of " ", "$(", "${", ":", "\t", [^ (' ' | '\t' | ':' | ';' | '#' | '\r' | '\n')] ```
See unmake -h for more options.
unmake catches many subtle makefile quirks. If your makefile fails to parse with unmake, pay close attention to line endings, indentation, and any implementation-specific syntax.
See PARSING.md.md for more information.
Coming soon.
https://crates.io/crates/unmake
https://docs.rs/unmake/latest/unmake/
https://github.com/mcandre/unmake/releases
console
$ cargo install --force --path .
The unmake linter serves several purposes.
unmake provides a strict replacement for make -n, in case the local make implementation has BSD, GNU, etc. extensions. unmake encourages validating makefiles for syntactic wholeness as part of their projects' linter suites, before any tasks are actually run.
unmake encourages long or subtle shell snippets to be moved to dedicated shell script files, where they are more amenable to scanning with shell script linters. Most linters for common shell snippet wrapping languages (e.g., Ansible, Dockerfile, makefile, Vagrantfile, various CI/CD pipelines) perform very limited scanning for potential flaws in the embedded snippets, compared with linters that specifically scan shell script files.
make is a natural candidate for working around limitations in provisioning scripts. For example, go mod / cargo do not track linters or other dev dependencies, and sh defaults to ignoring errors during provisioning. make's default semantics prepare it well for provisioning and other activities. make can do many things! unmake helps it do them better.
unmake discourages vendor locking in makefile scripts. Numerous makefiles online assume a highly specific development environment. For example, assuming that (GNU) findutils, (GNU) sed, (GNU) awk, (non-PowerShell) curl are installed, with a GNU bash or zsh user interpreter, on a GNU/Linux operating system. So the typical makefile is likely to fail for (non-WSL) Windows users, or macOS users, or FreeBSD users, and so on. Ideally, our makefiles strive for portability, so that our projects can be enjoyed on a wider variety of computers. Portability, naturally restricts makefile contents to a portable subset, of what the various make implementations allow people to write. But a portability linter can curtail some of the worst offenders.
The dream is for every makefile to behave as a polyglot script, cabable of running well on most any computer platform with a make implementation installed.
(None)
For more details on developing crit itself, see DEVELOPMENT.md.
FreeBSD
Some projects using unmake to safeguard their makefiles: