chore: rewrite some logs message and add not-chinese-message commit rule (#2542)

* chore: use English as the default language in the code

* chore: add not-chinese-message rules

* chore: use unicode

* chore: fix build

Author: erha19

commitlint.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'not-chinese-message-rule': [2, 'always'],
+  },
+  plugins: [
+    {
+      rules: {
+        'not-chinese-message-rule': ({ subject }) => {
+          const regex = /[\u4e00-\u9fa5]+/;
+          return [!regex.test(subject), 'Please use english to rewrite your commit message'];
+        },
+      },
+    },
+  ],
+};

package.json

@@ -76,11 +76,6 @@
       "path": "node_modules/cz-conventional-changelog"
     }
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "[email protected]:opensumi/core.git"

packages/comments/__test__/browser/comment.service.test.ts

@@ -86,7 +86,7 @@ describe('comment service test', () => {
     const [thread] = createTestThreads(uri);
     expect(thread.uri.isEqual(uri));
     expect(thread.range.startLineNumber).toBe(1);
-    expect(thread.comments[0].body).toBe('评论内容1');
+    expect(thread.comments[0].body).toBe('评论内容');
   });
 
   it('get commentsThreads', () => {
@@ -152,7 +152,7 @@ describe('comment service test', () => {
           author: {
             name: 'User',
           },
-          body: '评论内容1',
+          body: '评论内容',
         },
       ],
     });
@@ -171,7 +171,7 @@ describe('comment service test', () => {
           author: {
             name: 'User',
           },
-          body: '评论内容1',
+          body: '评论内容',
         },
       ],
     });
@@ -245,7 +245,7 @@ describe('comment service test', () => {
             author: {
               name: 'User',
             },
-            body: '评论内容1',
+            body: '评论内容',
           },
         ],
       }),

packages/core-browser/src/react-providers/slot.tsx

@@ -39,7 +39,7 @@ export function getSlotLocation(moduleName: string, layoutConfig: LayoutConfig)
       return location;
     }
   }
-  getDebugLogger().warn(`没有找到${moduleName}所对应的位置！`);
+  logger.warn(`Cannot find the location with ${moduleName}`);
   return '';
 }
 
