Package to Banner

一个将 npm 包信息（package.json）转换为 banner 信息的工具。

📦 安装依赖

npm install @xiaohuohumax/package-to-banner

📖 使用方法

工具函数

import { packageToBanner } from '@xiaohuohumax/package-to-banner'

console.log(packageToBanner())
// 输出：
/**
 * name: @xiaohuohumax/package-to-banner
 * description: 一个将 npm 包信息（package.json）转换为 banner 信息的工具。
 * version: v1.0.0
 * author: xiaohuohumax (https://github.com/xiaohuohumax)
 * license: MIT
 * homepage: https://github.com/xiaohuohumax/package-to-banner#readme
 */

rollup 插件

import packageToBanner from '@xiaohuohumax/package-to-banner/rollup'
import { defineConfig } from 'rollup'

export default defineConfig({
  plugins: [packageToBanner()],
})

vite 插件

import packageToBanner from '@xiaohuohumax/package-to-banner/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [packageToBanner()],
})

⚙️ 配置参数

| 参数名 | 类型 | 默认值 | 说明 | | ------ | --------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------- | | custom | (string \| (p: Package) => string \| undefined)[] | undefined | 自定义信息，可以是一个字符串数组，也可以是一个函数数组，函数接收一个 Package 对象作为参数，返回一个字符串。 |

示例

只显示 name 和 type 信息

import { packageToBanner } from '@xiaohuohumax/package-to-banner'

console.log(packageToBanner({
  custom: [
    'name',
    p => p.type && `type: ${p.type}`,
  ],
}))
// 输出：
/**
 * name: @xiaohuohumax/package-to-banner
 * type: module
 */

♻ 其他说明

如果觉得本脚本对你有帮助，欢迎点个 ⭐ Star 支持一下！