style: use eslint and prettier (#138)

* style: use prettier format once

* style: few eslint fix

* style: fix eslint

* style: update eslint rule

* chore: resolve conflict, fix some bug

* style: fix lint

* style: fix eslint

* style: run prettier

Co-authored-by: Aaaaash <[email protected]>

Author: bytemain

.eslintignore

@@ -9,3 +9,10 @@ tools/cli-engine/src/browser/worker-host.js
 **/scripts/**
 packages/*/lib/**
 packages/*/dist/**
+
+packages/components/src/icon/iconfont
+packages/core-browser/src/style/octicons
+
+packages/extension/__mocks__/extension/browser-new.js
+packages/extension/__mocks__/extension/browser.js
+packages/extension/__mocks__/extension-error/browser.js

.eslintrc.js

@@ -72,31 +72,14 @@ module.exports = {
     '@typescript-eslint/unified-signatures': 'error',
     'arrow-body-style': 'error',
     'arrow-parens': ['error', 'always'],
-    'brace-style': ['error', '1tbs'],
     'comma-dangle': ['error', 'always-multiline'],
     complexity: 'off',
     'constructor-super': 'error',
     curly: 'error',
     'eol-last': 'error',
     eqeqeq: ['error', 'smart'],
     'guard-for-in': 'error',
-    'id-blacklist': [
-      'error',
-      'any',
-      'Number',
-      'number',
-      'String',
-      'string',
-      'Boolean',
-      'boolean',
-      'Undefined',
-      'undefined',
-    ],
     'id-match': 'error',
-    'import/order': 'off',
-    'jsdoc/check-alignment': 'off',
-    'jsdoc/check-indentation': 'off',
-    'jsdoc/newline-after-description': 'off',
     'max-classes-per-file': 'off',
     'max-len': 'off',
     'new-parens': 'error',
@@ -105,6 +88,7 @@ module.exports = {
     'no-cond-assign': 'off',
     'no-console': 'off',
     'no-debugger': 'error',
+    'no-constant-condition': ['error', { checkLoops: false }],
     // We strongly recommend that you do not use the no-undef lint rule on TypeScript projects.
     // The checks it provides are already provided by TypeScript without the need for configuration
     // TypeScript just does this significantly better.
@@ -123,17 +107,8 @@ module.exports = {
     'object-shorthand': 'error',
     'one-var': ['error', 'never'],
     'prefer-arrow/prefer-arrow-functions': 'off',
-    'prefer-const': 'error',
     'quote-props': 'off',
     radix: 'error',
-    'space-before-function-paren': [
-      'error',
-      {
-        anonymous: 'never',
-        asyncArrow: 'always',
-        named: 'never',
-      },
-    ],
     'spaced-comment': [
       'error',
       'always',
@@ -143,5 +118,19 @@ module.exports = {
     ],
     'use-isnan': 'error',
     'valid-typeof': 'off',
+    'no-irregular-whitespace': ['error', { skipComments: true }],
+    'no-inner-declarations': 'off',
+    'no-useless-catch': 'warn',
+    // TODO: should set below to error in future
+    'no-useless-escape': 'warn',
+    'no-async-promise-executor': 'warn',
+    'prefer-const': 'warn',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'warn',
+    '@typescript-eslint/ban-ts-comment': 'warn',
+    '@typescript-eslint/no-this-alias': 'warn',
+    '@typescript-eslint/ban-types': 'warn',
+    'no-prototype-builtins': 'warn',
+    'prefer-rest-params': 'warn',
+    'no-control-regex': 'warn',
   },
 };

.prettierignore

@@ -0,0 +1,18 @@
+node_modules
+
+**/tools/workspaces/**
+**/tools/extensions/**
+**/tools/**/vendor/
+tools/cli-engine/src/browser/worker-host.js
+
+**/typings/**
+**/scripts/**
+packages/*/lib/**
+packages/*/dist/**
+
+packages/components/src/icon/iconfont
+packages/core-browser/src/style/octicons
+
+packages/extension/__mocks__/extension/browser-new.js
+packages/extension/__mocks__/extension/browser.js
+packages/extension/__mocks__/extension-error/browser.js

jest.config.js

@@ -18,7 +18,7 @@ module.exports = {
     '!packages/**/*-contribution.ts',
     '!packages/startup/**/*.ts',
     // Test 功能暂未完成
-    "!packages/testing/**/*.ts",
+    '!packages/testing/**/*.ts',
     '!packages/core-electron-main/**/*.ts',
     '!packages/*/src/electron-main/**/*.ts',
   ],

package.json

