Merge pull request #254 from agiledigital/update-linting-redux

Update dependencies, linting, readonlyness

Author: dspasojevic

README.md

@@ -2,7 +2,7 @@
 
 ![CI Status](https://github.com/agiledigital/jiralint/actions/workflows/build-test-release.yml/badge.svg)
 
-Contains simple issue checks that can be applied to individual issues and a bare-bones CLI tool for applying them.
+Contains issue checks that can be applied to individual issues and a bare-bones CLI tool for applying them.
 
 ## Build
 

cli/.eslintrc.js

@@ -20,7 +20,6 @@ module.exports = {
     "total-functions",
   ],
   rules: {
-    "functional/no-return-void": "warn",
     // https://github.com/aotaduy/eslint-plugin-spellcheck
     "spellcheck/spell-checker": [
       "warn",

cli/package.json

@@ -19,45 +19,46 @@
     "clear": "0.1.0",
     "clui": "0.3.6",
     "colors": "1.4.0",
-    "date-fns": "2.29.2",
-    "fp-ts": "2.12.3",
+    "date-fns": "2.29.3",
+    "fp-ts": "2.13.1",
     "inquirer": "8.2.4",
-    "io-ts": "2.2.18",
-    "io-ts-types": "0.5.16",
+    "io-ts": "2.2.20",
+    "io-ts-types": "0.5.19",
     "monocle-ts": "2.3.13",
     "newtype-ts": "0.3.5",
     "oauth": "0.10.0",
-    "readonly-types": "3.0.0",
+    "readonly-types": "4.5.0",
     "string-length": "4.0.2",
-    "ts-pattern": "3.3.5",
+    "ts-pattern": "4.2.1",
     "yargs": "17.5.1"
   },
   "devDependencies": {
     "@types/clear": "0.1.2",
     "@types/clui": "0.3.1",
     "@types/inquirer": "7.3.3",
-    "@types/jest": "29.0.0",
+    "@types/jest": "29.4.0",
     "@types/oauth": "0.9.1",
-    "@typescript-eslint/eslint-plugin": "5.36.1",
-    "@typescript-eslint/parser": "5.36.1",
-    "eslint": "8.23.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-config-typed-fp": "3.3.0",
-    "eslint-plugin-functional": "4.2.2",
-    "eslint-plugin-jest": "27.0.1",
+    "@typescript-eslint/eslint-plugin": "5.54.1",
+    "@typescript-eslint/parser": "5.54.1",
+    "eslint": "8.35.0",
+    "eslint-config-agile-digital": "^2.6.0",
+    "eslint-config-prettier": "8.7.0",
+    "eslint-config-typed-fp": "4.4.0",
+    "eslint-plugin-functional": "5.0.5",
+    "eslint-plugin-jest": "27.2.1",
     "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-sonarjs": "0.15.0",
-    "eslint-plugin-total-functions": "6.0.0",
-    "jest": "28.1.3",
-    "prettier": "2.7.1",
+    "eslint-plugin-sonarjs": "0.18.0",
+    "eslint-plugin-total-functions": "6.3.0",
+    "jest": "29.5.0",
+    "prettier": "2.8.4",
     "rollup": "2.79.0",
     "rollup-plugin-cleanup": "3.2.1",
     "rollup-plugin-delete": "2.0.0",
     "rollup-plugin-typescript2": "0.33.0",
-    "ts-jest": "28.0.8",
+    "ts-jest": "29.0.5",
     "tsconfig-paths-webpack-plugin": "4.0.0",
-    "type-coverage": "2.22.0",
-    "typescript": "4.8.2"
+    "type-coverage": "2.24.1",
+    "typescript": "4.9.5"
   },
   "typeCoverage": {
     "atLeast": 100,

cli/src/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/prefer-readonly-parameter-types */
 import { pipe, flow } from "fp-ts/lib/function";
 import {
   JiraClient,
@@ -22,27 +21,31 @@ import clc from "cli-color";
  * Dynamic type for global arguments. This needs to be its own as we use a
  * require below to import all the commands
  */
+// eslint-disable-next-line functional/type-declaration-immutability
 export type RootCommand = typeof rootCommand;
 
 /**
  * Add global arguments here using the .option function.
  * E.g. const rootCommand = yargs.option('example', {type: 'string'});
  */
+// eslint-disable-next-line functional/prefer-immutable-types
 const rootCommand = yargs;
 
-const CliConfig = T.type({
-  jiraProtocol: T.union([T.string, T.undefined]),
-  jiraHost: T.union([T.string, T.undefined]),
-  qualityFieldName: T.union([T.string, T.undefined]),
-  qualityReasonFieldName: T.union([T.string, T.undefined]),
-  personalAccessToken: T.union([T.string, T.undefined]),
-  jiraConsumerKey: T.union([T.string, T.undefined]),
-  jiraConsumerSecret: T.union([T.string, T.undefined]),
-  accessToken: T.union([T.string, T.undefined]),
-  accessSecret: T.union([T.string, T.undefined]),
-  username: T.union([T.string, T.undefined]),
-  password: T.union([T.string, T.undefined]),
-});
+const CliConfig = T.readonly(
+  T.type({
+    jiraProtocol: T.union([T.string, T.undefined]),
+    jiraHost: T.union([T.string, T.undefined]),
+    qualityFieldName: T.union([T.string, T.undefined]),
+    qualityReasonFieldName: T.union([T.string, T.undefined]),
+    personalAccessToken: T.union([T.string, T.undefined]),
+    jiraConsumerKey: T.union([T.string, T.undefined]),
+    jiraConsumerSecret: T.union([T.string, T.undefined]),
+    accessToken: T.union([T.string, T.undefined]),
+    accessSecret: T.union([T.string, T.undefined]),
+    username: T.union([T.string, T.undefined]),
+    password: T.union([T.string, T.undefined]),
+  })
+);
 type CliConfig = T.TypeOf<typeof CliConfig>;
 
 const currentDirectory = process.cwd();
@@ -89,7 +92,6 @@ const configIfExists = (dir: string): CliConfig | undefined => {
         E.chain(decodeJson(jiralintConfigFileName, CliConfig.decode)),
         E.fold(
           (error) => {
-            // eslint-disable-next-line functional/no-expression-statement
             console.error(
               `\n${clc.red.bold(
                 jiralintConfigFileName
@@ -136,7 +138,7 @@ type JiraParameters = {
 
 type JiraClientBuilder = JiraParameters & {
   readonly missingParameters: readonly PropertyKey[];
-  readonly client?: JiraClient;
+  readonly client?: Readonly<JiraClient>;
 };
 
 /**
@@ -282,7 +284,7 @@ const verifyClient = (builder: JiraClientBuilder): JiraClient =>
     ? (() => {
         // we throw an error here as it's the only way to communicate these
         // errors with yargs at this point.
-        // eslint-disable-next-line functional/no-throw-statement
+        // eslint-disable-next-line functional/no-throw-statements
         throw new Error(
           `Missing required argument${
             builder.missingParameters.length === 1 ? ":" : "s:\n"
@@ -296,6 +298,7 @@ const verifyClient = (builder: JiraClientBuilder): JiraClient =>
  */
 const config: CliConfig | undefined = findConfig(process.cwd());
 
+// eslint-disable-next-line functional/prefer-immutable-types
 export const withCommonOptions = <C extends RootCommand>(command: C) =>
   command
     .option(jiraProtocolOptionKey, {
@@ -326,11 +329,13 @@ export const withCommonOptions = <C extends RootCommand>(command: C) =>
     })
     .group([jiraHostOptionKey, jiraProtocolOptionKey], "Common Required:");
 
+// eslint-disable-next-line functional/prefer-immutable-types
 export const withAuthenticationOptions = <C extends RootCommand>(command: C) =>
   withCommonOptions(command)
     .group([jiraConsumerKeyOptionKey, jiraConsumerSecretOptionKey], "Auth:")
     .demandOption([jiraHostOptionKey, jiraConsumerSecretOptionKey]);
 
+// eslint-disable-next-line functional/prefer-immutable-types
 export const withAuthOptions = <C extends RootCommand>(command: C) =>
   withCommonOptions(command)
     .option(jiraAccessTokenOptionKey, {
@@ -402,6 +407,7 @@ export const withAuthOptions = <C extends RootCommand>(command: C) =>
     )
     .demandOption("jira");
 
+// eslint-disable-next-line functional/prefer-immutable-types
 export const withQualityFieldsOption = <C extends RootCommand>(command: C) =>
   withAuthOptions(command)
     .option("qualityFieldName", {
@@ -417,11 +423,11 @@ export const withQualityFieldsOption = <C extends RootCommand>(command: C) =>
     })
     .demandOption(["qualityFieldName", "qualityReasonFieldName"]);
 
-/* eslint-disable functional/no-expression-statement */
+/* eslint-disable functional/no-expression-statements */
 auth(rootCommand);
 rate(rootCommand);
 search(rootCommand);
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
 rootCommand.demandCommand().strict().help().argv;
-/* eslint-enable functional/no-expression-statement */
+/* eslint-enable functional/no-expression-statements */

cli/src/scripts/auth.ts

@@ -27,9 +27,9 @@ const auth = async (
       return secret;
     }
   );
-  // eslint-disable-next-line functional/no-expression-statement
+  // eslint-disable-next-line no-console
   console.log(`Access token:  ${accessToken}`);
-  // eslint-disable-next-line functional/no-expression-statement
+  // eslint-disable-next-line no-console
   console.log(`Access secret: ${accessSecret}`);
 
   const jiraClient = jiraClientWithOAuth(
@@ -43,24 +43,23 @@ const auth = async (
 
   const user = await jiraClient.currentUser();
 
-  // eslint-disable-next-line functional/no-expression-statement
   isLeft(user)
     ? console.error(`Failed to get current user after auth [${user.left}]`)
     : console.info(JSON.stringify(user.right, null, 2));
 };
 
-// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+// eslint-disable-next-line functional/prefer-immutable-types
 export default ({ command }: RootCommand): Argv<unknown> =>
   command(
     "auth",
     // eslint-disable-next-line spellcheck/spell-checker
     "authorises the linter to call Jira APIs and outputs the access token and secret",
-    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    // eslint-disable-next-line functional/prefer-immutable-types
     (yargs) => withAuthenticationOptions(yargs),
-    // eslint-disable-next-line functional/no-return-void, @typescript-eslint/prefer-readonly-parameter-types
+    // eslint-disable-next-line functional/no-return-void, functional/prefer-immutable-types
     (args) => {
       const protocol = args["jira.protocol"];
-      // eslint-disable-next-line functional/no-expression-statement
+      // eslint-disable-next-line functional/no-expression-statements
       void auth(
         // yargs ensures that this is always 'http' or 'https'
         protocol === "http" || protocol === "https" ? protocol : "https",

cli/src/scripts/rate.ts

@@ -3,7 +3,6 @@ import { Argv } from "yargs";
 import { RootCommand, withQualityFieldsOption } from "..";
 
 const rate = async (
-  // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
   jira: JiraClient,
   key: string,
   quality: string,
@@ -19,16 +18,16 @@ const rate = async (
     reasonFieldName
   );
 
-  // eslint-disable-next-line functional/no-expression-statement
+  // eslint-disable-next-line no-console
   console.log(`Updated [${JSON.stringify(update, null, 2)}]`);
 };
 
-// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+// eslint-disable-next-line functional/prefer-immutable-types
 export default ({ command }: RootCommand): Argv<unknown> =>
   command(
     "rate",
     "records the quality of a jira issue",
-    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    // eslint-disable-next-line functional/prefer-immutable-types
     (yargs) =>
       withQualityFieldsOption(yargs)
         .option("key", {
@@ -46,9 +45,9 @@ export default ({ command }: RootCommand): Argv<unknown> =>
           describe: "reason for assessment",
         })
         .demandOption(["key", "quality", "reason"]),
-    // eslint-disable-next-line functional/no-return-void, @typescript-eslint/prefer-readonly-parameter-types
+    // eslint-disable-next-line functional/prefer-immutable-types, functional/no-return-void
     (args) => {
-      // eslint-disable-next-line functional/no-expression-statement
+      // eslint-disable-next-line functional/no-expression-statements
       void rate(
         args.jira,
         args.key,