fix(valid-types): regression with object field checking

.eslintrc.json

@@ -37,6 +37,8 @@
     "unicorn/no-unsafe-regex": 0,
     "unicorn/prefer-array-some": 0,
     "unicorn/prevent-abbreviations": 0,
-    "linebreak-style": 0
+    "linebreak-style": 0,
+    "no-inline-comments": 0,
+    "no-extra-parens": 0
   }
 }

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npm test && npm run build && npm run check-readme
+npm test && npm run build && npm run check-docs

.ncurc.js

@@ -2,13 +2,16 @@
 
 module.exports = {
   reject: [
     // Todo: When package converted to ESM
     'camelcase',
     'decamelize',
     'escape-string-regexp',
     'open-editor',
 
+    // Todo: When canonical includes latest Unicorn
+    'eslint',
+
     // Todo: Waiting on merge https://github.com/gajus/eslint-plugin-canonical/pull/22
     'eslint-config-canonical',
   ],
 };

CONTRIBUTING.md

@@ -42,7 +42,7 @@ modify files within the `.README` directory. `.README/README.md` contains the
 main README skeleton and details on the project, its global `settings`, etc.,
 while the documentation for specific rules (that will be pulled into the
 README) ought to be modified within the relevant file within `.README/rules`.
-Once these files are modified, you can run `pnpm create-readme` to have
+Once these files are modified, you can run `pnpm create-docs` to have
 these files integrated into the main `/README.md`. While you should include
 the built file in your PR, you will not want to make manual changes
 directly to this file, as they will be overwritten.

docs/rules/valid-types.md

@@ -846,5 +846,9 @@ function quux() {
 
 }
 // Settings: {"jsdoc":{"mode":"typescript"}}
+
+/**
+ * @returns {Promise<{publicKey, privateKey}>} - The public and private key
+ */
 ````
 

package.json

@@ -24,20 +24,22 @@
     "@babel/plugin-transform-flow-strip-types": "^7.21.0",
     "@babel/preset-env": "^7.21.5",
     "@babel/register": "^7.21.0",
-    "@es-joy/jsdoc-eslint-parser": "^0.18.0",
+    "@es-joy/jsdoc-eslint-parser": "^0.19.0",
     "@hkdobrev/run-if-changed": "^0.3.1",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/github": "^8.0.7",
     "@semantic-release/npm": "^10.0.3",
-    "@typescript-eslint/parser": "^5.59.2",
+    "@types/eslint": "^8.37.0",
+    "@types/node": "^20.1.1",
+    "@typescript-eslint/parser": "^5.59.5",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-istanbul": "^6.1.1",
     "camelcase": "^6.3.0",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
     "decamelize": "^5.0.1",
-    "eslint-config-canonical": "~33.0.1",
     "eslint": "^8.39.0",
+    "eslint-config-canonical": "~33.0.1",
     "gitdown": "^3.1.5",
     "glob": "^10.2.2",
     "husky": "^8.0.3",
@@ -107,9 +109,10 @@
     "package-lock.json": "npm run install-offline"
   },
   "scripts": {
+    "tsc": "tsc",
     "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored",
-    "check-readme": "babel-node ./src/bin/generateDocs.js --check",
-    "create-readme": "babel-node ./src/bin/generateDocs.js",
+    "check-docs": "babel-node ./src/bin/generateDocs.js --check",
+    "create-docs": "babel-node ./src/bin/generateDocs.js",
     "create-rule": "babel-node ./src/bin/generateRule.js",
     "install-offline": "pnpm install --prefer-offline --no-audit",
     "lint": "npm run lint-arg -- .",