Merge pull request #50 from agiledigital-labs/feature/IE-366-lint-changes

Feature/ie 366 lint changes

Author: dspasojevic

index.js

@@ -37,9 +37,22 @@ const config = {
     ],
     rules: {
         "no-template-curly-in-string": ["error"],
-        "no-console": [
+        // In all contexts, use a structured logger such as Pino instead.
+        // In an fp context, use an appropriate IO type.
+        "no-console": ["error"],
+        // Encourage use of https://github.com/agiledigital-labs/pino-redact-pii
+        "no-restricted-properties": [
             "error",
-            { allow: ["info", "warn", "error", "trace", "debug"] },
+            {
+                object: "JSON",
+                property: "stringify",
+                message: "Use a safe stringify alterative",
+            },
+            {
+                object: "util",
+                property: "inspect",
+                message: "Use a safe stringify alterative",
+            },
         ],
         "functional/no-expression-statements": [
             "error",

index.ts

@@ -38,9 +38,22 @@ const config: TSESLint.Linter.Config = {
   ],
   rules: {
     "no-template-curly-in-string": ["error"],
-    "no-console": [
+    // In all contexts, use a structured logger such as Pino instead.
+    // In an fp context, use an appropriate IO type.
+    "no-console": ["error"],
+    // Encourage use of https://github.com/agiledigital-labs/pino-redact-pii
+    "no-restricted-properties": [
       "error",
-      { allow: ["info", "warn", "error", "trace", "debug"] },
+      {
+        object: "JSON",
+        property: "stringify",
+        message: "Use a safe stringify alterative",
+      },
+      {
+        object: "util",
+        property: "inspect",
+        message: "Use a safe stringify alterative",
+      },
     ],
     "functional/no-expression-statements": [
       "error",

package.json

@@ -23,28 +23,28 @@
     "typescript": "^5.0.0"
   },
   "devDependencies": {
-    "@agiledigital/eslint-config": "^4.0.0",
-    "@types/react": "^18.2.21",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "@typescript-eslint/parser": "^6.7.5",
-    "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-config-typed-fp": "^5.3.0",
+    "@agiledigital/eslint-config": "^4.1.0",
+    "@types/react": "^18.2.46",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-typed-fp": "^5.4.0",
     "eslint-plugin-functional": "^6.0.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.4.2",
-    "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.6.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-prettier": "^5.1.2",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-sonarjs": "^0.21.0",
+    "eslint-plugin-sonarjs": "^0.23.0",
     "eslint-plugin-total-functions": "^7.1.0",
     "jest": "^29.7.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.1",
     "react": "^18.2.0",
     "ts-jest": "^29.1.1",
-    "type-coverage": "^2.27.0",
-    "typescript": "^5.2.2"
+    "type-coverage": "^2.27.1",
+    "typescript": "^5.3.3"
   },
   "scripts": {
     "build": "tsc",

test-fixtures/base.js

@@ -1,11 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFunction = exports.myFunctionWithParam = exports.myFunction = exports.whoops = void 0;
-// Note: no functional/no-expression-statements error here
-console.info("hello");
-// Note: error on no console log.
+exports.useFunction = exports.myFunctionWithParam = exports.myFunction = exports.whoops = exports.b = exports.a = void 0;
+// Console is forbidden
 // eslint-disable-next-line no-console
-console.log("not good");
+console.info("");
+// eslint-disable-next-line no-console
+console.log("");
+// eslint-disable-next-line no-console
+console.error("");
+// eslint-disable-next-line no-console
+console.warn("");
+// error  'JSON.stringify' is restricted from being used. Use a safe stringify alterative
+// eslint-disable-next-line no-restricted-properties
+exports.a = JSON.stringify("");
+// NB JSON.stringify is not detected when accessed via an alias.
+// eslint-disable-next-line functional/prefer-immutable-types
+const JSONAlias = JSON;
+exports.b = JSONAlias.stringify("");
 // Note: no-template-curly-in-string is on
 // eslint-disable-next-line no-template-curly-in-string
 exports.whoops = "${whoops}";
@@ -14,9 +25,8 @@ exports.whoops = "${whoops}";
 const myFunction = () => "";
 exports.myFunction = myFunction;
 // Note: report the expected functional parameters errors.
-// eslint-disable-next-line functional/functional-parameters, functional/prefer-immutable-types
-const myFunctionWithParam = (...args) => {
-    console.info(args);
+// eslint-disable-next-line functional/functional-parameters, functional/prefer-immutable-types, @typescript-eslint/no-unused-vars
+const myFunctionWithParam = (..._args) => {
     return "";
 };
 exports.myFunctionWithParam = myFunctionWithParam;

test-fixtures/base.ts

@@ -1,9 +1,21 @@
-// Note: no functional/no-expression-statements error here
-console.info("hello");
-
-// Note: error on no console log.
+// Console is forbidden
+// eslint-disable-next-line no-console
+console.info("");
+// eslint-disable-next-line no-console
+console.log("");
 // eslint-disable-next-line no-console
-console.log("not good");
+console.error("");
+// eslint-disable-next-line no-console
+console.warn("");
+
+// error  'JSON.stringify' is restricted from being used. Use a safe stringify alterative
+// eslint-disable-next-line no-restricted-properties
+export const a = JSON.stringify("");
+
+// NB JSON.stringify is not detected when accessed via an alias.
+// eslint-disable-next-line functional/prefer-immutable-types
+const JSONAlias = JSON;
+export const b = JSONAlias.stringify("");
 
 // Note: no-template-curly-in-string is on
 // eslint-disable-next-line no-template-curly-in-string
@@ -14,9 +26,8 @@ export const whoops = "${whoops}";
 export const myFunction = (): string => "";
 
 // Note: report the expected functional parameters errors.
-// eslint-disable-next-line functional/functional-parameters, functional/prefer-immutable-types
-export const myFunctionWithParam = (...args: string[]): string => {
-  console.info(args);
+// eslint-disable-next-line functional/functional-parameters, functional/prefer-immutable-types, @typescript-eslint/no-unused-vars
+export const myFunctionWithParam = (..._args: string[]): string => {
   return "";
 };