jsr-exports-lint/dist/index.d.ts

JSR exports field lint for bundlers

//#region src/lint.d.ts
/**
 * @author kazuya kawaguchi (a.k.a. @kazupon)
 * @license MIT
 */
/**
 * JSR `exports` field lint options.
 */
interface LintOptions {
  /**
   * The path to the `jsr.json` file.
   * This option specifies the path of the `jsr.json` file to be verified.
   * @default `${process.cwd()}/jsr.json`
   */
  jsrPath?: string;
  /**
   * The validation entry for `exports` field.
   * @default {}
   */
  entries?: Record<string, string>;
  /**
   * The lint current working directory.
   * @default '.''
   */
  cwd?: string;
  /**
   * Whether to suppress output messages.
   * @default false
   */
  silent?: boolean;
}
/**
 * Lint the `exports` field of the JSR manifest file.
 * @param options An lint options, about details, see {@link LintOptions}
 */
declare function lint({
  jsrPath,
  entries,
  cwd,
  silent
}?: LintOptions): Promise<void>;
//#endregion
export { lint };