@@ -30,10 +30,9 @@
     "publish:engine": "sh ./scripts/release-cli-engine.sh",
     "update-version": "ts-node ./scripts/publish --versionOnly",
     "update-disttag": "ts-node ./scripts/dist-tag",
-    "lint": "tslint -c tslint.yml -p tsconfig.json -t stylish",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "lint:fix": "npm run lint -- --fix",
-    "lint1": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "lint1:fix": "npm run lint1 -- --fix",
+    "format": "npm run lint:fix && prettier \"**/*.{js,jsx,ts,tsx,html,css,less}\" --write",
     "rebuild:node": "node ./scripts/rebuild-native.js",
     "test": "jest --forceExit",
     "test:module": "NODE_OPTIONS=--max_old_space_size=5120 node -r ts-node/register ./scripts/module-jest",
@@ -63,16 +62,12 @@
     "lodash": "^4.17.11",
     "node-gyp": "^8.3.0",
     "ts-node": "8.0.2",
-    "tslint": "^5.12.0",
     "typescript": "^4.4.2",
     "webpack": "4.39.3"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,md,html,css,less,json}": "prettier --write",
-    "*.{js,jsx,ts,tsx}": "eslint --fix",
-    "packages/**/*.(ts|tsx)": [
-      "tslint -c tslint.staged.yml -p tsconfig.json -t stylish"
-    ]
+    "*.{js,jsx,ts,tsx}": "eslint --fix --quiet"
   },
   "config": {
     "commitizen": {
@@ -149,7 +144,6 @@
     "strip-html-comments": "^1.0.0",
     "temp": "^0.9.0",
     "ts-jest": "^27.0.3",
-    "tslint-config-prettier": "^1.18.0",
     "urllib": "^2.37.4",
     "uuid": "^8.3.2",
     "write-pkg": "^4.0.0",

packages/addons/__test__/browser/file-search.contribution.test.ts

@@ -1,6 +1,18 @@
 import * as modes from '@opensumi/monaco-editor-core/esm/vs/editor/common/modes';
-import { CommandService, CommandServiceImpl, CommandRegistryImpl, CommandRegistry, DisposableCollection } from '@opensumi/ide-core-common';
-import { KeybindingRegistry, KeybindingRegistryImpl, RecentFilesManager, ILogger, PreferenceService } from '@opensumi/ide-core-browser';
+import {
+  CommandService,
+  CommandServiceImpl,
+  CommandRegistryImpl,
+  CommandRegistry,
+  DisposableCollection,
+} from '@opensumi/ide-core-common';
+import {
+  KeybindingRegistry,
+  KeybindingRegistryImpl,
+  RecentFilesManager,
+  ILogger,
+  PreferenceService,
+} from '@opensumi/ide-core-browser';
 import { WorkbenchEditorService } from '@opensumi/ide-editor';
 import { PrefixQuickOpenService } from '@opensumi/ide-quick-open';
 import { QuickOpenHandlerRegistry } from '@opensumi/ide-quick-open/lib/browser/prefix-quick-open.service';
@@ -13,7 +25,13 @@ import { createBrowserInjector } from '../../../../tools/dev-tool/src/injector-h
 import { MockInjector } from '../../../../tools/dev-tool/src/mock-injector';
 
 import { ClientAddonModule } from '../../src/browser';
-import { FileSearchContribution, quickFileOpen, FileSearchQuickCommandHandler, matchLineReg, getValidateInput } from '../../src/browser/file-search.contribution';
+import {
+  FileSearchContribution,
+  quickFileOpen,
+  FileSearchQuickCommandHandler,
+  matchLineReg,
+  getValidateInput,
+} from '../../src/browser/file-search.contribution';
 
 describe('test for browser/file-search.contribution.ts', () => {
   let injector: MockInjector;
@@ -22,27 +40,34 @@ describe('test for browser/file-search.contribution.ts', () => {
   const disposables = new DisposableCollection();
 
   beforeEach(() => {
-    injector = createBrowserInjector([ ClientAddonModule ], new MockInjector([
-      {
-        token: CommandRegistry,
-        useClass: CommandRegistryImpl,
-      }, {
-        token: CommandService,
-        useClass: CommandServiceImpl,
-      }, {
-        token: KeybindingRegistry,
-        useClass: KeybindingRegistryImpl,
-      }, {
-        token: FileSearchQuickCommandHandler,
-        useValue: {},
-      }, {
-        token: PrefixQuickOpenService,
-        useValue: {
-          open: fakeOpenFn,
+    injector = createBrowserInjector(
+      [ClientAddonModule],
+      new MockInjector([
+        {
+          token: CommandRegistry,
+          useClass: CommandRegistryImpl,
         },
-      },
-      QuickOpenHandlerRegistry,
-    ]));
+        {
+          token: CommandService,
+          useClass: CommandServiceImpl,
+        },
+        {
+          token: KeybindingRegistry,
+          useClass: KeybindingRegistryImpl,
+        },
+        {
+          token: FileSearchQuickCommandHandler,
+          useValue: {},
+        },
+        {
+          token: PrefixQuickOpenService,
+          useValue: {
+            open: fakeOpenFn,
+          },
+        },
+        QuickOpenHandlerRegistry,
+      ]),
+    );
 
     // 获取对象实例的时候才开始注册事件
     contribution = injector.get(FileSearchContribution);
@@ -121,7 +146,6 @@ describe('test for browser/file-search.contribution.ts', () => {
 });
 
 describe('file-search-quickopen', () => {
-
   let injector: MockInjector;
   let fileSearchQuickOpenHandler: FileSearchQuickCommandHandler;
 
@@ -168,13 +192,11 @@ describe('file-search-quickopen', () => {
     },
   ];
 
-  modes.DocumentSymbolProviderRegistry['all'] = () => {
-    return [{
-      provideDocumentSymbols: () => {
-        return testDS;
-      },
-    }];
-  };
+  modes.DocumentSymbolProviderRegistry['all'] = () => [
+    {
+      provideDocumentSymbols: () => testDS,
+    },
+  ];
 
   beforeEach(() => {
     injector = createBrowserInjector([]);
@@ -187,10 +209,7 @@ describe('file-search-quickopen', () => {
       {
         token: FileSearchServicePath,
         useValue: {
-          find: () => [
-            '/file/a',
-            '/file/b',
-          ],
+          find: () => ['/file/a', '/file/b'],
         },
       },
       {
@@ -214,20 +233,16 @@ describe('file-search-quickopen', () => {
     injector.mockService(PreferenceService, {});
     injector.mockService(ILogger, {});
     injector.mockService(IEditorDocumentModelService, {
-      createModelReference: (uri) => {
-        return {
-          instance: {
+      createModelReference: (uri) => ({
+        instance: {
+          uri,
+          getMonacoModel: () => ({
             uri,
-            getMonacoModel: () => {
-              return {
-                uri,
-                getLanguageIdentifier: () => 'javascript',
-              };
-            },
-          },
-          dispose: jest.fn(),
-        };
-      },
+            getLanguageIdentifier: () => 'javascript',
+          }),
+        },
+        dispose: jest.fn(),
+      }),
     });
     fileSearchQuickOpenHandler = injector.get(FileSearchQuickCommandHandler);
   });

packages/addons/__test__/browser/status-bar.contribution.test.ts

@@ -1,4 +1,10 @@
-import { CommandService, IEventBus, EventBusImpl, BrowserConnectionCloseEvent, BrowserConnectionOpenEvent } from '@opensumi/ide-core-common';
+import {
+  CommandService,
+  IEventBus,
+  EventBusImpl,
+  BrowserConnectionCloseEvent,
+  BrowserConnectionOpenEvent,
+} from '@opensumi/ide-core-common';
 
 import { createBrowserInjector } from '../../../../tools/dev-tool/src/injector-helper';
 import { MockInjector } from '../../../../tools/dev-tool/src/mock-injector';
@@ -12,17 +18,21 @@ describe('test for browser/status-bar-contribution.ts', () => {
   const fakeExecCmd = jest.fn();
 
   beforeEach(() => {
-    injector = createBrowserInjector([ ClientAddonModule ], new MockInjector([
-      {
-        token: IEventBus,
-        useClass: EventBusImpl,
-      }, {
-        token: CommandService,
-        useValue: {
-          executeCommand: fakeExecCmd,
+    injector = createBrowserInjector(
+      [ClientAddonModule],
+      new MockInjector([
+        {
+          token: IEventBus,
+          useClass: EventBusImpl,
         },
-      },
-    ]));
+        {
+          token: CommandService,
+          useValue: {
+            executeCommand: fakeExecCmd,
+          },
+        },
+      ]),
+    );
 
     eventBus = injector.get(IEventBus);
     // 获取对象实例的时候才开始注册事件

packages/addons/__test__/node/inde.test.ts

@@ -7,9 +7,7 @@ describe('test for ', () => {
   let injector: MockInjector;
 
   beforeEach(() => {
-    injector = createNodeInjector([
-      AddonsModule,
-    ]);
+    injector = createNodeInjector([AddonsModule]);
   });
 
   it('empty module', () => {