An open API service indexing awesome lists of open source software.

https://github.com/travi/shell-scaffolder

opinionated scaffolder for shell projects
https://github.com/travi/shell-scaffolder

Last synced: 2 months ago
JSON representation

opinionated scaffolder for shell projects

Awesome Lists containing this project

README

        

# shell-scaffolder

opinionated scaffolder for shell projects that are packaged with
[bpkg](http://www.bpkg.io)

[![Codecov][coverage-badge]][coverage-link]
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
![SLSA Level 2][slsa-badge]

## Usage

[![npm][npm-badge]][npm-link]
[![MIT license][license-badge]][license-link]

### Installation

```sh
$ npm install @travi/shell-scaffolder --save-prod
```

## Contributing

[![Conventional Commits][commit-convention-badge]][commit-convention-link]
[![Commitizen friendly][commitizen-badge]][commitizen-link]
[![semantic-release][semantic-release-badge]][semantic-release-link]
[![PRs Welcome][PRs-badge]][PRs-link]
[![Renovate][renovate-badge]][renovate-link]

### Dependencies

```sh
$ nvm install
$ npm install
```

### Verification

```sh
$ npm test
```

## Related Projects

* [project-scaffolder](https://npm.im/@travi/project-scaffolder)
* [scaffolder-sub-command](https://github.com/travi/scaffolder-sub-command)
* [travis-scaffolder-shell](https://github.com/travi/travis-scaffolder-shell)
* [cli](https://npm.im/@travi/cli)

[npm-link]: https://www.npmjs.com/package/@travi/shell-scaffolder

[npm-badge]: https://img.shields.io/npm/v/@travi/shell-scaffolder?logo=npm

[license-link]: LICENSE

[license-badge]: https://img.shields.io/github/license/travi/shell-scaffolder.svg

[coverage-link]: https://codecov.io/github/travi/shell-scaffolder

[coverage-badge]: https://img.shields.io/codecov/c/github/travi/shell-scaffolder?logo=codecov

[commit-convention-link]: https://conventionalcommits.org

[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[commitizen-link]: http://commitizen.github.io/cz-cli/

[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[semantic-release-link]: https://github.com/semantic-release/semantic-release

[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release

[PRs-link]: http://makeapullrequest.com

[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[renovate-link]: https://renovatebot.com

[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot

[github-actions-ci-link]: https://github.com/travi/shell-scaffolder/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster

[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/travi/shell-scaffolder/node-ci.yml.svg?branch=master&logo=github

[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg