Astro-licenses-report NPM

🚀 Astro — Packages licenses report generator

Downloads

Give credits to the awesome JS open-source community with this component.
It will generate a table with important informations about packages used by your project.

Uses Sebastian Roming' license-report-generator under the hood (see @wbmnky/license-report-generator).

📦 Installation

pnpm i @wbmnky/license-report-generator astro-licenses-report

🛠 Usage

---
import { LicensesReport } from 'astro-licenses-report';
// ...
---

<!-- ... -->
<body>
  <!-- Place component inside `BODY` tag -->

  <!-- All properties are optional -->
  <LicensesReport
    useDevDependencies={true}
    depth={2}
    nameText={'Nom'}
    authorText={'Auteur'}
    licenseText={'License'}
    linkText={'URL'}
  />

  <!-- ... -->
</body>

🎉 Result

<table class="licenses-report">
  <thead class="table-header">
    <tr class="row">
      <th class="header name">Package</th>
      <th class="header author">Author</th>
      <th class="header license">License</th>
      <th class="header link">URL</th>
    </tr>
  </thead>

  <tbody class="table-body">
    <tr class="row">
      <td class="column name">@astrojs/compiler</td>

      <td class="column author">withastro</td>

      <td class="column license">MIT</td>

      <td class="column link">
        <a
          class="link is-external"
          href="https://astro.build"
          target="_blank"
          rel="noopener nofollow"
        >
          https://astro.build
        </a>
      </td>
    </tr>

    <!-- ... -->
  </tbody>
</table>