feat: rollup plugin copyMeta

Author: EqualMa

src/rollup/bundle.ts

@@ -1,5 +1,9 @@
 import { promises as fsp } from "fs";
-import { compilePlugins } from "./common-plugins";
+import {
+  commonPlugins,
+  CommonPluginsOptions,
+  compilePlugins,
+} from "./common-plugins";
 import { terser } from "rollup-plugin-terser";
 import { pascalCase } from "pascal-case";
 import commonjs from "@rollup/plugin-commonjs";
@@ -71,7 +75,8 @@ export interface RollupBundleOutputConfig {
 }
 
 export interface RollupBundleOptions
-  extends Partial<ResolvableDict<RollupBundleOutputConfig>> {
+  extends Partial<ResolvableDict<RollupBundleOutputConfig>>,
+    CommonPluginsOptions {
   input?: Resolvable<string | undefined>;
   output?: Resolvable<GenOutputOptions, [RollupBundleOutputConfig]>;
   inputBaseDir?: string;
@@ -92,6 +97,7 @@ export async function rollupBundle({
   outputRootDir = "bundle",
   min = false,
   globalNamespace = inferGlobalNamespace,
+  ...commonPluginsOpts
 }: RollupBundleOptions = {}): Promise<RollupOptions> {
   const { input: inputFile, ...conf } = await resolveDict({
     input,
@@ -115,6 +121,7 @@ export async function rollupBundle({
       ...compilePlugins(),
       nodeResolve(),
       commonjs(),
+      ...commonPlugins({ outputBaseDir, ...commonPluginsOpts }),
     ],
   };
 }

src/rollup/common-plugins.ts

@@ -2,6 +2,8 @@ import typescript, { RollupTypescriptOptions } from "@rollup/plugin-typescript";
 import babel, { RollupBabelInputPluginOptions } from "@rollup/plugin-babel";
 import json from "@rollup/plugin-json";
 import type { Plugin } from "rollup";
+import { copyMeta, CopyMetaPluginOptions } from "./copy-meta";
+import { isTruthy } from "../util/func";
 
 export interface CompilePluginsOptions {
   typescript?: Partial<RollupTypescriptOptions>;
@@ -30,3 +32,24 @@ export function compilePlugins(options: CompilePluginsOptions = {}): Plugin[] {
     }),
   ];
 }
+
+export interface CommonPluginsOptions {
+  outputBaseDir?: string;
+  /**
+   * whether to copy meta files to outputBaseDir.
+   *
+   * e.g. `README*` `CHANGELOG*` `LICENSE*`
+   */
+  copyMeta?: boolean | CopyMetaPluginOptions;
+}
+
+export function commonPlugins({
+  outputBaseDir = "dist",
+  copyMeta: copyMetaOpts,
+}: CommonPluginsOptions = {}): Plugin[] {
+  return [
+    copyMetaOpts
+      ? copyMeta(copyMetaOpts === true ? { to: outputBaseDir } : copyMetaOpts)
+      : null,
+  ].filter(isTruthy);
+}

src/rollup/copy-meta.ts

@@ -0,0 +1,47 @@
+import { PluginImpl } from "rollup";
+import glob from "fast-glob";
+import * as fs from "fs";
+import { promises as fsp } from "fs";
+import * as path from "path";
+
+export const COPY_META_DEFAULT_SOURCE = ["README*", "LICENSE*", "CHANGELOG*"];
+
+export interface CopyMetaPluginOptions {
+  to: string;
+  source?: string | string[];
+  caseSensitiveMatch?: boolean;
+  overwriteExisting?: boolean;
+}
+
+export const copyMeta: PluginImpl<CopyMetaPluginOptions> = (
+  {
+    //
+    to,
+    source = COPY_META_DEFAULT_SOURCE,
+    caseSensitiveMatch = false,
+    overwriteExisting = false,
+  } = { to: "" },
+) => ({
+  name: "@tlib/rollup-plugin-copy-meta",
+  buildEnd: async () => {
+    if (!to) throw new Error("copyMeta options.dir cannot be falsy");
+
+    await fsp.mkdir(to, { recursive: true });
+
+    const files = await glob(source, {
+      onlyFiles: true,
+      caseSensitiveMatch,
+      unique: true,
+    });
+
+    const mode = overwriteExisting ? undefined : fs.constants.COPYFILE_EXCL;
+
+    await Promise.all(
+      files.map((file) => {
+        const filename = path.basename(file);
+        const dest = path.join(to, filename);
+        return fsp.copyFile(file, dest, mode);
+      }),
+    );
+  },
+});

src/rollup/dts.ts

@@ -2,8 +2,9 @@ import type { InputOption, RollupOptions } from "rollup";
 import { chunkFileNames } from "../util/common";
 import { getEntryFiles } from "./entry";
 import { Resolvable, resolve } from "../util/resolvable";
+import { commonPlugins, CommonPluginsOptions } from "./common-plugins";
 
-export interface RollupDtsOptions {
+export interface RollupDtsOptions extends CommonPluginsOptions {
   inputBaseDir?: string;
   outputBaseDir?: string;
   input?: Resolvable<InputOption | undefined>;
@@ -13,6 +14,7 @@ export async function rollupDts({
   inputBaseDir = "src",
   outputBaseDir = "dist",
   input,
+  ...commonPluginsOpts
 }: RollupDtsOptions = {}): Promise<RollupOptions> {
   const dts = (await import("rollup-plugin-dts")).default;
 
@@ -32,6 +34,10 @@ export async function rollupDts({
           .replace(/\.js$/, ".d.ts");
       },
     },
-    plugins: [dts()],
+    plugins: [
+      //
+      dts(),
+      ...commonPlugins({ outputBaseDir, ...commonPluginsOpts }),
+    ],
   };
 }

src/rollup/node.ts

@@ -1,6 +1,10 @@
 import externals from "rollup-plugin-node-externals";
 import generatePackageJson from "rollup-plugin-generate-package-json";
-import { compilePlugins } from "./common-plugins";
+import {
+  commonPlugins,
+  CommonPluginsOptions,
+  compilePlugins,
+} from "./common-plugins";
 import { getEntryPointsFromRollup, getPkgJsonBaseContents } from "./gen-pkg";
 import { chunkFileNames } from "../util/common";
 import type {
@@ -20,7 +24,7 @@ const commonOutputOptions: OutputOptions = {
   chunkFileNames,
 };
 
-export interface RollupNodeOptions {
+export interface RollupNodeOptions extends CommonPluginsOptions {
   inputBaseDir?: string;
   inputPatterns?: MatchFilesPatterns;
   input?: Resolvable<InputOption | undefined>;
@@ -58,6 +62,7 @@ export async function rollupNode({
   outputBaseDir = "dist",
   output,
   outputRootDir,
+  ...commonPluginsOpts
 }: RollupNodeOptions = {}): Promise<RollupOptions> {
   const inputFiles =
     (await resolve(input)) ??
@@ -102,6 +107,7 @@ export async function rollupNode({
         outputFolder: outputRootDir,
       }),
       pkgModuleAfterBuild({ baseDir: joinPath(outputRootDir, "es") }),
+      ...commonPlugins({ outputBaseDir, ...commonPluginsOpts }),
     ],
   };
 }

src/rollup/options.ts

@@ -3,8 +3,10 @@ import { rollupBundle, RollupBundleOptions } from "./bundle";
 import { rollupNode, RollupNodeOptions } from "./node";
 import { rollupDts, RollupDtsOptions } from "./dts";
 import { getEntryFiles, MatchFilesPatterns } from "./entry";
+import { isTruthy } from "../util/func";
+import { CommonPluginsOptions } from "./common-plugins";
 
-export interface GenRollupOptions {
+export interface GenRollupOptions extends CommonPluginsOptions {
   inputBaseDir?: string;
   inputPatterns?: MatchFilesPatterns;
   outputBaseDir?: string;
@@ -20,9 +22,22 @@ export async function rollupOptions({
   bundle,
   node,
   dts,
+  copyMeta,
 }: GenRollupOptions = {}): Promise<RollupOptions[]> {
+  // take copyMeta options so that it can only be used once
+  const takeCopyMeta = () => {
+    const v = copyMeta;
+    copyMeta = undefined;
+    return v;
+  };
+
   const bundleOptions: RollupBundleOptions | null = bundle
-    ? { outputBaseDir, inputBaseDir, ...(bundle === true ? null : bundle) }
+    ? {
+        outputBaseDir,
+        inputBaseDir,
+        copyMeta: takeCopyMeta(),
+        ...(bundle === true ? null : bundle),
+      }
     : null;
 
   let cachedInput: Promise<InputOption> | null = null;
@@ -42,6 +57,7 @@ export async function rollupOptions({
         inputBaseDir,
         inputPatterns,
         outputBaseDir,
+        copyMeta: takeCopyMeta(),
         ...(node === true ? null : node),
       }
     : null;
@@ -51,6 +67,7 @@ export async function rollupOptions({
         input,
         inputBaseDir,
         outputBaseDir,
+        copyMeta: takeCopyMeta(),
         ...(dts === true ? null : dts),
       }
     : null;