feat(preprocess-auto-slug): allow skipping per file with ignore comment

Author: vnphanquang

.changeset/sour-drinks-behave.md

@@ -0,0 +1,5 @@
+---
+'@svelte-put/preprocess-auto-slug': patch
+---
+
+allow skipping processing with `<!-- ignore @svelte-put/preprocess-auto-slug -->`

packages/preprocessors/auto-slug/api/docs/preprocess-auto-slug.autoslugoptions.files.md

@@ -11,3 +11,8 @@ filter which files the preprocessor will run on
 ```typescript
 files: (options: Parameters<MarkupPreprocessor>[0]) => boolean;
 ```
+
+## Remarks
+
+Alternatively, you can skip processing per file by adding `<!-- ignore @svelte-put/preprocess-auto-slug -->` somewhere in the file.
+

packages/preprocessors/auto-slug/src/auto-slug.ts

@@ -32,6 +32,7 @@ export function autoSlug(input: AutoSlugInput = {}): PreprocessorGroup {
     markup(o) {
       const { content, filename } = o;
       if (!options.files(o)) return;
+      if (content.includes('<!-- ignore @svelte-put/preprocess-auto-slug -->')) return;
       const s = new MagicString(content);
       const ast = parse(content, { filename });
       const slugger = new BananaSlug();

packages/preprocessors/auto-slug/src/auto-slug.types.ts

@@ -74,6 +74,11 @@ export interface SlugResolverInput {
 export interface AutoSlugOptions {
   /**
    * filter which files the preprocessor will run on
+   *
+   * @remarks
+   *
+   * Alternatively, you can skip processing per file by adding
+   * `<!-- ignore @svelte-put/preprocess-auto-slug -->` somewhere in the file.
    */
   files: (options: Parameters<MarkupPreprocessor>[0]) => boolean;
   /** target tag, default to all heading tags */