Add prettier for better linting (#28)

* Add prettier for better linting

* Review feedback

Author: nickpeihl

.eslintrc

@@ -2,7 +2,9 @@
   "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint"],
   "extends": [
-    "plugin:@typescript-eslint/recommended"
+    "plugin:@typescript-eslint/recommended",
+    "prettier/@typescript-eslint",
+    "plugin:prettier/recommended"
   ],
   "rules": {
     "@typescript-eslint/member-ordering": 2,

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

package.json

@@ -6,9 +6,10 @@
   "browser": "target/web/index.js",
   "types": "target/index.d.ts",
   "scripts": {
-    "lint": "tsc --noEmit && yarn lint-es",
-    "lint-es": "eslint --ext .ts,.tsx",
-    "test": "yarn lint && jest",
+    "prelint": "tsc --noEmit",
+    "lint": "eslint . --ext .ts,.tsx",
+    "pretest": "yarn lint",
+    "test": "jest",
     "build": "tsc --emitDeclarationOnly && yarn build-web && yarn build-node",
     "build-web": "BABEL_ENV=web babel src --extensions \".ts,.tsx\" --config-file=./babel.config.js --out-dir=target/web --delete-dir-on-start",
     "build-node": "BABEL_ENV=node babel src --extensions \".ts,.tsx\" --config-file=./babel.config.js --out-dir=target/node --delete-dir-on-start"
@@ -28,6 +29,11 @@
     "url": "https://github.com/elastic/ems-client/issues"
   },
   "homepage": "https://github.com/elastic/ems-client#readme",
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn test"
+    }
+  },
   "dependencies": {
     "lodash": "^4.17.15",
     "semver": "^6.3.0"
@@ -48,8 +54,12 @@
     "@typescript-eslint/parser": "^2.33.0",
     "babel-jest": "^24.9.0",
     "eslint": "^7.0.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "husky": "^4.2.5",
     "jest": "^25.5.4",
     "node-fetch": "^1.7.3",
+    "prettier": "^2.0.5",
     "ts-jest": "^25.5.1",
     "typescript": "^3.9.2"
   }

src/ems_client.ts

@@ -84,7 +84,7 @@ function modifyUrlLocal(
 }
 
 const extendUrl = (url: string, props: URLMeaningfulParts) =>
-  modifyUrlLocal(url, parsed => _.merge(parsed, props));
+  modifyUrlLocal(url, (parsed) => _.merge(parsed, props));
 
 /**
  *  Unescape a url template that was escaped by encodeURI() so leaflet
@@ -272,16 +272,6 @@ export class EMSClient {
     return i18nObject[this._language] ? i18nObject[this._language] : i18nObject[DEFAULT_LANGUAGE];
   }
 
-  private _getEmsVersion(version: string | undefined): string {
-    const userVersion = semver.valid(semver.coerce(version));
-    const semverVersion = userVersion ? userVersion : semver.coerce(DEFAULT_EMS_VERSION);
-    if (semverVersion) {
-      return `v${semver.major(semverVersion)}.${semver.minor(semverVersion)}`;
-    } else {
-      throw new Error(`Invalid version: ${version}`);
-    }
-  }
-
   /**
    * this internal method is overridden by the tests to simulate custom manifest.
    */
@@ -301,6 +291,96 @@ export class EMSClient {
     }
   }
 
