lint rule - term inside definition not allowed

Author: martyanovandrey

src/transform/plugins/term/constants.ts

@@ -0,0 +1 @@
+export const BASIC_TERM_REGEXP = '\\[([^\\[]+)\\](\\(\\*(\\w+)\\))';

src/transform/plugins/term/index.ts

@@ -4,6 +4,7 @@ import Token from 'markdown-it/lib/token';
 import {MarkdownItPluginCb} from '../typings';
 import {generateID} from '../utils';
 import {termDefinitions} from './termDefinitions';
+import {BASIC_TERM_REGEXP} from './constants';
 
 const term: MarkdownItPluginCb = (md) => {
     const escapeRE = md.utils.escapeRE;
@@ -68,7 +69,7 @@ const term: MarkdownItPluginCb = (md) => {
                 nodes = [];
 
                 // Find terms without definitions
-                const regexAllTerms = new RegExp('\\[([^\\[]+)\\](\\(\\*(\\w+)\\))', 'gm');
+                const regexAllTerms = new RegExp(BASIC_TERM_REGEXP, 'gm');
                 const uniqueTerms = [
                     ...new Set([...text.matchAll(regexAllTerms)].map((el) => `:${el[3]}`)),
                 ];

src/transform/plugins/term/termDefinitions.ts

@@ -1,5 +1,6 @@
 import StateBlock from 'markdown-it/lib/rules_block/state_block';
 import {MarkdownIt} from '../../typings';
+import {BASIC_TERM_REGEXP} from './constants';
 
 export function termDefinitions(md: MarkdownIt) {
     return (state: StateBlock, startLine: number, endLine: number, silent: boolean) => {
@@ -90,6 +91,16 @@ function processTermDefinition(
         state.env.terms = {};
     }
 
+    const basicTermDefinitionRegexp = new RegExp(BASIC_TERM_REGEXP, 'gm');
+    // If term inside definition
+    if (basicTermDefinitionRegexp.test(title)) {
+        token = new state.Token('__yfm_lint', '', 0);
+        token.hidden = true;
+        token.map = [currentLine, endLine];
+        token.attrSet('YFM008', 'true');
+        state.tokens.push(token);
+    }
+
     // If term definition duplicated
     if (state.env.terms[':' + label]) {
         token = new state.Token('__yfm_lint', '', 0);

src/transform/yfmlint/index.ts

@@ -4,14 +4,23 @@ import union from 'lodash/union';
 import attrs from 'markdown-it-attrs';
 import baseDefaultLintConfig from './yfmlint';
 
-import {yfm001, yfm002, yfm003, yfm004, yfm005, yfm006, yfm007} from './markdownlint-custom-rule';
+import {
+    yfm001,
+    yfm002,
+    yfm003,
+    yfm004,
+    yfm005,
+    yfm006,
+    yfm007,
+    yfm008,
+} from './markdownlint-custom-rule';
 
 import {errorToString, getLogLevel} from './utils';
 import {Options} from './typings';
 import {Dictionary} from 'lodash';
 import {Logger, LogLevels} from '../log';
 
-const defaultLintRules = [yfm001, yfm002, yfm003, yfm004, yfm005, yfm006, yfm007];
+const defaultLintRules = [yfm001, yfm002, yfm003, yfm004, yfm005, yfm006, yfm007, yfm008];
 
 const lintCache = new Set();
 

src/transform/yfmlint/markdownlint-custom-rule/index.ts

@@ -5,3 +5,4 @@ export {yfm004} from './yfm004';
 export {yfm005} from './yfm005';
 export {yfm006} from './yfm006';
 export {yfm007} from './yfm007';
+export {yfm008} from './yfm008';

src/transform/yfmlint/markdownlint-custom-rule/yfm008.ts

@@ -0,0 +1,26 @@
+import {Rule} from 'markdownlint';
+
+export const yfm008: Rule = {
+    names: ['YFM008', 'term-inside-definition-not-allowed'],
+    description: 'Term inside definition not allowed',
+    tags: ['term'],
+    function: function YFM008(params, onError) {
+        const {config} = params;
+        if (!config) {
+            return;
+        }
+        params.tokens
+            .filter((token) => {
+                return token.type === '__yfm_lint';
+            })
+            .forEach((term) => {
+                // @ts-expect-error bad markdownlint typings
+                if (term.attrGet('YFM008')) {
+                    onError({
+                        lineNumber: term.lineNumber,
+                        context: term.line,
+                    });
+                }
+            });
+    },
+};

src/transform/yfmlint/yfmlint.ts

@@ -60,6 +60,7 @@ const index: LintConfig = {
         YFM005: LogLevels.ERROR, // Tab list not closed
         YFM006: LogLevels.WARN, // Term definition duplicated
         YFM007: LogLevels.WARN, // Term used without definition
+        YFM008: LogLevels.WARN, // Term inside definition not allowed
     },
 
     // Inline code length