@@ -97,14 +97,14 @@ export class ErrorBoundary extends React.Component {
 export const allSlot: { slot: string; dom: HTMLElement }[] = [];
 
 export const SlotDecorator: React.FC<{ slot: string; backgroundColor?: string }> = ({ slot, ...props }) => {
-  const ref = React.useRef<HTMLElement>();
+  const ref = React.useRef<HTMLElement | null>();
   React.useEffect(() => {
     if (ref.current) {
       allSlot.push({ slot, dom: ref.current });
     }
   }, [ref]);
   return (
-    <div ref={(ele) => (ref.current = ele!)} className='resize-wrapper'>
+    <div ref={(ele) => (ref.current = ele)} className='resize-wrapper'>
       {props.children}
     </div>
   );
@@ -163,12 +163,13 @@ export class SlotRendererRegistry {
 export const slotRendererRegistry = new SlotRendererRegistry();
 
 export interface SlotProps {
+  // Name of the slot view
   slot: string;
-  /**
-   * slot 默认的背景色
-   */
+  // Background color of the slot view
   backgroundColor?: string;
+  // Is tabbar slot renderer or not
   isTabbar?: boolean;
+  // Optional props
   [key: string]: any;
 }
 
@@ -181,15 +182,15 @@ export function SlotRenderer({ slot, isTabbar, ...props }: SlotProps) {
     slotRendererRegistry.addTabbar(slot);
   }
   if (!componentKeys || !componentKeys.length) {
-    getDebugLogger().warn(`No ${slot} view declared by location.`);
+    logger.warn(`No ${slot} view declared by location.`);
   }
   const [componentInfos, setInfos] = React.useState<ComponentRegistryInfo[]>([]);
   const updateComponentInfos = React.useCallback(() => {
     const infos: ComponentRegistryInfo[] = [];
     componentKeys.forEach((token) => {
       const info = componentRegistry.getComponentRegistryInfo(token);
       if (!info) {
-        getDebugLogger().warn(`${token} view isn't registered, please check.`);
+        logger.warn(`${token} view isn't registered, please check.`);
       } else {
         infos.push(info);
       }

packages/core-common/src/di-helper/domain-helper.ts

@@ -41,7 +41,7 @@ export function getDomainConstructors(...domains: Domain[]) {
       constructorSet.add(constructor);
     } else {
       // eslint-disable-next-line no-console
-      console.error(`没有获取到 ${String(domain)} 对应的Constructor！`);
+      console.error(`Unable to retrieve the Constructor for ${String(domain)}`);
     }
   }
   return Array.from(constructorSet);

packages/core-electron-main/src/bootstrap/api.ts

@@ -16,16 +16,14 @@ export class ElectronMainApiRegistryImpl implements ElectronMainApiRegistry {
   private apis: Map<string, ElectronMainApiProxy> = new Map();
 
   @Autowired(INJECTOR_TOKEN)
-  injector: Injector;
-
-  constructor() {}
+  private readonly injector: Injector;
 
   registerMainApi(name: string, api: IElectronMainApiProvider): IDisposable {
     if (this.apis.has(name)) {
-      this.apis.get(name)!.dispose();
+      this.apis.get(name)?.dispose();
     }
     const proxy = this.injector.get(ElectronMainApiProxy, [name, api]);
-    getDebugLogger().log('注册Electron Main Api: ' + name);
+    getDebugLogger().log(`Register Electron Main Api: ${name}`);
     this.apis.set(name, proxy);
 
     return {

packages/core-electron-main/src/bootstrap/window.ts

@@ -175,7 +175,7 @@ export class CodeWindow extends Disposable implements ICodeWindow {
 
   async start() {
     if (this.isRemote) {
-      getDebugLogger().log('Remote 模式，停止创建 Server 进程');
+      getDebugLogger().log('[Remote mode] stop creating Server process');
     } else {
       this.startNode();
     }

packages/editor/src/browser/doc-model/editor-document-model.ts

@@ -401,7 +401,7 @@ export class EditorDocumentModel extends Disposable implements IEditorDocumentMo
             this.compareAndSave();
           }
         });
-      this.logger.error('文件无法保存，版本和磁盘不一致');
+      this.logger.error('The file cannot be saved, the version is inconsistent with the disk');
       return false;
     }
     return false;

packages/editor/src/browser/monaco-contrib/tokenizer/textmate.service.ts

@@ -435,7 +435,7 @@ export class TextmateService extends WithEventBus implements ITextmateTokenizerS
       json = parseWithComments(content);
       return json;
     } catch (error) {
-      this.logger.error('语言配置文件解析出错！', content);
+      this.logger.error(`Language configuration file parsing error, ${error.stack}`);
       return;
     }
   }

packages/editor/src/browser/untitled-resource.ts

@@ -209,9 +209,9 @@ export class UntitledSchemeResourceProvider extends WithEventBus implements IRes
     }
     // 询问用户是否保存
     const buttons = {
-      [localize('file.prompt.dontSave', '不保存')]: AskSaveResult.REVERT,
-      [localize('file.prompt.save', '保存')]: AskSaveResult.SAVE,
-      [localize('file.prompt.cancel', '取消')]: AskSaveResult.CANCEL,
+      [localize('file.prompt.dontSave', "Don't Save")]: AskSaveResult.REVERT,
+      [localize('file.prompt.save', 'Save')]: AskSaveResult.SAVE,
+      [localize('file.prompt.cancel', 'Cancel')]: AskSaveResult.CANCEL,
     };
     const selection = await this.dialogService.open(
       formatLocalize('saveChangesMessage', resource.name),

packages/editor/src/browser/workbench-editor.service.ts

@@ -518,9 +518,9 @@ export class WorkbenchEditorServiceImpl extends WithEventBus implements Workbenc
 
     // 询问用户是否保存
     const buttons = {
-      [localize('file.prompt.dontSave', '不保存')]: AskSaveResult.REVERT,
-      [localize('file.prompt.save', '保存')]: AskSaveResult.SAVE,
-      [localize('file.prompt.cancel', '取消')]: AskSaveResult.CANCEL,
+      [localize('file.prompt.dontSave', "Don't Save")]: AskSaveResult.REVERT,
+      [localize('file.prompt.save', 'Save')]: AskSaveResult.SAVE,
+      [localize('file.prompt.cancel', 'Cancel')]: AskSaveResult.CANCEL,
     };
     const files = toClose.slice(0, MAX_CONFIRM_RESOURCES);
     let filesDetail = files.map((v) => v.resource.name).join('、');

packages/express-file-server/__tests__/browser/index.test.ts

@@ -21,7 +21,7 @@ describe('packages/express-file-server/__tests__/browser/index.test.ts', () => {
   createContributionProvider(injector, StaticResourceContribution);
   // 手动执行 staticResource 的 contribution
   staticResourceClientAppContribution.initialize();
-  it('express 模块提供 file schema 的 uri 转换', () => {
+  it('User express module to transform URI', () => {
     const uri = staticResourceService.resolveStaticResource(URI.file('test'));
     expect(uri.toString()).toEqual('http://127.0.0.1:8000/assets/test');
   });

packages/extension/__tests__/browser/extension.test.ts

@@ -92,8 +92,8 @@ describe('extension browser test', () => {
       extension.initialize();
 
       // 注入语言包后
-      expect(extension.toJSON().displayName).toEqual('哈哈哈哈啊哈哈');
-      expect(extension.localize('displayName')).toEqual('哈哈哈哈啊哈哈');
+      expect(extension.toJSON().displayName).toEqual('中文测试');
+      expect(extension.localize('displayName')).toEqual('中文测试');
     }, 0);
   });
 

packages/extension/__tests__/hosted/api/vscode/ext.host.env.test.ts

@@ -147,7 +147,7 @@ describe('vscode extHostEnv Test', () => {
         },
       });
 
-    it('用户首次访问时间大于一天', async () => {
+    it("The user's first visit is more than a day old", async () => {
       const envApi = createEnvApiFactory(
         rpcProtocolExt,
         extensionService,
@@ -158,7 +158,7 @@ describe('vscode extHostEnv Test', () => {
       expect(envApi.isNewAppInstall).toBe(false);
     });
 
-    it('用户首次访问时间小于一天', () => {
+    it("The user's first visit is less than a day old", () => {
       const envApi = createEnvApiFactory(
         rpcProtocolExt,
         extensionService,

packages/extension/src/browser/sumi/main.thread.layout.ts

@@ -32,38 +32,38 @@ export class MainThreadLayout extends Disposable implements IMainThreadLayout {
   }
 
   $setTitle(id: string, title: string): void {
-    this.getHandler(id).updateTitle(title);
+    this.getHandler(id)?.updateTitle(title);
   }
 
   $setIcon(id: string, iconPath: string): void {
     const iconClass = this.iconService.fromIcon('', iconPath, IconType.Background, IconShape.Square);
-    this.getHandler(id).setIconClass(iconClass!);
+    this.getHandler(id)?.setIconClass(iconClass!);
   }
 
   $setSize(id: string, size: number): void {
-    this.getHandler(id).setSize(size);
+    this.getHandler(id)?.setSize(size);
   }
 
   $activate(id: string): void {
-    this.getHandler(id).activate();
+    this.getHandler(id)?.activate();
   }
 
   $deactivate(id: string): void {
-    this.getHandler(id).deactivate();
+    this.getHandler(id)?.deactivate();
   }
 
   $setBadge(id: string, badge: string): void {
-    this.getHandler(id).setBadge(badge);
+    this.getHandler(id)?.setBadge(badge);
   }
 
   async $setVisible(id: string, visible: boolean) {
     if (visible) {
-      this.getHandler(id).show();
+      this.getHandler(id)?.show();
     } else {
-      if (this.getHandler(id).isActivated()) {
-        this.getHandler(id).deactivate();
+      if (this.getHandler(id)?.isActivated()) {
+        this.getHandler(id)?.deactivate();
       }
-      this.getHandler(id).hide();
+      this.getHandler(id)?.hide();
     }
   }
 
@@ -75,8 +75,10 @@ export class MainThreadLayout extends Disposable implements IMainThreadLayout {
       } else {
         const disposer = this.eventBus.on(TabBarRegistrationEvent, (e) => {
           if (e.payload.tabBarId === id) {
-            const handle = this.layoutService.getTabbarHandler(id);
-            this.bindHandleEvents(handle!);
+            const handler = this.layoutService.getTabbarHandler(id);
+            if (handler) {
+              this.bindHandleEvents(handler);
+            }
             disposer.dispose();
           }
         });
@@ -103,8 +105,8 @@ export class MainThreadLayout extends Disposable implements IMainThreadLayout {
   protected getHandler(id: string) {
     const handler = this.layoutService.getTabbarHandler(id);
     if (!handler) {
-      this.logger.warn(`MainThreaLayout:没有找到${id}对应的handler`);
+      this.logger.warn(`Could not find a handler with \`${id}\``);
     }
-    return handler!;
+    return handler;
   }
 }

packages/extension/src/browser/vscode/contributes/localization.ts

@@ -69,7 +69,7 @@ export class LocalizationsContributionPoint extends VSCodeContributePoint<Locali
       json = parseWithComments(content);
       return json;
     } catch (error) {
-      return this.logger.error('语言配置文件解析出错！', content);
+      return this.logger.error(`Language configuration file parsing error, ${error.stack}`);
     }
   }
 

packages/file-service/src/browser/file-service-client.ts

@@ -426,7 +426,7 @@ export class FileServiceClient implements IFileServiceClient {
 
   registerProvider(scheme: string, provider: FileSystemProvider): IDisposable {
     if (this.fsProviders.has(scheme)) {
-      throw new Error(`'${scheme}' 的文件系统 provider 已存在`);
+      throw new Error(`The file system provider for \`${scheme}\` already registered`);
     }
 
     const disposables: IDisposable[] = [];
@@ -513,7 +513,7 @@ export class FileServiceClient implements IFileServiceClient {
     const _uri = new URI(uri);
 
     if (!_uri.scheme) {
-      throw new Error(`没有设置 scheme: ${uri}`);
+      throw new Error(`Unsupported convert Uri with non-scheme Uri: ${uri}`);
     }
 
     return _uri;

packages/file-service/src/node/file-service.ts

@@ -388,7 +388,7 @@ export class FileService implements IFileService {
     const _uri = new URI(uri);
 
     if (!_uri.scheme) {
-      throw new Error(`没有设置 scheme: ${uri}`);
+      throw new Error(`Unsupported to get Uri from non-scheme Uri: ${uri}`);
     }
 
     return _uri;

packages/i18n/src/common/en-US.lang.ts

@@ -1361,6 +1361,9 @@ export const localizationBundle = {
     // #endregion merge editor
     'workbench.quickOpen.preserveInput':
       'Controls whether the last typed input to Quick Open(include Command Palette) should be preserved.',
+
+    'webview.webviewTagUnavailable': 'Webview is unsupported on non-electron env, please use iframe instead',
+
     ...browserViews,
   },
 };

packages/i18n/src/common/zh-CN.lang.ts

@@ -1079,6 +1079,9 @@ export const localizationBundle = {
     'mergeEditor.conflict.action.apply.confirm.complete': '确认保存并更改',
     'mergeEditor.button.apply': '应用更改',
     'workbench.quickOpen.preserveInput': '是否在 QuickOpen 的输入框（包括命令面板）中保留上次输入的内容',
+
+    'webview.webviewTagUnavailable': '非 Electron 环境不支持 Webview 标签，请使用 Iframe 标签',
+
     ...browserViews,
   },
 };

packages/logs-core/__tests__/node/log.service.test.ts

@@ -64,7 +64,7 @@ describe('LogService', () => {
     console.log('text', text);
     if (text.trim().length < 1) {
       // eslint-disable-next-line no-console
-      return console.warn('spdlog 写入文件可能失败了、或者 spdlog 初始化失败！');
+      return console.warn('Spdlog may have failed to write to file, or initialization failed');
     }
     expect(text.indexOf(LogLevelMessageMap[LogLevel.Verbose]) < 0).toBe(true);
     expect(text.indexOf(LogLevelMessageMap[LogLevel.Debug]) < 0).toBe(true);