FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat!: exclude comments from replacement by default, add includeComme… · unplugin/unplugin-replace@212ea05 · GitHub

/ unplugin-replace Public

Commit 212ea05

Browse files
sxzz
committed
feat!: exclude comments from replacement by default, add includeComments option
1 parent 82a9283 commit 212ea05

11 files changed

Lines changed: 61 additions & 7 deletions

File tree

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
"prepublishOnly": "pnpm run build"
6363
},
6464
"dependencies": {
65+
"js-tokens": "^10.0.0",
6566
"rolldown-string": "^0.2.1",
6667
"unplugin": "^3.0.0"
6768
},

‎pnpm-lock.yaml‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/core/options.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ export interface BaseOptions {
4545
*/
4646
values?: ReplaceMap | ReplaceItem[]
4747
enforce?: 'pre' | 'post' | undefined
48+
/**
49+
* By default, comments are ignored by the plugin.
50+
* Setting this option to `true` will include comments in the replacement process.
51+
*/
52+
includeComments?: boolean
4853
}
4954

5055
export interface Options extends BaseOptions {
@@ -80,6 +85,7 @@ export function resolveOptions(options: Options): OptionsResolved {
8085
objectGuards: options.objectGuards ?? false,
8186
values: getReplacements(),
8287
enforce: 'enforce' in options ? options.enforce : 'pre',
88+
includeComments: options.includeComments ?? false,
8389
}
8490

8591
function getReplacements() {

‎src/index.ts‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* @module
44
*/
55

6+
import jsTokens from 'js-tokens'
67
import { withMagicString } from 'rolldown-string'
78
import { createUnplugin, type UnpluginInstance } from 'unplugin'
89
import { resolveOptions, type Options, type ReplaceItem } from './core/options'
@@ -24,6 +25,7 @@ const plugin: UnpluginInstance<Options | undefined, false> = createUnplugin<
2425
delimiters,
2526
objectGuards,
2627
preventAssignment,
28+
includeComments,
2729
} = options
2830
const stringValues = options.values.filter(
2931
(value): value is ReplaceItem<string> => typeof value.find === 'string',
@@ -58,9 +60,25 @@ const plugin: UnpluginInstance<Options | undefined, false> = createUnplugin<
5860
handler: withMagicString(function (s, id) {
5961
if (!values.length) return
6062

61-
const code = s.toString()
62-
let match: RegExpExecArray | null
63+
let code = ''
64+
if (includeComments) {
65+
code = s.toString()
66+
} else {
67+
const tokens = jsTokens(s.toString(), { jsx: /\.[jt]sx?$/.test(id) })
68+
for (const token of tokens) {
69+
if (
70+
token.type === 'MultiLineComment' ||
71+
token.type === 'SingleLineComment' ||
72+
token.type === 'HashbangComment'
73+
) {
74+
code += ' '.repeat(token.value.length)
75+
} else {
76+
code += token.value
77+
}
78+
}
79+
}
6380

81+
let match: RegExpExecArray | null
6482
for (const { find, replacement } of values) {
6583
while ((match = find.exec(code))) {
6684
const start = match.index

‎tests/__snapshots__/esbuild.test.ts.snap‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ exports[`esbuild 1`] = `
55
var platform = "darwin";
66
console.log('hello "darwin"', platform);
77
console.log(DEV);
8+
function x() {
9+
}
810
export {
9-
platform
11+
platform,
12+
x
1013
};
1114
"
1215
`;

‎tests/__snapshots__/rolldown.test.ts.snap‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ exports[`rolldown 1`] = `
77
const platform = "darwin";
88
console.log("hello \\"darwin\\"", platform);
99
console.log(DEV);
10+
/** COMMENT_FLAG */
11+
function x() {}
1012
1113
//#endregion
12-
export { platform };"
14+
export { platform, x };"
1315
`;

‎tests/__snapshots__/rollup.test.ts.snap‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ const platform = null;
99
console.info('hello null', platform);
1010
console.info(dEV);
1111
12-
export { platform };
12+
/** COMMENT_FLAG */
13+
function x() {}
14+
15+
export { platform, x };
1316
"
1417
`;
1518

@@ -22,6 +25,9 @@ const platform = "darwin";
2225
console.log('hello "darwin"', platform);
2326
console.log(DEV);
2427
25-
export { platform };
28+
/** COMMENT_FLAG */
29+
function x() {}
30+
31+
export { platform, x };
2632
"
2733
`;

‎tests/__snapshots__/webpack.test.ts.snap‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ exports[`webpack 1`] = `
44
"/******/ (() => { // webpackBootstrap
55
/******/ "use strict";
66
7-
// UNUSED EXPORTS: platform
7+
// UNUSED EXPORTS: platform, x
88
99
;// external "node:process"
1010
const external_node_process_namespaceObject = require("node:process");
@@ -16,6 +16,9 @@ const platform = "darwin"
1616
console.log('hello "darwin"', platform)
1717
console.log(DEV)
1818
19+
/** COMMENT_FLAG */
20+
function x() {}
21+
1922
/******/ })()
2023
;"
2124
`;

‎tests/fixtures/main.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@ export const platform = process.platform
44

55
console.log('hello process.platform', platform)
66
console.log(DEV)
7+
8+
/** COMMENT_FLAG */
9+
export function x() {}

‎tests/rolldown.test.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ test('rolldown', async () => {
1010
plugins: [
1111
UnpluginReplace({
1212
'process.platform': '"darwin"',
13+
COMMENT_FLAG: 'null',
1314
}),
1415
],
1516
})
1617
const { output } = await build.generate({ format: 'es' })
1718
const code = output[0].code
1819
expect(code).toMatchSnapshot()
20+
expect(code).contains('COMMENT_FLAG')
1921
expect(code).not.contains('process.platform')
2022
expect(code).contains('"darwin"')
2123
})

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL