Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/g00glen00b/gatsby-source-license
Gatsby source plugin for pulling software license information from dependencies.
https://github.com/g00glen00b/gatsby-source-license
gatsby gatsby-plugin gatsby-source gatsby-source-plugin gatsbyjs
Last synced: about 11 hours ago
JSON representation
Gatsby source plugin for pulling software license information from dependencies.
- Host: GitHub
- URL: https://github.com/g00glen00b/gatsby-source-license
- Owner: g00glen00b
- Archived: true
- Created: 2020-03-18T22:06:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-01T13:32:00.000Z (almost 4 years ago)
- Last Synced: 2024-09-16T04:43:28.950Z (4 months ago)
- Topics: gatsby, gatsby-plugin, gatsby-source, gatsby-source-plugin, gatsbyjs
- Language: JavaScript
- Size: 219 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gatsby-source-license
[](https://github.com/g00glen00b/gatsby-source-license/actions?query=workflow%3A%22Continuous+integration%22)
[](https://snyk.io/test/github/g00glen00b/gatsby-source-license)
[](https://codecov.io/gh/g00glen00b/gatsby-source-license)
[](https://badge.fury.io/js/gatsby-source-license)
Gatsby source plugin for pulling software license information from dependencies.
The plugin reads the dependencies from `package.json`, and will check the `node_modules` directories for these dependencies and their licenses.
In addition, it also checks nested dependencies, and should work for npm 3.x and higher.
## Install
This plugin can be installed by using:
```none
npm install --save gatsby-source-license
```
To be used, it requires at least **Node.js 11.0.0** and **npm 3.0.0**.
## How to use
```javascript
// In your gatsby-config.js
module.exports = {
plugins: [
{
resolve: `gatsby-source-license`,
options: {
// The amount of nested dependencies that should be checked.
// 1 = Only the license within the current package.json is sourced
// 2 = Licenses of direct dependencies and the current package are sourced
// Infinity = All dependencies will be checked.
// Default = Infinity
depth: Infinity,
// Indicates whether the own software license should be sourced or not.
// Be aware that this may conflict with maxDepth.
// If you set this to true, and have a maxDepth of 1, no software license will be sourced.
// Default = true
excludeSelf: true,
// A list of excluded dependencies, using the format [email protected].
// For example, if we want to exclude ESLint version 6.8.0, we use [`[email protected]`]
// Default = []
excludedDependencies: [],
// Indicates whether normal dependencies should be sourced or not.
// If you set this to true, normal dependencies will be sourced.
// Default = true
includeDependencies: true,
// Indicates whether development dependencies should be sourced or not.
// If you set this this to true, development dependencies (dependencies installed with --save-dev) will be sourced.
// Default = false
includeDevDependencies: false
}
}
]
};
```
## How to query
Once done, you can query for the software licenses your project uses, by using the following query:
```graphql
query {
allSoftwareLicenseLibrary {
edges {
node {
license
label
url
name
version
}
}
}
}
```
This would return a JSON structure similar to:
```json
{
"allSoftwareLicenseLibrary": {
"edges": [
{
"node": {
"license": "MIT",
"label": "[email protected]",
"url": "https://github.com/g00glen00b/gatsby-source-license",
"name": "gatsby-source-license",
"version": "0.0.1"
}
}
]
}
}
```