add more checks

Author: avivkeller

packages/remark-lint/README.md

@@ -106,6 +106,22 @@ Metadata can be provided in comments:
 <!-- llm_description= Utilities for working with file paths -->
 ```
 
+### `node-core:invalid-type-reference`
+
+Ensures that all `{type}` references are valid types and formatted correctly.
+
+**Allowed:**
+
+```markdown
+This is usually a {boolean}, but it could also be a {string|number}.
+```
+
+**Not allowed:**
+
+```markdown
+This is an {invalid} type, and so is {string | number}.
+```
+
 ### `node-core:yaml-comments`
 
 Enforces structure and content of YAML comment blocks:

packages/remark-lint/src/rules/__tests__/invalid-type-reference.test.mjs

@@ -14,10 +14,17 @@ const testCases = [
     input: 'Just a {number}.',
     expected: [],
   },
+  {
+    name: 'miswrapped reference',
+    input: 'First a {string}, then a \\<number>.',
+    expected: ['Type reference must be wrapped in "{}"; saw "<number>"'],
+  },
   {
     name: 'multiple references',
-    input: 'Psst, are you a {string} or a {boolean}',
-    expected: [],
+    input: 'Psst, are you a {string | boolean}',
+    expected: [
+      'Type reference should be seperated by "|", without spaces; saw "{string | boolean}"',
+    ],
   },
   {
     name: 'invalid references',

packages/remark-lint/src/rules/invalid-type-reference.mjs

@@ -3,15 +3,30 @@ import createQueries from '@nodejs/doc-kit/src/utils/queries/index.mjs';
 import { lintRule } from 'unified-lint-rule';
 import { visit } from 'unist-util-visit';
 
+const SPACED_SEPERATOR_RE = /\s\||\|\s/g;
+
 /**
- * Ensures that all self-references begin with `#`
+ * Ensures that all type references are valid
  * @type {import('unified-lint-rule').Rule}
  */
 const invalidTypeReference = (tree, vfile) => {
   visit(tree, createQueries.UNIST.isTextWithType, node => {
     const types = node.value.match(createQueries.QUERIES.normalizeTypes);
 
     types.forEach(type => {
+      if (type[0] !== '{' || type.at(-1) !== '}') {
+        vfile.message(
+          `Type reference must be wrapped in "{}"; saw "${type}"`,
+          node
+        );
+      }
+
+      if (SPACED_SEPERATOR_RE.test(type)) {
+        vfile.message(
+          `Type reference should be seperated by "|", without spaces; saw "${type}"`
+        );
+      }
+
       if (transformTypeToReferenceLink(type) === type) {
         vfile.message(`Invalid type reference: ${type}`, node);
       }