dependabot-scaffolder
opinionated scaffolder for enabling Dependabot on a project
Table of Contents
Usage
Installation
$ npm install @form8ion/dependabot-scaffolder --save-prod
Features
- Defines a badge that shows whether Dependabot is enabled for the project
- Creates the config file for Dependabot, enabling auto-merging
⚠️ Currently supports only thejavascript
package_manager
Example
Import
import {lift, predicate, scaffold} from '@form8ion/dependabot-scaffolder';
Execute
(async () => {
await scaffold({
projectRoot: process.cwd(),
vcs: {owner: 'form8ion', name: 'the-repo'}
});
if (await predicate({projectRoot: process.cwd()})) {
await lift();
}
})();
API
projectRoot
string (required)
path to the root of the project
vcs
object (required)
-
owner
string (required) account name on the host service for the repository -
name
string (required) repository name
Contributing
Dependencies
$ nvm install
$ npm install
Verification
$ npm test