@form8ion/renovate-scaffolder

renovate-scaffolder

opinionated scaffolder for enabling Renovate on a project

Table of Contents

• Features
• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • projectRoot string (required)
• Contributing
  • Dependencies
  • Verification

Features

• Creates the config file for Renovate, extending an appropriate shareable config

Usage

Installation

$ npm install @form8ion/renovate-scaffolder --save-prod

Example

Import

import {lift, test as projectUsesRenovate, scaffold} from '@form8ion/renovate-scaffolder';

Execute

(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

Dependencies

$ nvm install
$ npm install

Verification

$ npm test