@diplodoc/transform 4.29.0 → 4.30.2

package/src/transform/utilsFS.ts

@@ -1,5 +1,6 @@
-import {readFileSync, statSync} from 'fs';
 import type {Dictionary} from 'lodash';
+
+import {readFileSync, statSync} from 'fs';
 import escapeRegExp from 'lodash/escapeRegExp';
 import {join, parse, relative, resolve, sep} from 'path';
 
@@ -35,6 +36,7 @@ export type GetFileTokensOpts = {
     disableCircularError?: boolean;
     inheritVars?: boolean;
     conditionsInCode?: boolean;
+    content?: string;
 };
 
 export function getFileTokens(path: string, state: StateCore, options: GetFileTokensOpts) {
@@ -49,15 +51,18 @@ export function getFileTokens(path: string, state: StateCore, options: GetFileTo
         inheritVars = true,
         conditionsInCode,
     } = options;
-    let content;
+    let {content} = options;
 
     const builtVars = (getVarsPerFile && !inheritVars ? getVarsPerFile(path) : vars) || {};
 
-    if (filesCache[path]) {
-        content = filesCache[path];
-    } else {
-        content = readFileSync(path, 'utf8');
-        filesCache[path] = content;
+    // Read the content only if we dont have one in the args
+    if (!content) {
+        if (filesCache[path]) {
+            content = filesCache[path];
+        } else {
+            content = readFileSync(path, 'utf8');
+            filesCache[path] = content;
+        }
     }
 
     let sourceMap;
@@ -148,3 +153,10 @@ export function getPublicPath(
     const href = transformer(filePath);
     return href;
 }
+
+export function getRelativePath(path: string, toPath: string) {
+    const pathDirs = path.split(sep);
+    pathDirs.pop();
+    const parentPath = pathDirs.join(sep);
+    return relative(parentPath, toPath);
+}

package/src/transform/yfmlint/index.ts

@@ -1,9 +1,14 @@
+import type {Dictionary} from 'lodash';
+
 import {Rule, sync} from 'markdownlint';
 import merge from 'lodash/merge';
 import union from 'lodash/union';
 import attrs from 'markdown-it-attrs';
-import baseDefaultLintConfig from './yfmlint';
 
+import {LogLevels, Logger} from '../log';
+import defaultPreprocessors from '../preprocessors';
+
+import baseDefaultLintConfig from './yfmlint';
 import {
     yfm001,
     yfm002,
@@ -14,11 +19,8 @@ import {
     yfm007,
     yfm008,
 } from './markdownlint-custom-rule';
-
 import {errorToString, getLogLevel} from './utils';
 import {Options} from './typings';
-import type {Dictionary} from 'lodash';
-import {LogLevels, Logger} from '../log';
 import {yfm009} from './markdownlint-custom-rule/yfm009';
 
 const defaultLintRules = [yfm001, yfm002, yfm003, yfm004, yfm005, yfm006, yfm007, yfm008, yfm009];
@@ -26,7 +28,14 @@ const defaultLintRules = [yfm001, yfm002, yfm003, yfm004, yfm005, yfm006, yfm007
 const lintCache = new Set();
 
 function yfmlint(opts: Options) {
-    const {input, plugins: customPlugins, pluginOptions, customLintRules, sourceMap} = opts;
+    let {input} = opts;
+    const {
+        plugins: customPlugins,
+        preprocessors = defaultPreprocessors,
+        pluginOptions,
+        customLintRules,
+        sourceMap,
+    } = opts;
     const {path = 'input', log} = pluginOptions;
 
     pluginOptions.isLintRun = true;
@@ -56,6 +65,10 @@ function yfmlint(opts: Options) {
     const plugins = customPlugins && [attrs, ...customPlugins];
     const preparedPlugins = plugins && plugins.map((plugin) => [plugin, pluginOptions]);
 
+    for (const preprocessor of preprocessors) {
+        input = preprocessor(input, pluginOptions);
+    }
+
     let result;
     try {
         result = sync({

package/src/transform/yfmlint/markdownlint-custom-rule/yfm001.ts

@@ -1,6 +1,5 @@
 // @ts-expect-error
 import {addErrorDetailIf, filterTokens, forEachInlineCodeSpan} from 'markdownlint-rule-helpers';
-
 import {MarkdownItToken, Rule} from 'markdownlint';
 
 export const yfm001: Rule = {

package/src/transform/yfmlint/typings.ts

@@ -1,10 +1,15 @@
 import type {Dictionary} from 'lodash';
+
 import {Plugin, Rule} from 'markdownlint';
+
+import {MarkdownItPreprocessorCb} from '../typings';
+
 import {LintConfig, PluginOptions} from '.';
 
 export interface Options {
     input: string;
     plugins?: Function[] | Plugin;
+    preprocessors?: MarkdownItPreprocessorCb[];
     pluginOptions: PluginOptions;
     defaultLintConfig?: LintConfig;
     lintConfig?: LintConfig;

package/src/transform/yfmlint/utils.ts

@@ -1,8 +1,10 @@
-import {LogLevels} from '../log';
-import {LintError} from 'markdownlint';
 import type {Dictionary} from 'lodash';
+
+import {LintError} from 'markdownlint';
 import {sep} from 'path';
 
+import {LogLevels} from '../log';
+
 export function errorToString(path: string, error: LintError, sourceMap?: Dictionary<string>) {
     const ruleMoniker = error.ruleNames
         ? error.ruleNames.join(sep)

package/src/transform/yfmlint/yfmlint.ts

@@ -1,6 +1,7 @@
-import {LintConfig} from '.';
 import {LogLevels} from '../log';
 
+import {LintConfig} from '.';
+
 const index: LintConfig = {
     // Default state for all rules
     default: true,