docs: 📝 Update README

viarotel-org · Oct 17, 2024 · 84aa5e5 · 84aa5e5
1 parent 5f9396f
commit 84aa5e5
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 2 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -52,7 +52,24 @@ await cleaner.run()
 ```javascript
 module.exports = {
   inputDir: 'D:\\Projects\\demo',
-  outputDir: 'C:\\Users\\viarotel\\Downloads'
+  outputDir: 'C:\\Users\\viarotel\\Downloads',
+  compilerOptions: {},
+  ignoredCopyPatterns: [
+    'node_modules',
+    '.git',
+    'dist',
+    /\.d\.ts$/,
+    file => file.endsWith('.log')
+  ],
+  ignoredConversionPatterns: [
+    'vendor',
+    /\.min\.js$/,
+    file => file.includes('legacy')
+  ],
+  getOutputDir: inputDir => `${path.basename(inputDir)}.cleants`,
+  removeDependencies: ['typescript', 'vue-tsc', '@types/node'],
+  replaceInternalImports: true,
+  plugins: []
 }
 ```
 

diff --git a/README.md b/README.md
@@ -52,7 +52,24 @@ await cleaner.run()
 ```javascript
 module.exports = {
   inputDir: 'D:\\Projects\\demo',
-  outputDir: 'C:\\Users\\viarotel\\Downloads'
+  outputDir: 'C:\\Users\\viarotel\\Downloads',
+  compilerOptions: {},
+  ignoredCopyPatterns: [
+    'node_modules',
+    '.git',
+    'dist',
+    /\.d\.ts$/,
+    file => file.endsWith('.log')
+  ],
+  ignoredConversionPatterns: [
+    'vendor',
+    /\.min\.js$/,
+    file => file.includes('legacy')
+  ],
+  getOutputDir: inputDir => `${path.basename(inputDir)}.cleants`,
+  removeDependencies: ['typescript', 'vue-tsc', '@types/node'],
+  replaceInternalImports: true,
+  plugins: []
 }
 ```