Adding tslint (#129)

* added tslint

* updated documentation rules for tslint

Author: nmetulev

.vscode/extensions.json

@@ -5,6 +5,7 @@
     "nicolasparada.innerhtml",
     "bierner.lit-html",
     "esbenp.prettier-vscode",
-    "rebornix.project-snippets"
+    "rebornix.project-snippets",
+    "ms-vscode.vscode-typescript-tslint-plugin"
   ]
 }

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
-    "editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "vetur.format.enable": false
-}
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.tslint": true
+  }
+}

package.json

@@ -37,6 +37,7 @@
     "build:esm": "tsc",
     "build:watch": "tsc --watch",
     "build:bundle": "npm run copy:loader && npm run copy:wc && npm run sass && rollup -c",
+    "lint": "tslint -c tslint.json 'src/**/*.ts'",
     "copy:loader": "cpx src/bundle/mgt-loader.js dist/bundle",
     "copy:wc": "cpx node_modules/@webcomponents/webcomponentsjs/bundles/**/* dist/bundle/wc/bundles && cpx node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js dist/bundle/wc",
     "test": "jest",
@@ -90,6 +91,8 @@
     "sass": "^1.17.3",
     "shx": "^0.3.2",
     "ts-jest": "^24.0.1",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.4.4",
     "whatwg-fetch": "^3.0.0"
   },

src/providers/TeamsProvider.ts

@@ -6,9 +6,9 @@
  */
 
 import { AuthenticationProviderOptions } from '@microsoft/microsoft-graph-client/lib/es/IAuthenticationProviderOptions';
-import { MsalProvider } from './MsalProvider';
-import { LoginType, ProviderState } from './IProvider';
 import { Configuration, UserAgentApplication } from 'msal';
+import { LoginType, ProviderState } from './IProvider';
+import { MsalProvider } from './MsalProvider';
 
 declare var microsoftTeams: any;
 
@@ -20,43 +20,35 @@ export interface TeamsConfig {
 }
 
 export class TeamsProvider extends MsalProvider {
-  scopes: string[];
-  private _authPopupUrl: string;
-  private _accessToken: string;
-  public static microsoftTeamsLib;
-
-  private _sessionStorageTokenKey = 'mgt-teamsprovider-accesstoken';
-  private static _sessionStorageClientIdKey = 'msg-teamsprovider-clientId';
-
   private set accessToken(value: string) {
     this._accessToken = value;
-    sessionStorage.setItem(this._sessionStorageTokenKey, value);
+    sessionStorage.setItem(TeamsProvider._sessionStorageTokenKey, value);
     this.setState(value ? ProviderState.SignedIn : ProviderState.SignedOut);
   }
 
   private get accessToken() {
     return this._accessToken;
   }
 
-  static async isAvailable() {
+  public static async isAvailable() {
     return !!(TeamsProvider.microsoftTeamsLib || microsoftTeams);
   }
 
-  static handleAuth() {
+  public static handleAuth() {
     if (!this.isAvailable) {
       console.error('Make sure you have referenced the Microsoft Teams sdk before using the TeamsProvider');
       return;
     }
 
     // we are in popup world now - authenticate and handle it
 
-    var url = new URL(window.location.href);
+    const url = new URL(window.location.href);
 
     let clientId = sessionStorage.getItem(this._sessionStorageClientIdKey);
 
     if (UserAgentApplication.prototype.isCallback(window.location.hash)) {
       new MsalProvider({
-        clientId: clientId
+        clientId
       });
       return;
     }
@@ -76,8 +68,8 @@ export class TeamsProvider extends MsalProvider {
       return;
     }
 
-    let provider = new MsalProvider({
-      clientId: clientId // need to add scopes
+    const provider = new MsalProvider({
+      clientId // need to add scopes
     });
 
     const handleProviderState = async () => {
@@ -87,7 +79,7 @@ export class TeamsProvider extends MsalProvider {
         provider.login();
       } else if (provider.state === ProviderState.SignedIn) {
         try {
-          let accessToken = await provider.getAccessTokenForScopes(...provider.scopes);
+          const accessToken = await provider.getAccessTokenForScopes(...provider.scopes);
           teams.authentication.notifySuccess(accessToken);
         } catch (e) {
           teams.authentication.notifyFailure(e);
@@ -99,6 +91,16 @@ export class TeamsProvider extends MsalProvider {
     handleProviderState();
   }
 
+  private static _sessionStorageClientIdKey = 'msg-teamsprovider-clientId';
+  private static _sessionStorageTokenKey = 'mgt-teamsprovider-accesstoken';
+
+  public static microsoftTeamsLib;
+
+  private _authPopupUrl: string;
+  private _accessToken: string;
+
+  public scopes: string[];
+
   constructor(config: TeamsConfig) {
     super({
       clientId: config.clientId,
@@ -115,16 +117,16 @@ export class TeamsProvider extends MsalProvider {
 
     this._authPopupUrl = config.authPopupUrl;
     teams.initialize();
-    this.accessToken = sessionStorage.getItem(this._sessionStorageTokenKey);
+    this.accessToken = sessionStorage.getItem(TeamsProvider._sessionStorageTokenKey);
   }
 
-  async login(): Promise<void> {
+  public async login(): Promise<void> {
     this.setState(ProviderState.Loading);
     const teams = TeamsProvider.microsoftTeamsLib || microsoftTeams;
 
     return new Promise((resolve, reject) => {
       teams.getContext(context => {
-        let url = new URL(this._authPopupUrl, new URL(window.location.href));
+        const url = new URL(this._authPopupUrl, new URL(window.location.href));
         url.searchParams.append('clientId', this.clientId);
 
         teams.authentication.authenticate({
@@ -142,7 +144,7 @@ export class TeamsProvider extends MsalProvider {
     });
   }
 
-  async getAccessToken(options: AuthenticationProviderOptions): Promise<string> {
+  public async getAccessToken(options: AuthenticationProviderOptions): Promise<string> {
     return this.accessToken;
   }
 }

tslint.json

@@ -0,0 +1,32 @@
+{
+  "defaultSeverity": "error",
+  "extends": ["tslint:recommended", "tslint-config-prettier"],
+  "jsRules": {},
+  "rules": {
+    "quotemark": [true, "single", "avoid-escape", "avoid-template"],
+    "interface-name": false,
+    "completed-docs": [
+      true,
+      {
+        "methods": {
+          "privacies": ["public", "protected"]
+        },
+        "properties": {
+          "privacies": ["public", "protected"]
+        },
+        "classes": true,
+        "enums": true,
+        "enum-members": true,
+        "functions": true,
+        "interfaces": true,
+        "namespaces": true,
+        "types": true,
+        "variables": true
+      }
+    ],
+    "variable-name": {
+      "options": ["allow-leading-underscore"]
+    }
+  },
+  "rulesDirectory": []
+}