fix: enable ESLint (#4)

Author: rcooney

.github/workflows/ci-cd.yml

@@ -28,6 +28,8 @@ jobs:
 
             - run: npm run build
 
+            - run: npm run lint
+
             - run: npm run test
 
     release:

README.md

@@ -61,6 +61,12 @@ Interactively generate a new activity or form element.
 
 Runs the project in development mode. Your activity pack will be available at [http://localhost:5000/main.js](http://localhost:5000/main.js). The HTTPS certificate of the development server is a self-signed certificate that web browsers will warn about. To work around this open [`https://localhost:5000/main.js`](https://localhost:5000/main.js) in a web browser and allow the invalid certificate as an exception. For creating a locally-trusted HTTPS certificate see the [Configuring a HTTPS Certificate](https://developers.geocortex.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate) section on the [Geocortex Developer Center](https://developers.geocortex.com/docs/workflow/overview/).
 
+### `npm run test`
+Runs all unit tests.
+
+### `npm run lint`
+Runs linter to perform static analysis.
+
 ### `npm run build`
 
 Builds the activity pack for production to the `build` folder. It optimizes the build for the best performance.

package.json

@@ -21,6 +21,7 @@
     "scripts": {
         "build": "vertigis-workflow-sdk build",
         "generate": "vertigis-workflow-sdk generate",
+        "lint": "eslint -f codeframe --max-warnings 0 --ext .ts,.tsx src/",
         "start": "vertigis-workflow-sdk start",
         "test": "jest",
         "test:watch": "npm run test --watch"

src/__tests__/request.test.ts

@@ -75,7 +75,7 @@ describe("request", () => {
             await expect(() => post(service, "path")).rejects.toThrow("url is required");
         });
         it("combines url and path", async () => {
-            mockResponseOnce({}, (input, init) => {
+            mockResponseOnce({}, (input) => {
                 expect(input).toBe(`http://test/api/path`);
             });
 

src/request.ts

@@ -1,10 +1,10 @@
 import { ApiService } from "./ApiService";
 
-export async function get(
+export async function get<T = any>(
     service: ApiService,
     path: string,
     params?: { [key: string]: any }
-) {
+): Promise<T> {
     if (!service.url) {
         throw new Error("url is required");
     }
@@ -20,11 +20,11 @@ export async function get(
     return response;
 }
 
-export async function post(
+export async function post<T = any>(
     service: ApiService,
     path: string,
     data?: { [key: string]: any }
-) {
+): Promise<T> {
     if (!service.url) {
         throw new Error("url is required");
     }
@@ -42,7 +42,7 @@ export async function post(
     return response;
 }
 
-function objectToQueryString(data?: {}): string {
+function objectToQueryString(data?: Record<string, string | number | boolean>): string {
     if (!data) {
         return "";
     }

tsconfig.json

@@ -3,6 +3,5 @@
     "compilerOptions": {
         "target": "es2018"
     },
-    "include": ["src"],
-    "exclude": ["**/__tests__/**/*"]
+    "include": ["src"]
 }