Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orta/danger-plugin-yarn
Provides dependency information on dependency changes in a PR *
https://github.com/orta/danger-plugin-yarn
Last synced: 4 months ago
JSON representation
Provides dependency information on dependency changes in a PR *
- Host: GitHub
- URL: https://github.com/orta/danger-plugin-yarn
- Owner: orta
- License: mit
- Created: 2017-05-19T17:12:53.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T12:25:52.000Z (over 1 year ago)
- Last Synced: 2024-02-20T23:05:30.546Z (4 months ago)
- Language: TypeScript
- Size: 177 KB
- Stars: 32
- Watchers: 3
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-danger - danger-plugin-yarn - Provides dependency information on dependency changes in a PR * (Plugins / TypeScript (danger-js))
README
# danger-plugin-yarn
[](https://travis-ci.org/orta/danger-plugin-yarn)
[](https://badge.fury.io/js/danger-plugin-yarn)
[](https://github.com/semantic-release/semantic-release)
> Provides dependency information on dependency changes in a PR
## Usage
Install:
```sh
yarn add danger-plugin-yarn --dev
```
At a glance:
```js
// dangerfile.js
import yarn from 'danger-plugin-yarn'
yarn()
```
Provides 4 separate rules:
* `checkForRelease` - Provides a 🎉 when there's a package version bump.
* `checkForNewDependencies` (async) - Provides npmjs.com and `yarn why` metadata about new dependencies.
* `checkForLockfileDiff` - Will warn you when there are `dependencies` or `devDependencies` changes without a `yarn.lock` change.
* `checkForTypesInDeps` - Will fail the build if you add any `@types/[x]` to `dependencies` instead of `devDependencies`.
And exports a default function to handle all of them at once.
### Feature Flags
If you want to disable any combination of these particular rules, there is a matching `disable*` option flag:
```ts
disableCheckForRelease?: boolean
disableCheckForNewDependencies?: boolean
disableCheckForLockfileDiff?: boolean
disableCheckForTypesInDeps?: boolean
```
Which are used as follows:
```js
yarn({
disableCheckForTypesInDeps: true
})
```
## Private packages
If you want the plugin to find your private packages on npm, you need to provide an npm [authentication token](https://docs.npmjs.com/getting-started/working_with_tokens):
```js
// dangerfile.js
import yarn from 'danger-plugin-yarn'
yarn({ npmAuthToken: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' })
```
## Specify registry URL
If you want the plugin to use different registry than `registry.npmjs.org`:
```js
// dangerfile.js
import yarn from 'danger-plugin-yarn'
yarn({ npmRegistryUrl: 'https://registry.yarnpkg.com' })
```
## 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:
---
Warnings
:warning:
New dependencies added: danger-plugin-yarn.
danger-plugin-yarn
Author: Orta Therox
Description: Provides dependency information on dependency changes in a PR
Homepage: https://github.com/orta/danger-plugin-yarn#readme
Created24 days agoLast Updated3 minutes agoLicenseMITMaintainers1Releases14Direct Dependenciesdate-fns, lodash.flatten, lodash.includes, node-fetch and esdocKeywordsdanger, danger-plugin and yarn
README
# danger-plugin-yarn
[](https://travis-ci.org/orta/danger-plugin-yarn)
[](https://badge.fury.io/js/danger-plugin-yarn)
[](https://github.com/semantic-release/semantic-release)
> Provides dependency information on dependency changes in a PR
## Usage
Install:
```sh
yarn add danger-plugin-yarn --dev
```
At a glance:
```js
// dangerfile.js
import yarn from 'danger-plugin-yarn'
yarn()
```
Provides 4 separate rules:
* `checkForRelease` - Provides a 🎉 when there's a package version bump.
* `checkForNewDependencies` (async) - Provides npmjs.com and `yarn why` metadata about new dependencies.
* `checkForLockfileDiff` - Will warn you when there are `dependencies` or `devDependencies` changes without a `yarn.lock` change.
* `checkForTypesInDeps` - Will fail the build if you add any `@types/[x]` to `dependencies` instead of `devDependencies`.
And exports a default function to handle all of them at once.
Note: async functions like the default one [have be to](http://danger.systems/js/guides/the_dangerfile.html#async) `schedule`'d by Danger.
## Changelog
See the GitHub [release history](https://github.com/orta/danger-plugin-yarn/releases).
## Contributing
See [CONTRIBUTING.md](contributing.md).
yarn why danger-plugin-yarn output
- Has been hoisted to "danger-plugin-yarn"
- This module exists because it's specified in "devDependencies".
- Disk size without dependencies: "80kB"
- Disk size with unique dependencies: "3.98MB"
- Disk size with transitive dependencies: "4.43MB"
- Number of shared dependencies: 7
Generated by :no_entry_sign: dangerJS