chore/add linting

Author: dabeeeenster

.eslintrc

@@ -0,0 +1,27 @@
+{
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2017,
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "plugins": ["react-hooks"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:react/jsx-runtime",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": "warn",
+    "react-hooks/rules-of-hooks": "error",
+    "react/display-name": "off"
+  },
+  "settings": {
+    "react": {
+      "version": "17"
+    }
+  }
+}

.pre-commit-config.yaml

@@ -10,3 +10,18 @@ repos:
     rev: v3.0.0
     hooks:
       - id: prettier
+
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v8.55.0
+    hooks:
+      - id: eslint
+        additional_dependencies:
+          - [email protected]
+          - [email protected]
+          - [email protected]
+          - [email protected]
+        exclude: |
+          (?x)^(
+              package.json|
+              tests/.*
+          )$

.prettierignore

@@ -0,0 +1,2 @@
+package.json
+package-lock.json

.prettierrc.json

@@ -1,21 +1,3 @@
 {
-    "proseWrap": "always",
-    "singleQuote": true,
-    "printWidth": 120,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "overrides": [
-        {
-            "files": "**/*.md",
-            "options": {
-                "tabWidth": 1
-            }
-        },
-        {
-            "files": ["**/*.yml", "**/*.yaml"],
-            "options": {
-                "tabWidth": 2
-            }
-        }
-    ]
+  "printWidth": 100
 }

flagsmith-jira-app/README.md

@@ -1,9 +1,12 @@
 # Flagsmith Jira App
 
-This project contains a Forge app written in TypeScript that provides a table of Flagsmith features in a Jira issue panel.
-The app is based on the [Jira hello world app](https://developer.atlassian.com/platform/forge/build-a-hello-world-app-in-jira/) so any oddities in its configuration are as created by following those instructions.
+This project contains a Forge app written in TypeScript that provides a table of Flagsmith features in a Jira issue
+panel. The app is based on the
+[Jira hello world app](https://developer.atlassian.com/platform/forge/build-a-hello-world-app-in-jira/) so any oddities
+in its configuration are as created by following those instructions.
 
-See [developer.atlassian.com/platform/forge](https://developer.atlassian.com/platform/forge) for documentation and tutorials explaining Forge.
+See [developer.atlassian.com/platform/forge](https://developer.atlassian.com/platform/forge) for documentation and
+tutorials explaining Forge.
 
 ## Overview
 
@@ -23,21 +26,25 @@ See [README.md](../README.md) in the containing folder for instructions to get s
 
 ### Developer Console
 
-Manage, distribute and monitor Forge apps using the [Developer console](https://developer.atlassian.com/platform/forge/manage-your-apps/).
+Manage, distribute and monitor Forge apps using the
+[Developer console](https://developer.atlassian.com/platform/forge/manage-your-apps/).
 
 ### Manifest
 
 The app is defined in the `manifest.yml` file.
 
-This includes the `id` of the app within Atlassian Cloud. Change this value to deploy code to a different app, e.g. one created in a developer account.
+This includes the `id` of the app within Atlassian Cloud. Change this value to deploy code to a different app, e.g. one
+created in a developer account.
 
 ### Source Code
 
-The three entry points to the app are contained in the `src/index.jsx` file. These define React components for App Settings, Project Settings and Issue Panel.
+The three entry points to the app are contained in the `src/index.jsx` file. These define React components for App
+Settings, Project Settings and Issue Panel.
 
 ### Linting and Formatting
 
-The Atlassian template provided some basic eslint config, to which sensible TypeScript/React/Prettier defaults have been added.
+The Atlassian template provided some basic eslint config, to which sensible TypeScript/React/Prettier defaults have been
+added.
 
 Execute `npm run eslint` to check linting and formatting.
 
@@ -51,23 +58,29 @@ Forge apps may be deployed to one of three environments:
 
 Once an app is running in an environment, you can install it from that environment onto an Atlassian site.
 
-By default, the CLI commands affect the development environment unless you specify another with the `--environment` flag. All the commands provide help given the `--help` flag.
+By default, the CLI commands affect the development environment unless you specify another with the `--environment`
+flag. All the commands provide help given the `--help` flag.
 
 First ensure you're in the `flagsmith-jira-app` folder, not the containing folder.
 
 Use the `deploy` command and follow the prompts to persist code changes:
 
     forge deploy
 
-Forge handles version numbering itself - the version number in `package.json` is not used. Generally, deployments that involve a change to permissions or authn/authz in `manifest.yml` cause a major increment and require the user to accept these changes to upgrade their installation. Other deployments cause a minor increment and upgrades are installed automatically.
+Forge handles version numbering itself - the version number in `package.json` is not used. Generally, deployments that
+involve a change to permissions or authn/authz in `manifest.yml` cause a major increment and require the user to accept
+these changes to upgrade their installation. Other deployments cause a minor increment and upgrades are installed
+automatically.
 
-See [Environments and versions](https://developer.atlassian.com/platform/forge/environments-and-versions/) for more information.
+See [Environments and versions](https://developer.atlassian.com/platform/forge/environments-and-versions/) for more
+information.
 
 Use the `install` command and follow the prompts to install the app on a new site:
 
     forge install
 
-Once the app is installed on a site, the site picks up changes you deploy without needing to rerun the install command. For major version changes the `--upgrade` flag must be used.
+Once the app is installed on a site, the site picks up changes you deploy without needing to rerun the install command.
+For major version changes the `--upgrade` flag must be used.
 
 ### Debugging and Development
 
@@ -79,12 +92,16 @@ To switch this off again:
 
     forge variables unset DEBUG
 
-Use the `tunnel` command to test code (but not manifest) changes without having to deploy them (development environment only). This proxies invocations when you use the app to your local environment. To set environment variables, prefix them with `FORGE_USER_VAR_`:
+Use the `tunnel` command to test code (but not manifest) changes without having to deploy them (development environment
+only). This proxies invocations when you use the app to your local environment. To set environment variables, prefix
+them with `FORGE_USER_VAR_`:
 
     FORGE_USER_VAR_DEBUG=1 forge tunnel
 
-This command may report a "Checking Docker image... failed" error and then work anyway. This [may be resolved](https://community.developer.atlassian.com/t/forge-tunnel-error-checking-docker-image/45490/14) by typing `export DOCKER_CLI_HINTS=false` first.
-See [Tunneling](https://developer.atlassian.com/platform/forge/tunneling/) for more information on testing using local files and servers.
+This command may report a "Checking Docker image... failed" error and then work anyway. This
+[may be resolved](https://community.developer.atlassian.com/t/forge-tunnel-error-checking-docker-image/45490/14) by
+typing `export DOCKER_CLI_HINTS=false` first. See [Tunneling](https://developer.atlassian.com/platform/forge/tunneling/)
+for more information on testing using local files and servers.
 
 Use the `logs` command to see logs (development/staging environment only):
 

flagsmith-jira-app/src/jira.ts

@@ -52,7 +52,9 @@ const getEntityProperty = async <T>(
   const entityId = String(jiraContext[`${entityType}Id`]);
   const data = (await jiraApi(
     route`/rest/api/3/${entityType}/${entityId}/properties/${propertyKey}`,
-    { codes: [404] },
+    {
+      codes: [404],
+    },
   )) as { value?: T };
   return data?.value;
 };