Fix tslint 'typedef' errors

Fixes #5843 - updated `typedef` tslint warning into an error - fixed failed `typedef` checks with the rules `call-signature` and `property-declaration`. Signed-off-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
eclipse-theia · Aug 5, 2019 · cc51575 · cc51575
1 parent b40a8d5
commit cc51575
Show file tree

Hide file tree

Showing 339 changed files with 984 additions and 916 deletions.
diff --git a/configs/errors.tslint.json b/configs/errors.tslint.json
@@ -131,6 +131,11 @@
       true,
       "allow-null-check"
     ],
+    "typedef": [
+      true,
+      "call-signature",
+      "property-declaration"
+    ],
     "typedef-whitespace": [
       true,
       {

diff --git a/configs/warnings.tslint.json b/configs/warnings.tslint.json
@@ -10,11 +10,6 @@
     "deprecation": true,
     "no-return-await": {
       "severity": "warning"
-    },
-    "typedef": [
-      true,
-      "call-signature",
-      "property-declaration"
-    ]
+    }
   }
 }
diff --git a/dev-packages/application-manager/src/generator/abstract-generator.ts b/dev-packages/application-manager/src/generator/abstract-generator.ts
@@ -62,11 +62,11 @@ export abstract class AbstractGenerator {
         return os.EOL + lines.join(os.EOL);
     }
 
