add eslint

packages/util-address/package.json

@@ -18,9 +18,9 @@
     "@onflow/types": "^1.2.0-alpha.0",
     "@types/jest": "^29.5.3",
     "@types/node": "^18.13.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "eslint": "^8.46.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
     "eslint-plugin-jsdoc": "^46.4.6",
     "jest": "^29.5.0",
     "typescript": "^4.9.5"

packages/util-encode-key/.eslintrc copy.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "jest": true,
+    "node": true
+  },
+  "extends": [
+    "plugin:jsdoc/recommended-typescript",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": ["jsdoc", "@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "ignorePatterns": ["**/dist/"]
+}

packages/util-encode-key/package.json

@@ -18,9 +18,9 @@
     "@onflow/types": "^1.2.0-alpha.0",
     "@types/jest": "^29.5.3",
     "@types/node": "^18.13.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "eslint": "^8.46.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
     "eslint-plugin-jsdoc": "^46.4.6",
     "jest": "^29.5.0",
     "typescript": "^4.9.5"
@@ -36,7 +36,7 @@
     "build": "npm run lint && fcl-bundle",
     "test:watch": "jest --watch",
     "start": "fcl-bundle --watch",
-    "lint": "eslint src/*.ts"
+    "lint": "eslint ."
   },
   "dependencies": {
     "@babel/runtime": "^7.18.6",

packages/util-invariant/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "jest": true,
+    "node": true
+  },
+  "extends": [
+    "plugin:jsdoc/recommended-typescript",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": ["jsdoc", "@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "ignorePatterns": ["**/dist/"]
+}

packages/util-invariant/package.json

@@ -13,8 +13,14 @@
     "url": "https://github.com/onflow/flow-js-sdk/issues"
   },
   "devDependencies": {
+    "@babel/preset-typescript": "^7.22.5",
     "@onflow/fcl-bundle": "^1.4.0-alpha.0",
     "@onflow/types": "^1.2.0-alpha.0",
+    "@types/jest": "^29.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
+    "eslint-plugin-jsdoc": "^46.4.6",
     "jest": "^29.5.0"
   },
   "source": "src/index.ts",

packages/util-logger/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "jest": true,
+    "node": true
+  },
+  "extends": [
+    "plugin:jsdoc/recommended-typescript",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": ["jsdoc", "@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "ignorePatterns": ["**/dist/"]
+}

packages/util-logger/package.json

@@ -13,7 +13,13 @@
     "url": "https://github.com/onflow/flow-js-sdk/issues"
   },
   "devDependencies": {
+    "@babel/preset-typescript": "^7.22.5",
     "@onflow/fcl-bundle": "^1.4.0-alpha.0",
+    "@types/jest": "^29.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
+    "eslint-plugin-jsdoc": "^46.4.6",
     "jest": "^29.5.0"
   },
   "source": "src/util-logger.ts",

packages/util-logger/src/util-logger.ts

