feat: adding jsdoc/type-formatting rule (#106)

Author: alexander-akait

configs/typescript.js

@@ -289,8 +289,13 @@ async function getTypescriptJSDocRecommendedConfig() {
 			// No need
 			// "jsdoc/text-escaping": "error",
 
-			// TODO enable after https://github.com/gajus/eslint-plugin-jsdoc/issues/1615
-			// "jsdoc/type-formatting": "error",
+			"jsdoc/type-formatting": [
+				"error",
+				{
+					objectTypeBracketSpacing: " ",
+					objectFieldSeparator: "comma-and-linebreak",
+				},
+			],
 
 			// Doesn't support function overloading/tuples/`readonly`/module keyword/etc
 			// Also `typescript` reports this itself

configs/utils/get-json-file.js

@@ -14,7 +14,7 @@ class Cache {
 	/**
 	 * Get the cached value of the given key.
 	 * @param {string} key The key to get.
-	 * @returns {import('type-fest').JsonObject} The cached value or null.
+	 * @returns {import("type-fest").JsonObject} The cached value or null.
 	 */
 	get(key) {
 		const entry = this.map.get(key);
@@ -33,7 +33,7 @@ class Cache {
 	/**
 	 * Set the value of the given key.
 	 * @param {string} key The key to set.
-	 * @param {import('type-fest').JsonObject} value The value to set.
+	 * @param {import("type-fest").JsonObject} value The value to set.
 	 * @returns {void}
 	 */
 	set(key, value) {
@@ -57,7 +57,7 @@ const cache = new Cache();
  * Don't cache the data.
  * @param {string} dir The path to a directory to read.
  * @param {string} filename The filename.
- * @returns {import('type-fest').JsonObject|null} The read `package.json` data, or null.
+ * @returns {import("type-fest").JsonObject | null} The read `package.json` data, or null.
  */
 function readJsonFile(dir, filename) {
 	const filePath = path.join(dir, filename);
@@ -86,7 +86,7 @@ function readJsonFile(dir, filename) {
  * The data is cached if found, then it's used after.
  * @param {string} filename The filename.
  * @param {string=} startPath A file path to lookup.
- * @returns {import('type-fest').JsonObject | null} A found `package.json` data or `null`.
+ * @returns {import("type-fest").JsonObject | null} A found `package.json` data or `null`.
  * This object have additional property `filePath`.
  */
 function getJsonFile(filename, startPath = "a.js") {