[Axon 129] Add line rule for disallowing the use of var (#119)

* Add eslint rule: Require let or const instead of var

* add prefer-const too

* improvements

* fixed file

Author: marcomura

.eslintrc.js

@@ -60,11 +60,13 @@ module.exports = {
             "ignoreRestSiblings": false,
         }],        
         'brace-style': 'off',
+        'no-throw-literal': 'error',
+        'no-var': 'error',
+        'prefer-const': 'error',
         curly: 'error',
         eqeqeq: ['error', 'always'],
         semi: 'off',
         '@stylistic/js/semi': ['error', 'always'],
-        'no-throw-literal': 'error',
     },
     settings: {
         react: {

e2e/tests/auth.test.ts

@@ -26,7 +26,7 @@ describe('Auth User', async () => {
     after(async () => {});
 
     it('in SideBarView should see Create issue... button', async () => {
-        let atlasDrawer = sideBarView.findElement(By.id('workbench.view.extension.atlascode-drawer'));
+        const atlasDrawer = sideBarView.findElement(By.id('workbench.view.extension.atlascode-drawer'));
         expect(atlasDrawer).to.not.be.undefined;
 
         const createIssueButton = atlasDrawer.findElement(By.css('[aria-label="Create issue..."]'));

e2e/tests/no-auth.test.ts

@@ -40,7 +40,7 @@ describe('Atlassian Extension SideBar', async () => {
     after(async () => {});
 
     it('should have a login action suggestion', async () => {
-        let atlasDrawer = sideBarView.findElement(By.id('workbench.view.extension.atlascode-drawer'));
+        const atlasDrawer = sideBarView.findElement(By.id('workbench.view.extension.atlascode-drawer'));
         expect(atlasDrawer).to.not.be.undefined;
 
         // find element by aria-label: "Please login to Jira"

src/analytics.ts

@@ -57,7 +57,7 @@ export async function launchedEvent(location: string): Promise<TrackEvent> {
 }
 
 export async function featureChangeEvent(featureId: string, enabled: boolean): Promise<TrackEvent> {
-    let action = enabled ? 'enabled' : 'disabled';
+    const action = enabled ? 'enabled' : 'disabled';
     return trackEvent(action, 'feature', { actionSubjectId: featureId });
 }
 
@@ -164,7 +164,7 @@ export async function prCommentEvent(site: DetailedSiteInfo): Promise<TrackEvent
 }
 
 export async function prTaskEvent(site: DetailedSiteInfo, source: string): Promise<TrackEvent> {
-    let attributesObject: any = instanceType({}, site);
+    const attributesObject: any = instanceType({}, site);
     attributesObject.attributes.source = source;
     return trackEvent('created', 'pullRequestComment', attributesObject);
 }
@@ -590,7 +590,7 @@ async function instanceTrackEvent(
     actionSubject: string,
     eventProps: any = {},
 ): Promise<TrackEvent> {
-    let event: TrackEvent =
+    const event: TrackEvent =
         site.isCloud && site.product.key === ProductJira.key
             ? await tenantTrackEvent(site.id, action, actionSubject, instanceType(eventProps, site))
             : await trackEvent(action, actionSubject, instanceType(eventProps, site));
@@ -623,7 +623,7 @@ async function tenantTrackEvent(
 }
 
 function event(action: string, actionSubject: string, attributes: any): any {
-    var event = {
+    const event = {
         origin: 'desktop',
         platform: AnalyticsPlatform.for(process.platform),
         action: action,
@@ -648,19 +648,18 @@ function anyUserOrAnonymous<T>(e: Object): T {
 
 function tenantOrNull<T>(e: Object, tenantId?: string): T {
     let tenantType: string | null = 'cloudId';
-    let newObj: Object;
 
     if (!tenantId) {
         tenantType = null;
     }
-    newObj = { ...e, ...{ tenantIdType: tenantType, tenantId: tenantId } };
 
+    const newObj: Object = { ...e, ...{ tenantIdType: tenantType, tenantId: tenantId } };
     return newObj as T;
 }
 
 function instanceType(eventProps: Object, site?: DetailedSiteInfo, product?: Product): Object {
     let attrs: Object | undefined = undefined;
-    let newObj = eventProps;
+    const newObj = eventProps;
 
     if (product) {
         attrs = { hostProduct: product.name };
@@ -679,7 +678,7 @@ function instanceType(eventProps: Object, site?: DetailedSiteInfo, product?: Pro
 }
 
 function excludeFromActivity(eventProps: Object): Object {
-    let newObj = eventProps;
+    const newObj = eventProps;
 
     if (newObj['attributes']) {
         newObj['attributes'] = { ...newObj['attributes'], ...{ excludeFromActivity: true } };

src/atlclients/authStore.ts

@@ -122,7 +122,7 @@ export class CredentialManager implements Disposable {
     ): Promise<AuthInfo | undefined> {
         Logger.debug(`Retrieving auth info for product: ${site.product.key} credentialID: ${site.credentialId}`);
         let foundInfo: AuthInfo | undefined = undefined;
-        let productAuths = this._memStore.get(site.product.key);
+        const productAuths = this._memStore.get(site.product.key);
 
         if (allowCache && productAuths && productAuths.has(site.credentialId)) {
             foundInfo = productAuths.get(site.credentialId);
@@ -275,7 +275,7 @@ export class CredentialManager implements Disposable {
         if (!authInfo) {
             return undefined;
         }
-        let info: AuthInfo = JSON.parse(authInfo);
+        const info: AuthInfo = JSON.parse(authInfo);
 
         // When in doubt, assume credentials are valid
         if (info.state === undefined) {
@@ -309,7 +309,7 @@ export class CredentialManager implements Disposable {
             return undefined;
         }
 
-        let info: AuthInfo = JSON.parse(authInfo);
+        const info: AuthInfo = JSON.parse(authInfo);
 
         // When in doubt, assume credentials are valid
         if (info.state === undefined) {
@@ -330,7 +330,7 @@ export class CredentialManager implements Disposable {
         Logger.debug(`refreshingAccessToken for ${site.baseApiUrl} credentialID: ${site.credentialId}`);
 
         const provider: OAuthProvider | undefined = oauthProviderForSite(site);
-        let newTokens = undefined;
+        const newTokens = undefined;
         if (provider && credentials) {
             const tokenResponse = await this._refresher.getNewTokens(provider, credentials.refresh);
             if (tokenResponse.tokens) {
@@ -356,7 +356,7 @@ export class CredentialManager implements Disposable {
      * Removes an auth item from both the in-memory store and the secretstorage.
      */
     public async removeAuthInfo(site: DetailedSiteInfo): Promise<boolean> {
-        let productAuths = this._memStore.get(site.product.key);
+        const productAuths = this._memStore.get(site.product.key);
         let wasKeyDeleted = false;
         let wasMemDeleted = false;
         if (productAuths) {
@@ -371,7 +371,7 @@ export class CredentialManager implements Disposable {
                 setCommandContext(cmdctx, false);
             }
 
-            let name = site.name;
+            const name = site.name;
 
             const removeEvent: RemoveAuthInfoEvent = {
                 type: AuthChangeType.Remove,

src/atlclients/bitbucketAuthenticator.ts

@@ -14,7 +14,7 @@ export class BitbucketAuthenticator implements Authenticator {
         let newSites: DetailedSiteInfo[] = [];
 
         if (resources.length > 0) {
-            let resource = resources[0];
+            const resource = resources[0];
             const hostname = provider === OAuthProvider.BitbucketCloud ? 'bitbucket.org' : 'staging.bb-inf.net';
             const baseApiUrl =
                 provider === OAuthProvider.BitbucketCloud

src/atlclients/jiraAuthenticator.ts

@@ -11,7 +11,7 @@ export class JiraAuthentictor implements Authenticator {
     ): Promise<DetailedSiteInfo[]> {
         let newSites: DetailedSiteInfo[] = [];
 
-        let apiUri = provider === OAuthProvider.JiraCloudStaging ? 'api.stg.atlassian.com' : 'api.atlassian.com';
+        const apiUri = provider === OAuthProvider.JiraCloudStaging ? 'api.stg.atlassian.com' : 'api.atlassian.com';
 
         //TODO: [VSCODE-505] call serverInfo endpoint when it supports OAuth
         //const baseUrlString = await getJiraCloudBaseUrl(`https://${apiUri}/ex/jira/${newResource.id}/rest/2`, authInfo.access);

src/atlclients/oauthDancer.ts

@@ -77,7 +77,7 @@ export class OAuthDancer implements Disposable {
     }
 
     private createApp(): any {
-        let app = express();
+        const app = express();
 
         this.addPathForProvider(app, OAuthProvider.BitbucketCloud);
         this.addPathForProvider(app, OAuthProvider.BitbucketCloudStaging);

src/atlclients/responseHandlers/JiraPKCEResponseHandler.ts

@@ -48,7 +48,7 @@ export class JiraPKCEResponseHandler extends ResponseHandler {
 
     async user(accessToken: string, resource: AccessibleResource): Promise<UserInfo> {
         try {
-            let apiUri = this.strategy.apiUrl();
+            const apiUri = this.strategy.apiUrl();
             const url = `https://${apiUri}/ex/jira/${resource.id}/rest/api/2/myself`;
 
             const userResponse = await this.axios(url, {

src/bitbucket/bbUtils.ts

@@ -91,7 +91,7 @@ export function urlForRemote(remote: Remote): string {
 }
 
 export async function clientForRemote(remote: Remote): Promise<BitbucketApi> {
-    let site = siteDetailsForRemote(remote);
+    const site = siteDetailsForRemote(remote);
 
     if (site) {
         return await Container.clientManager.bbClient(site);
@@ -101,7 +101,7 @@ export async function clientForRemote(remote: Remote): Promise<BitbucketApi> {
 }
 
 export async function clientForHostname(hostname: string): Promise<BitbucketApi> {
-    let site = Container.siteManager.getSiteForHostname(ProductBitbucket, hostname);
+    const site = Container.siteManager.getSiteForHostname(ProductBitbucket, hostname);
 
     if (site) {
         return await Container.clientManager.bbClient(site);