https://github.com/form8ion/renovate-scaffolder
opinionated scaffolder for enabling Renovate on a project
https://github.com/form8ion/renovate-scaffolder
Last synced: 19 days ago
JSON representation
opinionated scaffolder for enabling Renovate on a project
- Host: GitHub
- URL: https://github.com/form8ion/renovate-scaffolder
- Owner: form8ion
- License: mit
- Created: 2020-03-16T19:47:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T15:51:25.000Z (about 1 year ago)
- Last Synced: 2024-04-13T09:22:03.014Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://npm.im/@form8ion/renovate-scaffolder
- Size: 4.6 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - renovate-scaffolder
README
# renovate-scaffolder
opinionated scaffolder for enabling [Renovate](https://renovate.whitesourcesoftware.com/)
on a project
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
[![Codecov][coverage-badge]][coverage-link]
![SLSA Level 2][slsa-badge]
## Table of Contents
* [Features](#features)
* [Usage](#usage)
* [Installation](#installation)
* [Example](#example)
* [Import](#import)
* [Execute](#execute)
* [API](#api)
* [`projectRoot` __string__ (_required_)](#projectroot-string-required)
* [Contributing](#contributing)
* [Dependencies](#dependencies)
* [Verification](#verification)
## Features
* Creates the [config file](https://docs.renovatebot.com/configuration-options/)
for [Renovate](https://renovate.whitesourcesoftware.com/), extending an
appropriate [shareable config](https://docs.renovatebot.com/config-presets/#github-hosted-presets)
## Usage
[![npm][npm-badge]][npm-link]
[![Try @form8ion/renovate-scaffolder on RunKit][runkit-badge]][runkit-link]
[![MIT license][license-badge]][license-link]
![node][node-badge]
### Installation
```sh
$ npm install @form8ion/renovate-scaffolder --save-prod
```
### Example
#### Import
```javascript
import {lift, test as projectUsesRenovate, scaffold} from '@form8ion/renovate-scaffolder';
```
#### Execute
```javascript
(async () => {
await scaffold({projectRoot: process.cwd()});
if (await projectUsesRenovate({projectRoot: process.cwd()})) {
await lift({projectRoot: process.cwd()});
}
})();
```
### API
#### `projectRoot` __string__ (_required_)
path to the root of the project
## 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
```
[npm-link]: https://www.npmjs.com/package/@form8ion/renovate-scaffolder
[npm-badge]: https://img.shields.io/npm/v/@form8ion/renovate-scaffolder?logo=npm
[runkit-link]: https://npm.runkit.com/@form8ion/renovate-scaffolder
[runkit-badge]: https://badge.runkitcdn.com/@form8ion/renovate-scaffolder.svg
[license-link]: LICENSE
[license-badge]: https://img.shields.io/github/license/form8ion/renovate-scaffolder.svg?logo=opensourceinitiative
[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
[github-actions-ci-link]: https://github.com/form8ion/renovate-scaffolder/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/renovate-scaffolder/node-ci.yml.svg?branch=master&logo=github
[coverage-link]: https://codecov.io/github/form8ion/renovate-scaffolder
[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/renovate-scaffolder?logo=codecov
[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg
[node-badge]: https://img.shields.io/node/v/@form8ion/renovate-scaffolder?logo=node.js
[renovate-link]: https://renovatebot.com
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot