docs: add jsdoc

Author: sxzz

src/core/options.ts

@@ -1,6 +1,9 @@
 import type { FilterPattern } from '@rollup/pluginutils'
 import type { TranspileOptions } from 'typescript'
 
+/**
+ * Represents the options for the plugin.
+ */
 export type Options = {
   include?: FilterPattern
   exclude?: FilterPattern

src/core/transformer.ts

@@ -13,6 +13,9 @@ function tryImport<T>(pkg: string): Promise<T | null> {
   }
 }
 
+/**
+ * Transform isolated declarations with `oxc-transform`.
+ */
 export async function oxcTransform(
   id: string,
   code: string,
@@ -29,6 +32,9 @@ export async function oxcTransform(
   return oxc.isolatedDeclaration(id, code, { sourcemap: false })
 }
 
+/**
+ * Transform isolated declarations with `@swc/core`.
+ */
 export async function swcTransform(
   id: string,
   code: string,
@@ -70,6 +76,9 @@ export async function swcTransform(
   }
 }
 
+/**
+ * Transform isolated declarations with `typescript`.
+ */
 export async function tsTransform(
   id: string,
   code: string,

src/esbuild.ts

@@ -1,3 +1,21 @@
+/**
+ * This entry file is for esbuild plugin.
+ *
+ * @module
+ */
+
 import { IsolatedDecl } from './index'
 
+/**
+ * Esbuild plugin
+ *
+ * @example
+ * ```ts
+ * import { build } from 'esbuild'
+ *
+ * build({
+ *   plugins: [require('unplugin-isolated-decl/esbuild')()],
+ * })
+ * ```
+ */
 export default IsolatedDecl.esbuild as typeof IsolatedDecl.esbuild

src/farm.ts

@@ -1,4 +1,23 @@
+/**
+ * This entry file is for Farm plugin.
+ *
+ * @module
+ */
 /* eslint-disable import/no-default-export */
+
 import { IsolatedDecl } from './index'
 
+/**
+ * Farm plugin
+ *
+ * @example
+ * ```ts
+ * // farm.config.js
+ * import IsolatedDecl from 'unplugin-isolated-decl/farm'
+ *
+ * export default {
+ *   plugins: [IsolatedDecl()],
+ * }
+ * ```
+ */
 export default IsolatedDecl.farm as typeof IsolatedDecl.farm

src/index.ts

@@ -1,3 +1,8 @@
+/**
+ * This entry file is for main unplugin.
+ * @module
+ */
+
 import { mkdir, readFile, writeFile } from 'node:fs/promises'
 import path from 'node:path'
 import { createFilter } from '@rollup/pluginutils'
@@ -33,6 +38,9 @@ import type {
 
 export type { Options }
 
+/**
+ * The main unplugin instance.
+ */
 export const IsolatedDecl: UnpluginInstance<Options | undefined, false> =
   createUnplugin((rawOptions = {}) => {
     const options = resolveOptions(rawOptions)

src/rolldown.ts

@@ -1,3 +1,22 @@
+/**
+ * This entry file is for Rolldown plugin.
+ *
+ * @module
+ */
+
 import { IsolatedDecl } from './index'
 
+/**
+ * Rolldown plugin
+ *
+ * @example
+ * ```ts
+ * // rolldown.config.js
+ * import IsolatedDecl from 'unplugin-isolated-decl/rolldown'
+ *
+ * export default {
+ *   plugins: [IsolatedDecl()],
+ * }
+ * ```
+ */
 export default IsolatedDecl.rolldown as typeof IsolatedDecl.rolldown

src/rollup.ts

@@ -1,3 +1,22 @@
+/**
+ * This entry file is for Rollup plugin.
+ *
+ * @module
+ */
+
 import { IsolatedDecl } from './index'
 
+/**
+ * Rollup plugin
+ *
+ * @example
+ * ```ts
+ * // rollup.config.js
+ * import IsolatedDecl from 'unplugin-isolated-decl/rollup'
+ *
+ * export default {
+ *   plugins: [IsolatedDecl()],
+ * }
+ * ```
+ */
 export default IsolatedDecl.rollup as typeof IsolatedDecl.rollup

src/vite.ts

@@ -1,3 +1,22 @@
+/**
+ * This entry file is for Vite plugin.
+ *
+ * @module
+ */
+
 import { IsolatedDecl } from './index'
 
+/**
+ * Vite plugin
+ *
+ * @example
+ * ```ts
+ * // vite.config.js
+ * import IsolatedDecl from 'unplugin-isolated-decl/vite'
+ *
+ * export default {
+ *   plugins: [IsolatedDecl()],
+ * }
+ * ```
+ */
 export default IsolatedDecl.vite as typeof IsolatedDecl.vite