ひよこまめ

Viteでライセンス情報を記載したファイルを生成する

利用するOSSライブラリのライセンス情報を記述したファイルを生成したい。
バンドラーでMinifyすると、意図せずにライセンス表記が消えてしまうことがありうるからである。

このページでは、rollup-plugin-licenseプラグインを使って、ライセンス情報を記述したファイルを生成する方法を説明する。

バンドラーを使ってMinifyすることの問題点

たとえばReactを利用している場合、Viteでバンドルした後のファイルには、次のようなライセンス情報のコメントが出力される。

vender-[hash].js
var m={exports:{}},u={};/**
 * @license React
 * react.production.js
 *
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */ ...省略...

このようなコメントを出力するには、ライブラリ側の配布物のコードに、ライセンス情報のコメントが書かれている必要がある。
しかし、ライブラリによっては、ライセンス情報のコメントを配布物のコードに表記していないことがある。

また、Minify後にもコメントを残すフォーマットは、バンドラーによっても異なる。
一般的には、ブロックコメントを/*!で始めたり、ブロックコメント内に@licenseを記述したりすると、そのコメントを削除しないバンドラーが多い。

  • /*!で始まるブロック 
    /*!
* chick-p product
* Copyright (c) chick-p
*/
  • @licenseが記述されているブロック 
    /**
* @license chick-p product
* Copyright (c) chick-p
*/

OSSライブラリ側がそのようなフォーマットでライセンス表記をしていないと、Minify時にライセンス表記が消えてしまう。
そもそもの配布物にライセンス表記がない、または、意図せずMinify後に消えてしまうことで、ライセンス違反になってしまう可能性がありうる。

Viteでライセンスファイルを生成する

ライセンス情報を記述したファイルを自分でメンテナンスするのは面倒なので、自動的に生成できることが望ましい。
Viteの場合、rollup-plugin-licenseを使うことで、バンドルしたOSSライブラリのライセンス情報を、別のドキュメントファイルに生成できる。

rollup-plugin-license - npm
Rollup plugin to add license banner to the final bundle and output third party licenses. Latest version: 3.5.3, last published: 4 months ago. Start using rollup-plugin-license in your project by running `npm i rollup-plugin-license`. There are 61 other projects in the npm registry using rollup-plugin-license.
npm

rollup-plugin-licenseの設定情報は、Viteの設定ファイルのlicenseプロパティに記述する。

vite.config.mjs
import { defineConfig } from "vite";
import license from "rollup-plugin-license";
import path from "node:path";

export default defineConfig({
  build: {
    // 省略
  },
  plugins: [
    license({
      sourcemap: true,
      thirdParty: {
        includePrivate: true,
        multipleVersions: true,
        output: {
          file: path.join(__dirname, "dist", "license.txt"),
          encoding: "utf-8",
        },
      },
    }),
  ]
});

この設定内容でビルドコマンドを実行すると、次の内容のファイルがdist/license.txtとして出力される。

dist/license.txt
Name: react
Version: 19.0.0
License: MIT
Private: false
Description: React is a JavaScript library for building user interfaces.
Repository: https://github.com/facebook/react.git
Homepage: https://react.dev/
License Copyright:
===

MIT License

Copyright (c) Meta Platforms, Inc. and affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

参考情報