feat(bi-link): exclude patterns (#458)

* Exclude Patterns for Bi-Directional Links

Ads configurable exclude patterns for bi-directional link searching.

* Update packages/markdown-it-bi-directional-links/src/index.ts

Co-authored-by: Neko <[email protected]>

* Update packages/markdown-it-bi-directional-links/src/index.ts

Co-authored-by: Neko <[email protected]>

* chore: update packages/markdown-it-bi-directional-links/src/index.ts

---------

Co-authored-by: Neko <[email protected]>

Author: JBurning

docs/pages/en/integrations/markdown-it-bi-directional-links/getting-started.md

@@ -102,6 +102,12 @@ interface BiDirectionalLinksOptions {
    * @default '*.md, *.png, *.jpg, *.jpeg, *.gif, *.svg, *.webp, *.ico, *.bmp, *.tiff, *.apng, *.avif, *.jfif, *.pjpeg, *.pjp, *.png, *.svg, *.webp, *.xbm'
    */
   includesPatterns?: string[]
+  /**
+   * Excludes files added from `includePatterns` from being searched if it matches at least one of these patterns.
+   *
+   * @default '_*, dist, node_modules'
+   */
+  excludesPatterns?: string[]
   /**
    * Whether to include debugging logs.
    *

docs/pages/zh-CN/integrations/markdown-it-bi-directional-links/getting-started.md

@@ -98,6 +98,12 @@ interface BiDirectionalLinksOptions {
    * @default '*.md, *.png, *.jpg, *.jpeg, *.gif, *.svg, *.webp, *.ico, *.bmp, *.tiff, *.apng, *.avif, *.jfif, *.pjpeg, *.pjp, *.png, *.svg, *.webp, *.xbm'
    */
   includesPatterns?: string[]
+  /**
+   * Excludes files added from `includePatterns` from being searched if it matches at least one of these patterns.
+   *
+   * @default '_*, dist, node_modules'
+   */
+  excludesPatterns?: string[]
   /**
    * Whether to include debugging logs.
    *

packages/markdown-it-bi-directional-links/src/index.ts

@@ -192,6 +192,12 @@ export interface BiDirectionalLinksOptions {
    * @default '*.md, *.png, *.jpg, *.jpeg, *.gif, *.svg, *.webp, *.ico, *.bmp, *.tiff, *.apng, *.avif, *.jfif, *.pjpeg, *.pjp, *.png, *.svg, *.webp, *.xbm, *.mp3, *.flac, *.wav, *.ogg, *.opus, *.mp4, *.webm, *.acc, *.mp4, *.webm, *.mov, *.mkv, *.ogg'
    */
   includesPatterns?: string[]
+  /**
+   * Excludes files added from `includePatterns` from being searched if it matches at least one of these patterns.
+   *
+   * @default '_*, dist, node_modules'
+   */
+  excludesPatterns?: string[]
   /**
    * Whether to include debugging logs.
    *
@@ -229,12 +235,14 @@ export interface BiDirectionalLinksOptions {
  * @param options.dir - The directory to search for bi-directional links.
  * @param options.baseDir - The base directory joined as href for bi-directional links.
  * @param options.includesPatterns - The glob patterns to search for bi-directional links.
+ * @param options.excludesPatterns - The glob patterns to exclude files from search.
  * @returns A markdown-it plugin.
  */
 export const BiDirectionalLinks: (options?: BiDirectionalLinksOptions) => PluginSimple = (options) => {
   const rootDir = options?.dir ?? cwd()
   const baseDir = options?.baseDir ?? '/'
   const includes = options?.includesPatterns ?? []
+  const excludes = options?.excludesPatterns ?? ['_*', 'dist', 'node_modules']
   const debugOn = options?.debug ?? false
   const noNoMatchedFileWarning = options?.noNoMatchedFileWarning ?? false
   const stillRenderNoMatched = options?.stillRenderNoMatched ?? false
@@ -254,11 +262,7 @@ export const BiDirectionalLinks: (options?: BiDirectionalLinksOptions) => Plugin
     onlyFiles: true,
     absolute: true,
     cwd: rootDir,
-    ignore: [
-      '_*',
-      'dist',
-      'node_modules',
-    ],
+    ignore: excludes,
   })
 
   for (const file of files) {