@diplodoc/transform 4.54.0 → 4.57.0

package/src/transform/plugins/code.ts

@@ -68,10 +68,43 @@ function termReplace(str: string, env: EnvTerm, escape: (str: string) => string)
     return termCode || str;
 }
 
+function addLineNumbers(code: string): string {
+    const lines = code.split('\n');
+    const lineCount = lines.length;
+    const maxDigits = String(lineCount).length;
+
+    // Remove trailing empty line if it exists
+    const hasTrailingNewline = code.endsWith('\n');
+    const linesToProcess = hasTrailingNewline ? lines.slice(0, -1) : lines;
+
+    return (
+        linesToProcess
+            .map((line, index) => {
+                const lineNumber = String(index + 1).padStart(maxDigits, ' ');
+                return `<span class="yfm-line-number">${lineNumber}</span>${line}`;
+            })
+            .join('\n') + (hasTrailingNewline ? '\n' : '')
+    );
+}
+
 const code: MarkdownItPluginCb = (md) => {
     const superCodeRenderer = md.renderer.rules.fence;
     md.renderer.rules.fence = function (tokens, idx, options, env, self) {
-        const superCode = superCodeRenderer?.(tokens, idx, options, env, self);
+        const token = tokens[idx];
+        const showLineNumbers = token.info.includes('showLineNumbers');
+
+        let superCode = superCodeRenderer?.(tokens, idx, options, env, self);
+
+        if (superCode && showLineNumbers) {
+            // Extract the code content from the pre/code tags
+            const codeMatch = superCode.match(/<pre[^>]*><code[^>]*>([\s\S]*?)<\/code><\/pre>/);
+            if (codeMatch) {
+                const codeContent = codeMatch[1];
+                const codeWithLineNumbers = addLineNumbers(codeContent);
+                superCode = superCode.replace(codeContent, codeWithLineNumbers);
+            }
+        }
+
         const superCodeWithTerms =
             superCode && env?.terms ? termReplace(superCode, env, md.utils.escapeRE) : superCode;
 

package/src/transform/plugins/notes/constants.ts

@@ -1,4 +1,6 @@
-export const TITLES: Record<string, Record<string, string>> = {
+import {Lang} from '../typings';
+
+export const TITLES: Record<Lang, Record<string, string>> = {
     ru: {
         info: 'Примечание',
         tip: 'Совет',

package/src/transform/plugins/notes/index.ts

@@ -10,15 +10,6 @@ import {TITLES} from './constants';
 const ALERT_RE = /^{% note (alert|info|tip|warning)\s*(?:"(.*?)")? %}$/;
 const WRONG_NOTES = /^{% note (.*)%}/;
 
-function getTitle(type: string, originLang: keyof typeof TITLES) {
-    let lang = originLang;
-
-    if (!lang || !Object.keys(TITLES).includes(lang)) {
-        lang = 'ru';
-    }
-
-    return TITLES[lang][type];
-}
 const matchCloseToken: MatchTokenFunction = (tokens, i) => {
     return (
         tokens[i].type === 'paragraph_open' &&
@@ -90,7 +81,7 @@ const index: MarkdownItPluginCb = (md, {lang, notesAutotitle, path: optPath, log
                 titleOpen.block = true;
                 titleClose.block = true;
 
-                const autotitle = notesAutotitle ? getTitle(type, lang) : '';
+                const autotitle = notesAutotitle ? TITLES[lang][type] : '';
 
                 titleInline.content = match[2] === undefined ? autotitle : match[2];
                 titleInline.children = [];

package/src/transform/sanitize.ts

@@ -1,4 +1,4 @@
-import sanitizeHtml from 'sanitize-html';
+import sanitizeHtml, {Attributes, Tag} from 'sanitize-html';
 // @ts-ignore
 import cssfilter from 'cssfilter';
 import * as cheerio from 'cheerio';
@@ -176,6 +176,7 @@ const svgTags = [
     'view',
     'vkern',
     'animate',
+    'use',
 ];
 
 const htmlAttrs = [
@@ -501,6 +502,34 @@ const allowedTags = Array.from(
 );
 const allowedAttributes = Array.from(new Set([...htmlAttrs, ...svgAttrs, ...yfmHtmlAttrs]));
 
+// For hrefs within "use" only allow local links to ids that start with "#"
+const useTagTransformer = (tagName: string, attribs: Attributes): Tag => {
+    const cleanHref = (href: string) => {
+        if (href.startsWith('#')) {
+            return href;
+        } else {
+            return null;
+        }
+    };
+    const cleanAttrs = (attrs: Attributes): Attributes => {
+        const HREF_ATTRIBUTES = ['xlink:href', 'href'];
+        return Object.fromEntries(
+            Object.entries(attrs)
+                .map(([key, value]) => {
+                    if (HREF_ATTRIBUTES.includes(key)) {
+                        return [key, cleanHref(value)];
+                    }
+                    return [key, value];
+                })
+                .filter(([_, value]) => value !== null),
+        );
+    };
+    return {
+        tagName,
+        attribs: cleanAttrs(attribs),
+    };
+};
+
 export interface SanitizeOptions extends sanitizeHtml.IOptions {
     cssWhiteList?: CssWhiteList;
     disableStyleSanitizer?: boolean;
@@ -526,6 +555,9 @@ export const defaultOptions: SanitizeOptions = {
     allowVulnerableTags: true,
     parser: defaultParseOptions,
     cssWhiteList: defaultCssWhitelist,
+    transformTags: {
+        use: useTagTransformer,
+    },
 };
 
 function sanitizeStyleTags(dom: cheerio.CheerioAPI, cssWhiteList: CssWhiteList) {

package/src/transform/typings.ts

@@ -29,6 +29,24 @@ export type Heading = {
     items?: Heading[];
 };
 
+export type Lang =
+    | 'ru'
+    | 'en'
+    | 'ar'
+    | 'cs'
+    | 'fr'
+    | 'es'
+    | 'he'
+    | 'bg'
+    | 'et'
+    | 'el'
+    | 'pt'
+    | 'zh'
+    | 'zh-tw'
+    | 'kk'
+    | 'tr'
+    | 'uz';
+
 export interface OptionsType {
     tokens?: boolean;
     vars?: Record<string, string>;
@@ -67,6 +85,10 @@ export interface OptionsType {
      * Set value to `false` to disable it
      */
     enableMarkdownAttrs?: boolean;
+    supportGithubAnchors?: boolean;
+    disableCommonAnchors?: boolean;
+    useCommonAnchorButtons?: boolean;
+    lang?: Lang;
     [x: string]: unknown;
 }
 
@@ -89,7 +111,7 @@ export type EnvType<Extras extends {} = {}> = {
 export interface MarkdownItPluginOpts {
     path: string;
     log: Logger;
-    lang: 'ru' | 'en' | 'es' | 'fr' | 'cs' | 'ar' | 'he';
+    lang: Lang;
     root: string;
     rootPublicPath: string;
     isLintRun: boolean;