bramkok / boil

Scaffolding tool

boil

Simple scaffolding

Usage:

$ boil [--option <argument>]

Options

-h, --help

Display help information.

-b, --boilerplate [REQUIRED]

Choose a boilerplate hosted on GitHub. Input format:

--boilerplate username/repository

• Bash bramkok/boilerplate-bash
• ECMAScript 2015 bramkok/boilerplate-es2015

-n, --name [REQUIRED]

Pick a name for the project.

-d, --description

Description of the project.

-a, --author

Name of the project's author.

-u, --username

GitHub username.

-p, --path

Target path of the project.

Testing

Use Bats (Bash Automated Testing System) for testing. The Bats testing file for boil can be found in the '/test' directory.

Usage

$ bats test/boil.bats

License

MIT © Bram Kok

boil's Issues

`sed` compatibility issues

The GNU and macOS versions of sed each handle the -i option different. This option replaces content in files and edits the files 'in place'. An optional argument for -i creates backups of the original files with its value used as the backup filename suffix.

With the GNU version, ommitting the argument for -i will save changes directly to file whereas the macOS version seems to require an argument to function correctly. When an empty value is supplied as an argument no backups will be made.

stackoverflow:

• sed -i -e ... - does not work on OS X as it creates -e backups
• sed -i'' -e ... - does not work on OS X 10.6 but works on 10.9+
• sed -i '' -e ... - not working on GNU

Using an empty value as an argument for -i produces errors when using the GNU version:

sed: can't read : No such file or director

Solution
To increase compatibility with both GNU and macOS an argument has to be given and backups files will be made. As there's no value in keeping the backups around, a 'removal' method should purge the filebase after files have been renamed.