-    protected ifBrowser(value: string, defaultValue: string = '') {
+    protected ifBrowser(value: string, defaultValue: string = ''): string {
         return this.pck.ifBrowser(value, defaultValue);
     }
 
-    protected ifElectron(value: string, defaultValue: string = '') {
+    protected ifElectron(value: string, defaultValue: string = ''): string {
         return this.pck.ifElectron(value, defaultValue);
     }
 
@@ -75,7 +75,7 @@ export abstract class AbstractGenerator {
         await fs.writeFile(path, content);
     }
 
-    protected ifMonaco(value: () => string, defaultValue: () => string = () => '') {
+    protected ifMonaco(value: () => string, defaultValue: () => string = () => ''): string {
         return (this.pck.extensionPackages.some(e => e.name === '@theia/monaco') ? value : defaultValue)();
     }
 

diff --git a/dev-packages/application-manager/src/rebuild.ts b/dev-packages/application-manager/src/rebuild.ts
@@ -18,7 +18,7 @@ import fs = require('fs-extra');
 import path = require('path');
 import cp = require('child_process');
 
-export function rebuild(target: 'electron' | 'browser', modules: string[]) {
+export function rebuild(target: 'electron' | 'browser', modules: string[]): void {
     const nodeModulesPath = path.join(process.cwd(), 'node_modules');
     const browserModulesPath = path.join(process.cwd(), '.browser_modules');
     const modulesToProcess = modules || ['@theia/node-pty', 'nsfw', 'native-keymap', 'find-git-repositories'];

diff --git a/dev-packages/application-package/src/extension-package.spec.ts b/dev-packages/application-package/src/extension-package.spec.ts
@@ -30,7 +30,7 @@ const testOutdated = (expectation: (extensionPackage: ExtensionPackage) => boole
         assert.equal(await expectation(extensionPackage), outdated);
     });
 
-describe('extension-package', function () {
+describe('extension-package', function (): void {
 
     this.timeout(10000);
     describe('isOutdated', () => {

diff --git a/dev-packages/application-package/src/npm-registry.ts b/dev-packages/application-package/src/npm-registry.ts
@@ -71,7 +71,9 @@ export interface ViewResult {
     [key: string]: any
 }
 
-export function sortByKey(object: { [key: string]: any }) {
+export function sortByKey(object: { [key: string]: any }): {
+    [key: string]: any;
+} {
     return Object.keys(object).sort().reduce((sorted, key) => {
         sorted[key] = object[key];
         return sorted;
@@ -101,7 +103,7 @@ export class NpmRegistry {
         this.resetIndex();
     }
 
-    updateProps(props?: Partial<NpmRegistryProps>) {
+    updateProps(props?: Partial<NpmRegistryProps>): void {
         const oldRegistry = this.props.registry;
         Object.assign(this.props, props);
         const newRegistry = this.props.registry;

diff --git a/dev-packages/cli/src/theia.ts b/dev-packages/cli/src/theia.ts
@@ -52,7 +52,7 @@ function rebuildCommand(command: string, target: ApplicationProps.Target): yargs
     };
 }
 
-(function () {
+(function (): void {
     const projectPath = process.cwd();
     const appTarget: ApplicationProps.Target = yargs.argv['app-target'];
     const manager = new ApplicationPackageManager({ projectPath, appTarget });

diff --git a/examples/browser/test/bottom-panel/bottom-panel.ts b/examples/browser/test/bottom-panel/bottom-panel.ts
@@ -30,15 +30,15 @@ export class BottomPanel {
         return (tab.$('..').getAttribute('class').split(' ').indexOf('p-mod-current') > -1);
     }
 
-    openTab(tabName: string) {
+    openTab(tabName: string): void {
         this.driver.element('#theia-bottom-content-panel .p-TabBar .p-TabBar-content').click(`div=${tabName}`);
     }
 
     isTerminalVisible(): boolean {
         return this.driver.isExisting('.p-Widget div.terminal.xterm');
     }
 
-    waitForTerminal() {
+    waitForTerminal(): void {
         this.driver.waitForExist('.p-Widget div.terminal.xterm');
         // Wait for animations to finish
         this.driver.pause(300);
@@ -48,7 +48,7 @@ export class BottomPanel {
         return this.driver.isExisting('.p-Widget div.theia-marker-container');
     }
 
-    waitForProblemsView() {
+    waitForProblemsView(): void {
         this.driver.waitForExist('.p-Widget div.theia-marker-container');
         // Wait for animations to finish
         this.driver.pause(300);
@@ -58,7 +58,7 @@ export class BottomPanel {
         return this.driver.isExisting('#callhierarchy');
     }
 
-    waitForCallHierarchyView() {
+    waitForCallHierarchyView(): void {
         this.driver.waitForExist('#callhierarchy');
         // Wait for animations to finish
         this.driver.pause(300);
@@ -68,13 +68,13 @@ export class BottomPanel {
         return this.driver.isExisting('.p-Widget div.theia-output');
     }
 
-    waitForOutputView() {
+    waitForOutputView(): void {
         this.driver.waitForExist('.p-Widget div.theia-output');
         // Wait for animations to finish
         this.driver.pause(300);
     }
 
-    closeCurrentView() {
+    closeCurrentView(): void {
         this.driver.click('#theia-bottom-content-panel .p-TabBar-tab.p-mod-current .p-TabBar-tabCloseIcon');
     }
 

diff --git a/examples/browser/test/cpp/cpp-change-build-config.ui-spec.ts b/examples/browser/test/cpp/cpp-change-build-config.ui-spec.ts
@@ -83,7 +83,7 @@ int main() {}
 /**
  * Return whether clangd is available.
  */
-function hasClangd() {
+function hasClangd(): boolean {
     try {
         const out = cp.execSync('clangd -version', { encoding: 'utf8' });
         // Match 'clangd version' at the start of
@@ -98,7 +98,7 @@ function hasClangd() {
  * Open the build config quick open menu, click on the first config that
  * matches `name`.
  */
-function changeBuildConfig(name: string, driver: WebdriverIO.Client<void>) {
+function changeBuildConfig(name: string, driver: WebdriverIO.Client<void>): void {
     const statusBar = driver.element('#theia-statusBar');
     const statusBarButton = statusBar.element('div.element*=Build Config');
     statusBarButton.click();
@@ -110,7 +110,7 @@ function changeBuildConfig(name: string, driver: WebdriverIO.Client<void>) {
 }
 
 // skip the cpp tests for the moment since they are broken.
-describe.skip('cpp extension', function () {
+describe.skip('cpp extension', function (): void {
 
     before(() => {
         const driver = browser;
@@ -127,7 +127,7 @@ describe.skip('cpp extension', function () {
         mainPage.waitForStartup();
     });
 
-    it.skip('should be able to change build config', function () {
+    it.skip('should be able to change build config', function (): void {
         if (!hasClangd()) {
             this.skip();
             return;

diff --git a/examples/browser/test/left-panel/left-panel.ts b/examples/browser/test/left-panel/left-panel.ts
@@ -30,13 +30,13 @@ export class LeftPanel {
         return (tab.$('..').getAttribute('class').split(' ').indexOf('p-mod-current') !== -1);
     }
 
-    openCloseTab(tabName: string) {
+    openCloseTab(tabName: string): void {
         this.driver.element('.p-TabBar.theia-app-left .p-TabBar-content').element(`div*=${tabName}`).click('..');
         // Wait for animations to finish
         this.driver.pause(300);
     }
 
-    collapseTab(tabName: string) {
+    collapseTab(tabName: string): void {
         this.driver.element('.p-TabBar.theia-app-left .p-TabBar-content').rightClick(`div*=${tabName}`);
         this.driver.element('.p-Widget.p-Menu .p-Menu-content').click('div=Collapse');
     }
@@ -57,7 +57,7 @@ export class LeftPanel {
      * collapse it.  No check is done to make sure this node actually exists or
      * represents a directory.
      */
-    toggleDirectoryInFilesView(name: string) {
+    toggleDirectoryInFilesView(name: string): void {
         this.waitForFilesViewVisible();
         const files = this.driver.element('#files');
         const element = files.element('div=' + name);
@@ -70,7 +70,7 @@ export class LeftPanel {
      * it.  Not check is done to make sure this node actually exists or
      * represents a file.
      */
-    openFileInFilesView(name: string) {
+    openFileInFilesView(name: string): void {
         this.waitForFilesViewVisible();
         const files = this.driver.element('#files');
         const element = files.element('div=' + name);

diff --git a/examples/browser/test/main-page/main-page.ts b/examples/browser/test/main-page/main-page.ts
@@ -56,7 +56,7 @@ export class MainPage {
         return this.driver.waitForExist('div#theia-statusBar');
     }
 
-    closeAll() {
+    closeAll(): void {
         /* Make sure that all the "docked" layouts are closed */
         while (this.driver.isExisting('.p-Widget.p-TabBar .p-TabBar-tab.p-mod-closable')) {
             this.driver.rightClick('.p-Widget.p-TabBar .p-TabBar-tab.p-mod-closable');

diff --git a/examples/browser/test/right-panel/right-panel.ts b/examples/browser/test/right-panel/right-panel.ts
@@ -30,13 +30,13 @@ export class RightPanel {
         return (tab.$('..').getAttribute('class').split(' ').indexOf('p-mod-current') !== -1);
     }
 
-    openCloseTab(tabName: string) {
+    openCloseTab(tabName: string): void {
         this.driver.element('.p-TabBar.theia-app-right .p-TabBar-content').element(`div=${tabName}`).click('..');
         // Wait for animations to finish
         this.driver.pause(300);
     }
 
-    collapseTab(tabName: string) {
+    collapseTab(tabName: string): void {
         this.driver.element('.p-TabBar.theia-app-right .p-TabBar-content').rightClick(`div=${tabName}`);
         this.driver.element('.p-Widget.p-Menu .p-Menu-content').click('div=Collapse');
     }

diff --git a/examples/browser/test/top-panel/top-panel.ts b/examples/browser/test/top-panel/top-panel.ts
@@ -24,52 +24,52 @@ export class TopPanel {
         return this.driver.isExisting('div#theia-top-panel');
     }
 
-    openNewTerminal() {
+    openNewTerminal(): void {
         this.clickMenuTab('Terminal');
         this.clickSubMenu('New Terminal');
     }
 
-    toggleCallHierarchyView() {
+    toggleCallHierarchyView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Call Hierarchy');
     }
 
-    toggleFilesView() {
+    toggleFilesView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Explorer');
     }
 
-    toggleScmView() {
+    toggleScmView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('SCM');
     }
 
-    toggleGitHistoryView() {
+    toggleGitHistoryView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Git History');
     }
 
-    toggleOutlineView() {
+    toggleOutlineView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Outline');
     }
 
-    toggleOutputView() {
+    toggleOutputView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Output');
     }
 
-    openPluginsView() {
+    openPluginsView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Plugins');
     }
 
-    openProblemsView() {
+    openProblemsView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Problems');
     }
 
-    toggleSearchView() {
+    toggleSearchView(): void {
         this.clickMenuTab('View');
         this.clickSubMenu('Search');
     }
@@ -82,19 +82,19 @@ export class TopPanel {
         return this.driver.isExisting('div.p-Widget.p-Menu.p-MenuBar-menu');
     }
 
-    clickMenuTab(tab: number | string) {
+    clickMenuTab(tab: number | string): void {
         if (typeof tab === 'string') {
             this.driver.element('ul.p-MenuBar-content').click(`div=${tab}`);
         } else {
             this.driver.click(`ul.p-MenuBar-content > .p-MenuBar-item:nth-child(${tab})`);
         }
     }
 
-    clickSubMenu(subMenuItem: string) {
+    clickSubMenu(subMenuItem: string): void {
         this.driver.element('div.p-Widget.p-Menu.p-MenuBar-menu .p-Menu-content').click(`div=${subMenuItem}`);
     }
 
-    hoverMenuTab(tabNumber: number) {
+    hoverMenuTab(tabNumber: number): void {
         this.driver.moveToObject(`ul.p-MenuBar-content > .p-MenuBar-item:nth-child(${tabNumber})`);
     }
 
@@ -106,7 +106,7 @@ export class TopPanel {
         return this.driver.isExisting('#theia\\:menubar.p-mod-active');
     }
 
-    getxBarTabPosition(tabNumber: number) {
+    getxBarTabPosition(tabNumber: number): WebdriverIO.Client<number> & number {
         return this.driver.getLocation(`ul.p-MenuBar-content > .p-MenuBar-item:nth-child(${tabNumber}`, 'x');
     }
 

diff --git a/packages/bunyan/src/node/bunyan-logger-server.ts b/packages/bunyan/src/node/bunyan-logger-server.ts
@@ -36,7 +36,7 @@ export class BunyanLoggerServer implements ILoggerServer {
     protected cli: LogLevelCliContribution;
 
     @postConstruct()
-    protected init() {
+    protected init(): void {
         /* Create the root logger by default.  */
         const opts = this.makeLoggerOptions(rootLoggerName);
         const rootOpts = Object.assign(opts, { name: 'Theia' });
@@ -46,14 +46,17 @@ export class BunyanLoggerServer implements ILoggerServer {
         this.cli.onLogConfigChanged(() => this.updateLogLevels());
     }
 
-    protected updateLogLevels() {
+    protected updateLogLevels(): void {
         for (const loggerName of this.loggers.keys()) {
             const newLevel = this.cli.logLevelFor(loggerName);
             this.setLogLevel(loggerName, newLevel);
         }
     }
 
-    protected makeLoggerOptions(name: string) {
+    protected makeLoggerOptions(name: string): {
+        logger: string;
+        level: number;
+    } {
         return {
             logger: name,
             level: this.toBunyanLevel(this.cli.logLevelFor(name)),
@@ -89,7 +92,7 @@ export class BunyanLoggerServer implements ILoggerServer {
     }
 
     /* Set the client to receive notifications on.  */
-    setClient(client: ILoggerClient | undefined) {
+    setClient(client: ILoggerClient | undefined): void {
         this.client = client;
     }
 

diff --git a/packages/callhierarchy/src/browser/callhierarchy-context.ts b/packages/callhierarchy/src/browser/callhierarchy-context.ts
@@ -46,6 +46,7 @@ export class CallHierarchyContext implements Disposable {
         return symbols;
     }
 
+    // tslint:disable-next-line:typedef
     async getEditorModelReference(uri: string) {
         const model = await this.textModelService.createModelReference(new URI(uri));
         this.disposables.push(model);
@@ -96,7 +97,7 @@ export class CallHierarchyContext implements Disposable {
         }
     }
 
-    dispose() {
+    dispose(): void {
         this.disposables.forEach(element => {
             element.dispose();
         });