@@ -2,7 +2,6 @@ import {config} from "@onflow/config"
 
 /**
  * The levels of the logger
- * @enum
  */
 export enum LEVELS {
   debug = 5,
@@ -14,12 +13,10 @@ export enum LEVELS {
 
 /**
  * Builds a message formatted for the logger
- *
- * @param options
+ * @param options - The options for the log
  * @param options.title - The title of the log
  * @param options.message - The message of the log
  * @returns The message formatted for the logger
- *
  * @example
  * buildLoggerMessageArgs({ title: "My Title", message: "My Message" })
  */
@@ -45,16 +42,13 @@ const buildLoggerMessageArgs = (options: {
 
 /**
  * Logs messages based on the level of the message and the level set in the config
- *
  * @param options - The options for the log
  * @param options.title - The title of the log
  * @param options.message - The message of the log
  * @param options.level - The level of the log
  * @param options.always - Whether to always show the log
- *
  * @example
  * log({ title: "My Title", message: "My Message", level: LEVELS.warn, always: false })
- *
  */
 export const log = async (options: {
   title: string
@@ -89,19 +83,22 @@ export const log = async (options: {
 }
 
 /**
- * Logs a deprecation notice
- *
+ * Logs a deprecation notice.  If a callback is provided this function returns a function that will call the callback and log the deprecation notice, otherwise it just logs the deprecation notice.
  * @param options - The options for the log
  * @param options.pkg - The package that is being deprecated
  * @param options.subject - The subject of the deprecation
  * @param options.transition - The transition path for the deprecation
  * @param options.level - The level of the log
  * @param options.message - The message of the log
  * @param options.callback - A callback to run after the log
- *
+ * @returns A function that will call the callback and log the deprecation notice if the callback is provided
  * @example
+ * // Logs a deprecation notice
  * log.deprecate({ pkg: "@onflow/fcl", subject: "Some item", transition: "https://github.com/onflow/flow-js-sdk", message: "Descriptive message", level: LEVELS.warn, callback: () => {} })
- *
+ * @example
+ * function someFunction() { ... }
+ * const deprecatedFunction = log.deprecate({ pkg: "@onflow/fcl", subject: "Some item", transition: "https://github.com/foo/bar/TRANSITIONS.md", message: "Descriptive message", level: LEVELS.warn, callback: someFunction })
+ * deprecatedFunction() // Calls someFunction and logs the deprecation notice
  */
 log.deprecate = <T, U>(options: {
   pkg?: string
@@ -110,7 +107,7 @@ log.deprecate = <T, U>(options: {
   level?: number
   message?: string
   callback?: (...args: T[]) => U
-}) => {
+}): ((...args: T[]) => Promise<U>) | Promise<void> => {
   const {
     pkg,
     subject,

packages/util-template/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "jest": true,
+    "node": true
+  },
+  "extends": [
+    "plugin:jsdoc/recommended-typescript",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "plugins": ["jsdoc", "@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "ignorePatterns": ["**/dist/"]
+}

packages/util-template/package.json

@@ -16,9 +16,9 @@
     "@babel/preset-typescript": "^7.22.5",
     "@onflow/fcl-bundle": "^1.4.0-alpha.0",
     "@types/jest": "^29.5.3",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "eslint": "^8.46.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
     "eslint-plugin-jsdoc": "^46.4.6",
     "jest": "^29.5.0"
   },

packages/util-template/src/__snapshots__/template.test.ts.snap

@@ -10,7 +10,7 @@ exports[`template interop function template(template\`\${o=>o.a}\`)(o) -> 'abc'
 
 exports[`template interop function template\`\${o=>o.a}\`(o) -> 'abc' 1`] = `"abc"`;
 
-exports[`template interop more template template(template\`x\${template\`y\${o => o.a}\`}\`)(o) -> 'xyabc' 1`] = `"xyabc"`;
+exports[`template interop more template template(template\`x\${template\`y\${(_o: typeof o) => _o.a}\`}\`)(o) -> 'xyabc' 1`] = `"xyabc"`;
 
 exports[`template interop more template template\`x\${template\`y\${o=>o.a}\`}\`(o) => 'xyabc' 1`] = `"xyabc"`;
 

packages/util-template/src/template.test.ts

@@ -1,4 +1,3 @@
-//@ts-nocheck
 import {template, interleave} from "./template"
 
 describe("interleave", () => {
@@ -24,14 +23,14 @@ describe("interleave", () => {
   })
 })
 
-const _ = (msg, a, b?) => {
+const _ = (msg: string, a: unknown, b?: unknown) => {
   if (b == null) {
     test(msg, () => expect(a).toMatchSnapshot())
   } else {
     test(msg, () => expect(a).toBe(b))
   }
 }
-const t = v => typeof v
+const t = <T>(v: T) => typeof v
 
 describe("template", () => {
   describe("input type vs output type", () => {
@@ -53,31 +52,31 @@ describe("template", () => {
 
   describe("interop function", () => {
     const o = {a: "abc"}
-    _("template`${o=>o.a}`(o) -> 'abc'", template`${o => o.a}`(o))
+    _("template`${o=>o.a}`(o) -> 'abc'", template`${(_o: typeof o) => _o.a}`(o))
     _(
       "template(template`${o=>o.a}`)(o) -> 'abc'",
-      template(template`${o => o.a}`)(o)
+      template(template`${(_o: typeof o) => _o.a}`)(o)
     )
   })
 
   describe("interop more template", () => {
     const o = {a: "abc"}
     _(
       "template`x${template`y${o=>o.a}`}`(o) => 'xyabc'",
-      template`x${template`y${o => o.a}`}`(o)
+      template`x${template`y${(_o: typeof o) => _o.a}`}`(o)
     )
     _(
       "template`x${template`y${template`z${o=>o.a}`}`}`(o) => 'xyabc'",
-      template`x${template`y${template`z${o => o.a}`}`}`(o)
+      template`x${template`y${template`z${(_o: typeof o) => _o.a}`}`}`(o)
     )
     _(
-      "template(template`x${template`y${o => o.a}`}`)(o) -> 'xyabc'",
-      template(template`x${template`y${o => o.a}`}`)(o)
+      "template(template`x${template`y${(_o: typeof o) => _o.a}`}`)(o) -> 'xyabc'",
+      template(template`x${template`y${(_o: typeof o) => _o.a}`}`)(o)
     )
   })
 
   describe("interop nested functions", () => {
-    const fn = a => b => c => d => e => f => f.a
+    const fn = () => () => () => () => () => (f: typeof o) => f.a
     const o = {a: "abc"}
     _("template`${fn}`(o) -> 'abc'", template`${fn}`(o))
   })
@@ -89,8 +88,10 @@ describe("template", () => {
 
   describe("object can have non string values", () => {
     const data = {a: 1, b: NaN, c: undefined, d: null, e: false, f: true}
-    const tx = template`a:${o => o.a}|b:${o => o.b}|c:${o => o.c}|d:${o =>
-      o.d}|e:${o => o.e}|f:${o => o.f}`
+    const tx = template`a:${(o: typeof data) => o.a}|b:${(o: typeof data) =>
+      o.b}|c:${(o: typeof data) => o.c}|d:${(o: typeof data) => o.d}|e:${(
+      o: typeof data
+    ) => o.e}|f:${(o: typeof data) => o.f}`
     _("template(data)", tx(data), "a:1|b:NaN|c:undefined|d:null|e:false|f:true")
   })
 })

packages/util-template/src/template.ts

@@ -1,13 +1,23 @@
 import {log} from "@onflow/util-logger"
 
-export function interleave(
-  a: unknown[] = [],
-  b: unknown[] = [],
-  c: unknown[] = []
-): unknown[] {
+/**
+ * Interleaves two arrays
+ * @param a - The first array
+ * @param b - The second array
+ * @param c - The target array
+ * @returns The interleaved array
+ */
+export function interleave<A, B>(
+  a: A[] = [],
+  b: B[] = [],
+  c: (A | B)[] = []
+): (A | B)[] {
   if (!a.length && !b.length) return c
   if (!a.length) return c
-  if (!b.length) return [...c, a[0]]
+  if (!b.length) {
+    c.push(...a)
+    return c
+  }
 
   const [aHead, ...aRest] = a
   const [bHead, ...bRest] = b
@@ -18,7 +28,12 @@ export function interleave(
   return interleave(aRest, bRest, c)
 }
 
-function recApply(d: unknown): (x: unknown) => string {
+/**
+ * Recursively apply a value to a function
+ * @param d - The value to apply
+ * @returns A function that takes a function and applies the value to it
+ */
+function recApply<T, U>(d: T): (x: U) => string {
   return function (arg1) {
     if (typeof arg1 === "function") {
       log.deprecate({
@@ -33,14 +48,20 @@ function recApply(d: unknown): (x: unknown) => string {
   }
 }
 
+/**
+ * Creates a template function
+ * @param head - A string, template string array, or template function
+ * @param rest - The rest of the arguments
+ * @returns A template function
+ */
 export function template(
-  head: string | TemplateStringsArray | ((x: unknown) => string),
+  head: string | TemplateStringsArray | ((x?: unknown) => string),
   ...rest: unknown[]
 ): (x?: unknown) => string {
   if (typeof head === "string") return () => head
   if (typeof head === "function") return head
-  return d =>
-    interleave([...head], rest.map(recApply(d)))
+  return (x: unknown) =>
+    interleave([...head], rest.map(recApply(x)))
       .join("")
       .trim()
 }