fix!: exclude comments from replacement by default

sxzz · sxzz · commit 384a1c446e0f · 2026-03-02T21:52:02.000+09:00
closes #114
diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "rolldown-string": "^0.2.1",
     "tinyglobby": "^0.2.15",
     "unplugin": "^3.0.0",
-    "unplugin-replace": "^0.6.3"
+    "unplugin-replace": "^0.7.0"
   },
   "devDependencies": {
     "@babel/types": "^7.29.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/core/options.ts b/src/core/options.ts
@@ -1,5 +1,6 @@
 import process from 'node:process'
 import type { FilterPattern } from 'unplugin'
+import type { Options as ReplaceOptions } from 'unplugin-replace'
 
 /**
  * Represents the options for the plugin.
@@ -23,6 +24,8 @@ export interface Options {
    * @default ['**\/*.{cts,mts,ts,tsx}', '!**\/node_modules']
    */
   scanPattern?: string | string[]
+
+  replaceOptions?: ReplaceOptions
 }
 
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U
@@ -52,5 +55,7 @@ export function resolveOptions(options: Options): OptionsResolved {
       '**/*.{cts,mts,ts,tsx}',
       '!**/node_modules',
     ],
+
+    replaceOptions: options.replaceOptions || {},
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -25,6 +25,7 @@ const InlineEnum: UnpluginInstance<Options | undefined, true> = createUnplugin<
         include: options.include,
         exclude: options.exclude,
         values: defines,
+        ...options.replaceOptions,
       },
       meta,
     ),
diff --git a/tests/__snapshots__/esbuild.spec.ts.snap b/tests/__snapshots__/esbuild.spec.ts.snap
@@ -5,7 +5,12 @@ exports[`esbuild 1`] = `
 var values = ["foo", 100, 4];
 
 // tests/fixtures/main.ts
+function jsdoc() {
+}
 console.log("foo", 100, 4);
 console.log(values);
+export {
+  jsdoc
+};
 "
 `;
diff --git a/tests/__snapshots__/rolldown.test.ts.snap b/tests/__snapshots__/rolldown.test.ts.snap
@@ -7,7 +7,12 @@ const values = [
 	100,
 	4
 ];
+/**
+* TestEnum.A
+*/
+function jsdoc() {}
 console.log("foo", 100, 4);
 console.log(values);
+export { jsdoc };
 "
 `;
diff --git a/tests/__snapshots__/rollup.spec.ts.snap b/tests/__snapshots__/rollup.spec.ts.snap
@@ -8,7 +8,13 @@ const values = [
 	4
 ];
 
+/**
+* TestEnum.A
+*/
+function jsdoc() {}
 console.log("foo", 100, 4);
 console.log(values);
+
+export { jsdoc };
 "
 `;
diff --git a/tests/fixtures/main.ts b/tests/fixtures/main.ts
@@ -1,4 +1,9 @@
 import { values, TestEnum } from './mod'
 
+/**
+ * TestEnum.A
+ */
+export function jsdoc() {}
+
 console.log(TestEnum.A, TestEnum.B, TestEnum.C)
 console.log(values)
diff --git a/tests/scan-enums.spec.ts b/tests/scan-enums.spec.ts
@@ -10,6 +10,7 @@ describe('scanEnums', () => {
     exclude: [],
     scanDir: path.resolve(__dirname, 'enums'),
     scanPattern: ['**/*.ts', '**/*.tsx'],
+    replaceOptions: {},
   }
 
   let fsEnums: EnumData

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,12 @@ const values = [`
`7`	`7`	`100,`
`8`	`8`	`4`
`9`	`9`	`];`
	`10`	`+/**`
	`11`	`+* TestEnum.A`
	`12`	`+*/`
	`13`	`+function jsdoc() {}`
`10`	`14`	`console.log("foo", 100, 4);`
`11`	`15`	`console.log(values);`
	`16`	`+export { jsdoc };`
`12`	`17`	`"`
`13`	`18`	`;
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,13 @@ const values = [`
`8`	`8`	`4`
`9`	`9`	`];`
`10`	`10`
	`11`	`+/**`
	`12`	`+* TestEnum.A`
	`13`	`+*/`
	`14`	`+function jsdoc() {}`
`11`	`15`	`console.log("foo", 100, 4);`
`12`	`16`	`console.log(values);`
	`17`	`+`
	`18`	`+export { jsdoc };`
`13`	`19`	`"`
`14`	`20`	`;
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ describe('scanEnums', () => {`
`10`	`10`	`exclude: [],`
`11`	`11`	`scanDir: path.resolve(__dirname, 'enums'),`
`12`	`12`	`scanPattern: ['*/.ts', '*/.tsx'],`
	`13`	`+ replaceOptions: {},`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`let fsEnums: EnumData`