https://github.com/observablehq/rollup-plugin-credits

Generate license credits
https://github.com/observablehq/rollup-plugin-credits

Last synced: 2 months ago
JSON representation

Generate license credits

• Host: GitHub
• URL: https://github.com/observablehq/rollup-plugin-credits
• Owner: observablehq
• Created: 2018-01-23T20:20:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T00:57:05.000Z (almost 2 years ago)
• Last Synced: 2025-03-28T11:51:08.615Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 345 KB
• Stars: 15
• Watchers: 2
• Forks: 2
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
### rollup-plugin-credits

[![CircleCI](https://circleci.com/gh/observablehq/rollup-plugin-credits/tree/master.svg?style=svg)](https://circleci.com/gh/observablehq/rollup-plugin-credits/tree/master) [![Greenkeeper badge](https://badges.greenkeeper.io/observablehq/rollup-plugin-credits.svg)](https://greenkeeper.io/)

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](https://spdx.org/)

- Detects authorship from, in order of preference:

  1. `author` field in package.json

  1. `authors` field in package.json

  1. `maintainers` field in package.json

  1. 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

```js

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.