+  /**
+   * Add optional query-parameters to all requests
+   *
+   * @param additionalQueryParams
+   */
+  addQueryParams(additionalQueryParams: { [key: string]: string }): void {
+    for (const key in additionalQueryParams) {
+      if (additionalQueryParams.hasOwnProperty(key)) {
+        if (additionalQueryParams[key] !== this._queryParams[key]) {
+          //changes detected.
+          this._queryParams = _.assign({}, this._queryParams, additionalQueryParams);
+          this._invalidateSettings();
+          break;
+        }
+      }
+    }
+  }
+
+  async getMainManifest(): Promise<EmsCatalogManifest> {
+    return await this._getMainCatalog();
+  }
+
+  async getDefaultFileManifest(): Promise<EmsFileCatalog> {
+    return await this._getDefaultFileCatalog();
+  }
+
+  async getDefaultTMSManifest(): Promise<EmsTmsCatalog> {
+    return await this._getDefaultTMSCatalog();
+  }
+
+  async getFileLayers(): Promise<FileLayer[]> {
+    return await this._loadFileLayers();
+  }
+
+  async getTMSServices(): Promise<TMSService[]> {
+    return await this._loadTMSServices();
+  }
+
+  getTileApiUrl(): string {
+    return this._tileApiUrl;
+  }
+
+  getFileApiUrl(): string {
+    return this._fileApiUrl;
+  }
+
+  getLandingPageUrl(): string {
+    return this._emsLandingPageUrl;
+  }
+
+  sanitizeHtml(html: string): string {
+    return this._sanitizer(html);
+  }
+
+  extendUrlWithParams(url: string): string {
+    return unescapeTemplateVars(
+      extendUrl(url, {
+        query: this._queryParams,
+      })
+    );
+  }
+
+  async findFileLayerById(id: string): Promise<FileLayer | undefined> {
+    const fileLayers = await this.getFileLayers();
+    for (let i = 0; i < fileLayers.length; i++) {
+      if (fileLayers[i].hasId(id)) {
+        return fileLayers[i];
+      }
+    }
+  }
+
+  async findTMSServiceById(id: string): Promise<TMSService | undefined> {
+    const tmsServices = await this.getTMSServices();
+    for (let i = 0; i < tmsServices.length; i++) {
+      if (tmsServices[i].hasId(id)) {
+        return tmsServices[i];
+      }
+    }
+  }
+
+  private _getEmsVersion(version: string | undefined): string {
+    const userVersion = semver.valid(semver.coerce(version));
+    const semverVersion = userVersion ? userVersion : semver.coerce(DEFAULT_EMS_VERSION);
+    if (semverVersion) {
+      return `v${semver.major(semverVersion)}.${semver.minor(semverVersion)}`;
+    } else {
+      throw new Error(`Invalid version: ${version}`);
+    }
+  }
+
   private _fetchWithTimeout(url: string): Promise<Body> {
     return new Promise<Body>((resolve, reject) => {
       const timer = setTimeout(
@@ -320,24 +400,6 @@ export class EMSClient {
     });
   }
 
-  /**
-   * Add optional query-parameters to all requests
-   *
-   * @param additionalQueryParams
-   */
-  addQueryParams(additionalQueryParams: { [key: string]: string }): void {
-    for (const key in additionalQueryParams) {
-      if (additionalQueryParams.hasOwnProperty(key)) {
-        if (additionalQueryParams[key] !== this._queryParams[key]) {
-          //changes detected.
-          this._queryParams = _.assign({}, this._queryParams, additionalQueryParams);
-          this._invalidateSettings();
-          break;
-        }
-      }
-    }
-  }
-
   private async _getManifestWithParams<T>(url: string): Promise<T> {
     const extendedUrl = this.extendUrlWithParams(url);
     return await this.getManifest(extendedUrl);
@@ -417,66 +479,4 @@ export class EMSClient {
       }
     );
   }
-
-  async getMainManifest(): Promise<EmsCatalogManifest> {
-    return await this._getMainCatalog();
-  }
-
-  async getDefaultFileManifest(): Promise<EmsFileCatalog> {
-    return await this._getDefaultFileCatalog();
-  }
-
-  async getDefaultTMSManifest(): Promise<EmsTmsCatalog> {
-    return await this._getDefaultTMSCatalog();
-  }
-
-  async getFileLayers(): Promise<FileLayer[]> {
-    return await this._loadFileLayers();
-  }
-
-  async getTMSServices(): Promise<TMSService[]> {
-    return await this._loadTMSServices();
-  }
-
-  getTileApiUrl(): string {
-    return this._tileApiUrl;
-  }
-
-  getFileApiUrl(): string {
-    return this._fileApiUrl;
-  }
-
-  getLandingPageUrl(): string {
-    return this._emsLandingPageUrl;
-  }
-
-  sanitizeHtml(html: string): string {
-    return this._sanitizer(html);
-  }
-
-  extendUrlWithParams(url: string): string {
-    return unescapeTemplateVars(
-      extendUrl(url, {
-        query: this._queryParams,
-      })
-    );
-  }
-
-  async findFileLayerById(id: string): Promise<FileLayer | undefined> {
-    const fileLayers = await this.getFileLayers();
-    for (let i = 0; i < fileLayers.length; i++) {
-      if (fileLayers[i].hasId(id)) {
-        return fileLayers[i];
-      }
-    }
-  }
-
-  async findTMSServiceById(id: string): Promise<TMSService | undefined> {
-    const tmsServices = await this.getTMSServices();
-    for (let i = 0; i < tmsServices.length; i++) {
-      if (tmsServices[i].hasId(id)) {
-        return tmsServices[i];
-      }
-    }
-  }
 }

