@seermedical/danger-plugin-yarn
v1.3.2
Published
Provides dependency information on dependency changes in a PR
Downloads
6
Readme
danger-plugin-yarn
Provides dependency information on dependency changes in a PR
Usage
Install:
yarn add danger-plugin-yarn --dev
At a glance:
// dangerfile.js
import yarn from 'danger-plugin-yarn'
schedule(yarn())
Provides 4 separate rules:
checkForRelease
- Provides a 🎉 when there's a package version bump.checkForNewDependencies
(async) - Provides npmjs.com andyarn why
metadata about new dependencies.checkForLockfileDiff
- Will warn you when there aredependencies
ordevDependencies
changes without ayarn.lock
change.checkForTypesInDeps
- Will fail the build if you add any@types/[x]
todependencies
instead ofdevDependencies
.
And exports a default function to handle all of them at once.
Note: async functions like the default one have be to schedule
'd by Danger.
Private packages
If you want the plugin to find your private packages on npm, you need to provide an npm authentication token:
// dangerfile.js
import yarn from 'danger-plugin-yarn'
schedule(yarn({ npmAuthToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }))
Changelog
See the GitHub release history.
Contributing
See CONTRIBUTING.md.
What does this look like?
The rest of this README is the contents of what it looks like when you add this plugin to your Dangerfile:
New dependencies added: danger-plugin-yarn.
Provides dependency information on dependency changes in a PR
Usage
Install:
yarn add danger-plugin-yarn --dev
At a glance:
// dangerfile.js
import yarn from 'danger-plugin-yarn'
schedule(yarn())
Provides 4 separate rules:
checkForRelease
- Provides a 🎉 when there's a package version bump.checkForNewDependencies
(async) - Provides npmjs.com andyarn why
metadata about new dependencies.checkForLockfileDiff
- Will warn you when there aredependencies
ordevDependencies
changes without ayarn.lock
change.checkForTypesInDeps
- Will fail the build if you add any@types/[x]
todependencies
instead ofdevDependencies
.
And exports a default function to handle all of them at once.
Note: async functions like the default one have be to schedule
'd by Danger.
Changelog
See the GitHub release history.
Contributing
See CONTRIBUTING.md.