chore: format all common files (#431)

2025-07-31 21:46:47 +08:00
parent 8136ddd82d
commit 40088b0a05
60 changed files with 658 additions and 288 deletions
--- a/common/autoinstallers/rush-commands/src/convert-comments/utils/chinese.ts
+++ b/common/autoinstallers/rush-commands/src/convert-comments/utils/chinese.ts
@@ -1,8 +1,25 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 /**
 * Unicode Range Regular Expressions for Chinese Characters
 */
 const CHINESE_REGEX = /[\u4e00-\u9fff\u3400-\u4dbf\uf900-\ufaff]/;
-const CHINESE_EXTRACT_REGEX = /[\u4e00-\u9fff\u3400-\u4dbf\uf900-\ufaff\u3000-\u303f\uff00-\uffef]+/g;
+const CHINESE_EXTRACT_REGEX =
+  /[\u4e00-\u9fff\u3400-\u4dbf\uf900-\ufaff\u3000-\u303f\uff00-\uffef]+/g;

 /**
 * Detect whether the text contains Chinese characters
@@ -31,7 +48,10 @@ export const countChineseCharacters = (text: string): number => {
 /**
 * Detect whether the text is mainly composed of Chinese
 */
-export const isPrimarilyChinese = (text: string, threshold: number = 0.5): boolean => {
+export const isPrimarilyChinese = (
+  text: string,
+  threshold: number = 0.5,
+): boolean => {
  const totalLength = text.length;
  if (totalLength === 0) return false;

@@ -43,9 +63,9 @@ export const isPrimarilyChinese = (text: string, threshold: number = 0.5): boole
 * Clean up comment text, remove comment symbols and extra spaces
 */
 export const cleanCommentText = (
-  text: string, 
-  commentType: 'single-line' | 'multi-line', 
-  language?: string
+  text: string,
+  commentType: 'single-line' | 'multi-line',
+  language?: string,
 ): string => {
  let cleaned = text;

@@ -100,7 +120,10 @@ export const cleanCommentText = (
 /**
 * Verify whether the translation result is valid.
 */
-export const isValidTranslation = (original: string, translated: string): boolean => {
+export const isValidTranslation = (
+  original: string,
+  translated: string,
+): boolean => {
  // basic verification
  if (!translated || translated.trim().length === 0) {
    return false;
--- a/common/autoinstallers/rush-commands/src/convert-comments/utils/language.ts
+++ b/common/autoinstallers/rush-commands/src/convert-comments/utils/language.ts
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { SourceFileLanguage, CommentPattern } from '../types/index';

 /**
@@ -7,44 +23,44 @@ export const detectLanguage = (filePath: string): SourceFileLanguage => {
  const ext = filePath.toLowerCase().split('.').pop();

  const languageMap: Record<string, SourceFileLanguage> = {
-    'ts': 'typescript',
-    'tsx': 'typescript',
-    'js': 'javascript',
-    'jsx': 'javascript',
-    'go': 'go',
-    'md': 'markdown',
-    'txt': 'text',
-    'json': 'json',
-    'yaml': 'yaml',
-    'yml': 'yaml',
-    'toml': 'toml',
-    'ini': 'ini',
-    'conf': 'ini',
-    'config': 'ini',
-    'sh': 'shell',
-    'bash': 'shell',
-    'zsh': 'shell',
-    'fish': 'shell',
-    'py': 'python',
-    'css': 'css',
-    'scss': 'css',
-    'sass': 'css',
-    'less': 'css',
-    'html': 'html',
-    'htm': 'html',
-    'xml': 'xml',
-    'php': 'php',
-    'rb': 'ruby',
-    'rs': 'rust',
-    'java': 'java',
-    'c': 'c',
-    'h': 'c',
-    'cpp': 'cpp',
-    'cxx': 'cpp',
-    'cc': 'cpp',
-    'hpp': 'cpp',
-    'cs': 'csharp',
-    'thrift': 'thrift'
+    ts: 'typescript',
+    tsx: 'typescript',
+    js: 'javascript',
+    jsx: 'javascript',
+    go: 'go',
+    md: 'markdown',
+    txt: 'text',
+    json: 'json',
+    yaml: 'yaml',
+    yml: 'yaml',
+    toml: 'toml',
+    ini: 'ini',
+    conf: 'ini',
+    config: 'ini',
+    sh: 'shell',
+    bash: 'shell',
+    zsh: 'shell',
+    fish: 'shell',
+    py: 'python',
+    css: 'css',
+    scss: 'css',
+    sass: 'css',
+    less: 'css',
+    html: 'html',
+    htm: 'html',
+    xml: 'xml',
+    php: 'php',
+    rb: 'ruby',
+    rs: 'rust',
+    java: 'java',
+    c: 'c',
+    h: 'c',
+    cpp: 'cpp',
+    cxx: 'cpp',
+    cc: 'cpp',
+    hpp: 'cpp',
+    cs: 'csharp',
+    thrift: 'thrift',
  };

  return languageMap[ext || ''] || 'other';
@@ -55,19 +71,52 @@ export const detectLanguage = (filePath: string): SourceFileLanguage => {
 */
 export const filterFilesByExtensions = (
  files: string[],
-  extensions: string[]
+  extensions: string[],
 ): string[] => {
  if (extensions.length === 0) {
    // Default supported text file extensions
    const defaultExtensions = [
-      '.ts', '.tsx', '.js', '.jsx', '.go', '.md', '.txt', '.json',
-      '.yaml', '.yml', '.toml', '.ini', '.conf', '.config',
-      '.sh', '.bash', '.zsh', '.fish', '.py', '.css', '.scss', '.sass', '.less',
-      '.html', '.htm', '.xml', '.php', '.rb', '.rs', '.java', '.c', '.h',
-      '.cpp', '.cxx', '.cc', '.hpp', '.cs', '.thrift'
+      '.ts',
+      '.tsx',
+      '.js',
+      '.jsx',
+      '.go',
+      '.md',
+      '.txt',
+      '.json',
+      '.yaml',
+      '.yml',
+      '.toml',
+      '.ini',
+      '.conf',
+      '.config',
+      '.sh',
+      '.bash',
+      '.zsh',
+      '.fish',
+      '.py',
+      '.css',
+      '.scss',
+      '.sass',
+      '.less',
+      '.html',
+      '.htm',
+      '.xml',
+      '.php',
+      '.rb',
+      '.rs',
+      '.java',
+      '.c',
+      '.h',
+      '.cpp',
+      '.cxx',
+      '.cc',
+      '.hpp',
+      '.cs',
+      '.thrift',
    ];
    return files.filter(file =>
-      defaultExtensions.some(ext => file.toLowerCase().endsWith(ext))
+      defaultExtensions.some(ext => file.toLowerCase().endsWith(ext)),
    );
  }

@@ -85,123 +134,125 @@ export const filterFilesByExtensions = (
 /**
 * Obtain comment modes for different programming languages
 */
-export const getCommentPatterns = (language: SourceFileLanguage): CommentPattern | null => {
+export const getCommentPatterns = (
+  language: SourceFileLanguage,
+): CommentPattern | null => {
  const commentPatterns: Record<SourceFileLanguage, CommentPattern> = {
    typescript: {
      single: /(?:^|[^:])\s*\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    javascript: {
      single: /(?:^|[^:])\s*\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    go: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    markdown: {
      single: /<!--(.*)-->/g,
      multiStart: /<!--/g,
-      multiEnd: /-->/g
+      multiEnd: /-->/g,
    },
    text: {
      single: /^(.*)$/gm, // Every line of a text file can be a comment
      multiStart: /^/g,
-      multiEnd: /$/g
+      multiEnd: /$/g,
    },
    json: {
      single: /\/\/(.*)$/gm, // JSON usually doesn't support comments, but some tools do
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    yaml: {
      single: /#(.*)$/gm,
      multiStart: /^$/g, // YAML does not support multi-line comments
-      multiEnd: /^$/g
+      multiEnd: /^$/g,
    },
    toml: {
      single: /#(.*)$/gm,
      multiStart: /^$/g, // TOML does not support multi-line comments
-      multiEnd: /^$/g
+      multiEnd: /^$/g,
    },
    ini: {
      single: /[;#](.*)$/gm, // INI file support; and #as comments
      multiStart: /^$/g, // INI does not support multi-line comments
-      multiEnd: /^$/g
+      multiEnd: /^$/g,
    },
    shell: {
      single: /#(.*)$/gm,
      multiStart: /^$/g, // Shell scripts do not support multi-line comments
-      multiEnd: /^$/g
+      multiEnd: /^$/g,
    },
    python: {
      single: /#(.*)$/gm,
      multiStart: /"""[\s\S]*?$/gm, // Python docstring
-      multiEnd: /[\s\S]*?"""/gm
+      multiEnd: /[\s\S]*?"""/gm,
    },
    css: {
      single: /^$/g, // CSS does not support single-line comments
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    html: {
      single: /^$/g, // HTML does not support single-line comments
      multiStart: /<!--/g,
-      multiEnd: /-->/g
+      multiEnd: /-->/g,
    },
    xml: {
      single: /^$/g, // XML does not support single-line comments
      multiStart: /<!--/g,
-      multiEnd: /-->/g
+      multiEnd: /-->/g,
    },
    php: {
      single: /(?:\/\/|#)(.*)$/gm, // PHP supports//and #as single-line comments
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    ruby: {
      single: /#(.*)$/gm,
      multiStart: /=begin/g,
-      multiEnd: /=end/g
+      multiEnd: /=end/g,
    },
    rust: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    java: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    c: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    cpp: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    csharp: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    thrift: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
+      multiEnd: /\*\//g,
    },
    other: {
      single: /\/\/(.*)$/gm,
      multiStart: /\/\*/g,
-      multiEnd: /\*\//g
-    }
+      multiEnd: /\*\//g,
+    },
  };

  return commentPatterns[language] || null;
@@ -220,14 +271,47 @@ export const isSupportedFile = (filePath: string): boolean => {
 */
 export const isTextFile = (filePath: string): boolean => {
  const textExtensions = [
-    '.ts', '.tsx', '.js', '.jsx', '.go', '.md', '.txt', '.json',
-    '.css', '.scss', '.sass', '.less', '.html', '.htm', '.xml',
-    '.yaml', '.yml', '.toml', '.ini', '.conf', '.config',
-    '.sh', '.bash', '.zsh', '.fish', '.py', '.java', '.c', '.cpp', '.h', '.hpp', '.cs',
-    '.php', '.rb', '.rs', '.kt', '.swift', '.dart', '.scala', '.thrift'
+    '.ts',
+    '.tsx',
+    '.js',
+    '.jsx',
+    '.go',
+    '.md',
+    '.txt',
+    '.json',
+    '.css',
+    '.scss',
+    '.sass',
+    '.less',
+    '.html',
+    '.htm',
+    '.xml',
+    '.yaml',
+    '.yml',
+    '.toml',
+    '.ini',
+    '.conf',
+    '.config',
+    '.sh',
+    '.bash',
+    '.zsh',
+    '.fish',
+    '.py',
+    '.java',
+    '.c',
+    '.cpp',
+    '.h',
+    '.hpp',
+    '.cs',
+    '.php',
+    '.rb',
+    '.rs',
+    '.kt',
+    '.swift',
+    '.dart',
+    '.scala',
+    '.thrift',
  ];

-  return textExtensions.some(ext =>
-    filePath.toLowerCase().endsWith(ext)
-  );
+  return textExtensions.some(ext => filePath.toLowerCase().endsWith(ext));
 };