src/ems_service.ts

@@ -44,7 +44,7 @@ export abstract class AbstractEmsService implements IEmsService {
   }
 
   getAttributions(): { url: string; label: string }[] {
-    return this._config.attribution.map(attribution => {
+    return this._config.attribution.map((attribution) => {
       const url = this._emsClient.getValueInLanguage(attribution.url);
       const label = this._emsClient.getValueInLanguage(attribution.label);
       return {
@@ -55,7 +55,7 @@ export abstract class AbstractEmsService implements IEmsService {
   }
 
   getHTMLAttribution(): string {
-    const attributions = this._config.attribution.map(attribution => {
+    const attributions = this._config.attribution.map((attribution) => {
       const url = this._emsClient.getValueInLanguage(attribution.url);
       const label = this._emsClient.getValueInLanguage(attribution.label);
       const html = url ? `<a rel="noreferrer noopener" href="${url}">${label}</a>` : label;
@@ -65,7 +65,7 @@ export abstract class AbstractEmsService implements IEmsService {
   }
 
   getMarkdownAttribution(): string {
-    const attributions = this._config.attribution.map(attribution => {
+    const attributions = this._config.attribution.map((attribution) => {
       const url = this._emsClient.getValueInLanguage(attribution.url);
       const label = this._emsClient.getValueInLanguage(attribution.label);
       return `[${label}](${url})`;
@@ -79,7 +79,7 @@ export abstract class AbstractEmsService implements IEmsService {
 
   /**
    * Checks if url is absolute. If not, prepend the basePath.
-  */
+   */
   protected _getAbsoluteUrl = (url: string) => {
     if (/^https?:\/\//.test(url)) {
       return url;
@@ -95,6 +95,4 @@ export abstract class AbstractEmsService implements IEmsService {
   abstract hasId(id: string): boolean;
 
   abstract getApiUrl(): string;
-
-
 }

src/file_layer.ts

@@ -35,7 +35,7 @@ export class FileLayer extends AbstractEmsService {
   }
 
   getFieldsInLanguage(): { type: string; name: string; description: string }[] {
-    return this._config.fields.map(field => {
+    return this._config.fields.map((field) => {
       return {
         type: field.type,
         name: field.id,
@@ -58,16 +58,6 @@ export class FileLayer extends AbstractEmsService {
     return this._config.layer_id === id || matchesLegacyId;
   }
 
-  private _getDefaultFormat(): EmsFileLayerFormatGeoJson | EmsFileLayerFormatTopoJson {
-    const defaultFormat = this._config.formats.find(format => {
-      return format.legacy_default;
-    });
-    if (defaultFormat) {
-      return defaultFormat;
-    }
-    return this._config.formats[0];
-  }
-
   getEMSHotLink(): string {
     const landingPageString = this._emsClient.getLandingPageUrl();
     const urlObject = url.parse(landingPageString, true);
@@ -106,4 +96,14 @@ export class FileLayer extends AbstractEmsService {
   getApiUrl(): string {
     return this._emsClient.getFileApiUrl();
   }
+
+  private _getDefaultFormat(): EmsFileLayerFormatGeoJson | EmsFileLayerFormatTopoJson {
+    const defaultFormat = this._config.formats.find((format) => {
+      return format.legacy_default;
+    });
+    if (defaultFormat) {
+      return defaultFormat;
+    }
+    return this._config.formats[0];
+  }
 }