observablehq / rollup-plugin-credits Goto Github PK

Generate license credits

JavaScript 100.00%

rollup-plugin-credits's Introduction

rollup-plugin-credits

Generate 'credits' for included code: parses SPDX licenses, groups dependencies by license, groups licensed dependencies by author. In the interest of creating concise credits pages.

Detects license type from the license specification in package.json, which is parsed as SPDX
Detects authorship from, in order of preference:
1. author field in package.json
2. authors field in package.json
3. maintainers field in package.json
4. Parsing a license file, one of
- LICENSE
- LICENSE.md
- LICENSE.txt
- license
- license.md
- license.txt

Instead of a code bundle, this produces a bundle of credits output. Typically you'll run this to create a source file that powers your 'credits' page. The format of this output is as an ES module with a default export. The export is a list of licenses with { license, modules } keys, which contain a list of authors with { author, modules } keys.

Example output

export default [
  {
    license: { license: "MIT" },
    modules: [
      {
        author: "James Halliday",
        modules: [
          "resumer",
          "object-inspect"
        ]
      },
      { author: "Dominic Tarr", modules: ["through"] },
      {
        author: "Marijn Haverbeke and Ingvar Stepanyan",
        modules: ["acorn"]
      }
    ]
  },
  {
    license: { license: "ISC" },
    modules: [{ author: "Isaac Z. Schlueter", modules: ["inherits"] }]
  }
];

Options

whitelist: an array or Set of SPDX license identifiers that are allowed in the list. If provided and a non-whitelisted dependency is encountered, the transform will reject.

rollup-plugin-credits's People

Contributors

Stargazers

Watchers

Forkers

banben stjordanis

rollup-plugin-credits's Issues

An in-range update of rollup-plugin-commonjs is breaking the build 🚨

The devDependency rollup-plugin-commonjs was updated from `10.0.1` to `10.0.2`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup-plugin-commonjs is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: Your tests failed on CircleCI (Details).

Commits

The new version differs by 3 commits.

de40daa 10.0.2
e741130 Update changelog
8f91234 Support preserveSymlinks: false (fixes #400) (#401)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Update for rollup 1

[ROLLUP] No name was provided for external module '/Users/tmcw/s/notebook/build/credits.js' in output.globals – guessing 'credits'
[ROLLUP] The transformBundle hook used by plugin rollup-plugin-credits is deprecated. The renderChunk hook should be used instead.

An in-range update of rollup is breaking the build 🚨

The devDependency rollup was updated from `1.14.2` to `1.14.3`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rollup is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: Your tests failed on CircleCI (Details).

Release Notes for v1.14.3

2019-06-06

Bug Fixes

Generate correct external imports when importing from a directory that would be above the root of the current working directory (#2902)

Pull Requests

#2902: Use browser relative path algorithm for chunks (@lukastaegert)

Commits

The new version differs by 4 commits.

c68bd95 1.14.3
d79aa57 Update changelog
7179390 Use browser relative path algorithm for chunks (#2902)
b1df517 Add funding button

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Ignore packages with private: true

An in-range update of acorn is breaking the build 🚨

The devDependency acorn was updated from `6.2.0` to `6.2.1`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

acorn is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: Your tests failed on CircleCI (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Support license variations

All of these should be valid and yield 'Who Corp' from a given LICENSE file.

observablehq / rollup-plugin-credits Goto Github PK

rollup-plugin-credits's Introduction

rollup-plugin-credits

Example output

Options

rollup-plugin-credits's People

Contributors

Stargazers

Watchers

Forkers

rollup-plugin-credits's Issues

The devDependency rollup-plugin-commonjs was updated from 10.0.1 to 10.0.2.

The devDependency rollup was updated from 1.14.2 to 1.14.3.

Bug Fixes

Pull Requests

The devDependency acorn was updated from 6.2.0 to 6.2.1.

Recommend Projects

Recommend Topics

Recommend Org

The devDependency rollup-plugin-commonjs was updated from `10.0.1` to `10.0.2`.

The devDependency rollup was updated from `1.14.2` to `1.14.3`.

The devDependency acorn was updated from `6.2.0` to `6.2.1`.