Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

build: add obfuscatorIgnorePatterns (#6911)

白熱60b45d843ba4
diff --git a/common/shared/tsdown/configs/module.ts b/common/shared/tsdown/configs/module.ts
index 7f6657e972..d8d09291c1 100644
--- a/common/shared/tsdown/configs/module.ts
+++ b/common/shared/tsdown/configs/module.ts
@@ -29,6 +29,7 @@ export interface ICreateModuleConfigOptions {
externalPackages: string[];
facadeExternalPackages: string[];
format: TModuleFormat;
+ obfuscatorIgnorePatterns?: RegExp[];
outDir: string;
packageDir: string;
plugins: any[];
@@ -38,7 +39,7 @@ export interface ICreateModuleConfigOptions {
* Creates the common ESM/CJS bundle config for a single package entry.
*/
export function createModuleConfig(options: ICreateModuleConfigOptions): UserConfig {
- const { baseConfig, enableObfuscation, entry, externalPackages, facadeExternalPackages, format, outDir, packageDir, plugins } = options;
+ const { baseConfig, enableObfuscation, entry, externalPackages, facadeExternalPackages, format, obfuscatorIgnorePatterns, outDir, packageDir, plugins } = options;
const neverBundle = entry.type === 'facade' ? facadeExternalPackages : externalPackages;
const copyToRoot = format === 'esm';
const keepRootIndexCss = entry.type === 'index' && format === 'esm';
@@ -53,12 +54,12 @@ export function createModuleConfig(options: ICreateModuleConfigOptions): UserCon
format,
outputOptions: {
codeSplitting: true,
- minify: false,
+ minify: enableObfuscation,
},
outDir,
plugins: [
...plugins,
- ...(enableObfuscation ? [createOutputObfuscatorPlugin()] : []),
+ ...(enableObfuscation ? [createOutputObfuscatorPlugin(obfuscatorIgnorePatterns)] : []),
createOutputAliasPlugin({
copyToRoot,
keepRootIndexCss,
diff --git a/common/shared/tsdown/configs/umd.ts b/common/shared/tsdown/configs/umd.ts
index 340623f489..a1be5925c9 100644
--- a/common/shared/tsdown/configs/umd.ts
+++ b/common/shared/tsdown/configs/umd.ts
@@ -25,6 +25,7 @@ export interface ICreateUmdConfigOptions {
baseConfig: Partial<UserConfig>;
enableObfuscation: boolean;
entry: IEntryConfig;
+ obfuscatorIgnorePatterns?: RegExp[];
outDir: string;
packageDir: string;
packageName: string;
@@ -87,7 +88,7 @@ function getGlobalName(packageName: string, entryKey: string) {
* Creates the browser-oriented UMD bundle config for a single package entry.
*/
export function createUmdConfig(options: ICreateUmdConfigOptions): UserConfig {
- const { baseConfig, enableObfuscation, entry, outDir, packageDir, packageName, plugins } = options;
+ const { baseConfig, enableObfuscation, entry, obfuscatorIgnorePatterns, outDir, packageDir, packageName, plugins } = options;
return defineConfig({
...baseConfig,
@@ -109,7 +110,7 @@ export function createUmdConfig(options: ICreateUmdConfigOptions): UserConfig {
platform: 'browser',
plugins: [
...plugins,
- ...(enableObfuscation ? [createOutputObfuscatorPlugin()] : []),
+ ...(enableObfuscation ? [createOutputObfuscatorPlugin(obfuscatorIgnorePatterns)] : []),
createOutputAliasPlugin({
copyToRoot: false,
keepRootIndexCss: false,
diff --git a/common/shared/tsdown/index.ts b/common/shared/tsdown/index.ts
index e2bbf1c4c1..5d52f77225 100644
--- a/common/shared/tsdown/index.ts
+++ b/common/shared/tsdown/index.ts
@@ -64,6 +64,7 @@ function createConfigs(context: IBuildContext, options: IBuildOptions) {
externalPackages: context.externalPackages,
facadeExternalPackages: context.facadeExternalPackages,
format,
+ obfuscatorIgnorePatterns: options.obfuscatorIgnorePatterns,
outDir: BUILD_OUTPUT_DIRECTORIES[format],
packageDir: context.packageDir,
plugins: context.plugins,
@@ -78,6 +79,7 @@ function createConfigs(context: IBuildContext, options: IBuildOptions) {
baseConfig,
enableObfuscation,
entry,
+ obfuscatorIgnorePatterns: options.obfuscatorIgnorePatterns,
outDir: BUILD_OUTPUT_DIRECTORIES.umd,
packageDir: context.packageDir,
packageName: context.packageJson.name,
@@ -108,6 +110,23 @@ export async function build(options: IBuildOptions = {}) {
removeCssArtifacts(path.join(packageDir, BUILD_OUTPUT_ROOT));
+ /**
+ * If we specifically have a tsdown config path provided, we will use that and ignore any default configs. However, if no specific config is provided, we will look for default configs in the package root (tsdown.config.mjs, tsdown.config.ts, tsdown.config.js) and merge any found obfuscatorIgnorePatterns into the build context. This allows users to specify obfuscation ignore patterns without needing to provide a full custom config.
+ */
+ if (!options.tsdownConfigPath) {
+ const configExtensions = ['.mjs', '.ts', '.js'];
+ for (const ext of configExtensions) {
+ const defaultConfigPath = path.resolve(packageDir, `tsdown.config${ext}`);
+ if (existsSync(defaultConfigPath)) {
+ const { default: userConfigModule } = await import(defaultConfigPath);
+ if (userConfigModule.obfuscatorIgnorePatterns) {
+ options.obfuscatorIgnorePatterns = userConfigModule.obfuscatorIgnorePatterns;
+ }
+ break;
+ }
+ }
+ }
+
const context = createBuildContext(packageDir, options);
let configs = createConfigs(context, options);
diff --git a/common/shared/tsdown/plugins/output-obfuscator.ts b/common/shared/tsdown/plugins/output-obfuscator.ts
index ae7c066525..c56666f8ce 100644
--- a/common/shared/tsdown/plugins/output-obfuscator.ts
+++ b/common/shared/tsdown/plugins/output-obfuscator.ts
@@ -23,7 +23,7 @@ interface IBundleOutput {
fileName?: string;
}
-export function createOutputObfuscatorPlugin() {
+export function createOutputObfuscatorPlugin(ignorePatterns?: RegExp[]) {
const obfuscationOptions: ObfuscatorOptions = {
ignoreImports: true,
};
@@ -38,11 +38,16 @@ export function createOutputObfuscatorPlugin() {
const outDir = outputOptions.dir;
for (const output of Object.values(bundle)) {
- if (!output.fileName || !output.fileName.endsWith('.js') || output.fileName.endsWith('.map')) {
+ const fileName = output.fileName;
+ if (!fileName || !fileName.endsWith('.js') || fileName.endsWith('.map')) {
continue;
}
- const targetPath = path.resolve(outDir, output.fileName);
+ if (ignorePatterns?.some((pattern) => pattern.test(fileName))) {
+ continue;
+ }
+
+ const targetPath = path.resolve(outDir, fileName);
const sourceCode = readFileSync(targetPath, 'utf8');
const obfuscatedCode = JavaScriptObfuscator.obfuscate(sourceCode, obfuscationOptions).getObfuscatedCode();
diff --git a/common/shared/tsdown/types.ts b/common/shared/tsdown/types.ts
index d600216c1a..a1fe10cd25 100644
--- a/common/shared/tsdown/types.ts
+++ b/common/shared/tsdown/types.ts
@@ -22,6 +22,7 @@ export interface IBuildOptions {
ignorePackages?: string[];
nodeFirst?: boolean;
tsdownConfigPath?: string;
+ obfuscatorIgnorePatterns?: RegExp[];
}
export type TEntryType = 'facade' | 'index' | 'locale';