@peaceroad/markdown-it-renderer-fence 0.7.0 → 0.9.0

package/src/custom-highlight/payload-utils.js

@@ -1,3 +1,7 @@
+import {
+  escapeHtmlAttr,
+} from '../utils/attr-utils.js'
+
 const escapeJsonForScript = (data) => {
   return JSON.stringify(data)
     .replace(/</g, '\\u003C')
@@ -7,15 +11,6 @@ const escapeJsonForScript = (data) => {
     .replace(/\u2029/g, '\\u2029')
 }
 
-const escapeHtmlAttr = (value) => {
-  return String(value)
-    .replace(/&/g, '&amp;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&#39;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-}
-
 const getCustomHighlightPayloadMap = (env, envKey = 'rendererFenceCustomHighlights') => {
   if (!env || typeof env !== 'object') return {}
   const map = env[envKey]

package/src/custom-highlight/{shiki-keyword-rules.js → shiki-role-rules.js}

@@ -4,12 +4,85 @@ const shikiFunctionLikeIdentifierReg = /^[A-Za-z_$][\w$]*[!?]?$/
 const shikiShellOptionTokenReg = /^-[A-Za-z0-9][A-Za-z0-9-]*$/
 const shikiShellTestOperatorSet = new Set(['-n', '-z', '-gt', '-lt', '-ge', '-le', '-eq', '-ne'])
 
-const keywordV4GlobalRules = [
+const roleV4GlobalRules = [
   {
-    id: 'css-color-name-to-number',
+    id: 'string-delimiter-punctuation',
+    priority: 2300,
+    scopeIncludesAny: ['punctuation.definition.string'],
+    tokenRegex: /^(?:\$?['"`]+|[<>])$/,
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'string-interpolation-punctuation',
+    priority: 2295,
+    baseIn: ['string', 'string-unquoted'],
+    scopeIncludesAny: [
+      'punctuation.definition.interpolation',
+      'punctuation.section.embedded',
+      'punctuation.accessor',
+    ],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'variable-prefix-punctuation',
+    priority: 2292,
+    scopeIncludesAny: ['punctuation.definition.variable'],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'generic-definition-punctuation',
+    priority: 2291,
+    scopeIncludesAny: ['punctuation.definition.'],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'generic-section-punctuation',
+    priority: 2290,
+    scopeIncludesAny: ['punctuation.section.'],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'object-literal-key-variable',
+    priority: 2289,
+    scopeIncludesAny: ['meta.object-literal.key'],
+    tokenKind: 'identifier',
+    setBucket: 'variable',
+  },
+  {
+    id: 'symbolic-operator-punctuation',
+    priority: 2280,
+    scopeIncludesAny: [
+      'keyword.operator.accessor',
+      'keyword.operator.arithmetic',
+      'keyword.operator.assignment',
+      'keyword.operator.bitwise',
+      'keyword.operator.comparison',
+      'keyword.operator.expression',
+      'keyword.operator.logical',
+      'keyword.operator.nullish',
+      'keyword.operator.optional',
+      'keyword.operator.spread',
+      'keyword.operator.ternary',
+    ],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'json-property-name-delimiter-punctuation',
+    priority: 2270,
+    scopeIncludesAny: ['punctuation.support.type.property-name'],
+    tokenKind: 'punctuation',
+    setBucket: 'punctuation',
+  },
+  {
+    id: 'css-color-name-to-literal',
     priority: 2100,
     scopeIncludesAny: ['support.constant.color.w3c-standard-color-name.css'],
-    setBucket: 'number',
+    setBucket: 'literal',
   },
   {
     id: 'rust-lifetime-to-type-name',
@@ -19,30 +92,45 @@ const keywordV4GlobalRules = [
     setBucket: 'type-name',
   },
   {
-    id: 'regex-alternative-operator-keyword',
+    id: 'regex-alternative-operator-punctuation',
     priority: 2040,
     scopeIncludesAny: ['keyword.operator.or.regexp'],
     tokenEquals: ['|'],
-    setBucket: 'keyword',
+    setBucket: 'punctuation',
   },
 ]
 
-const keywordV4LangRules = {
+const roleV4LangRules = {
   sql: [
     {
-      id: 'sql-window-function-blue',
+      id: 'sql-plain-source-punctuation-text',
+      priority: 2010,
+      scopeIncludesAny: ['source.sql'],
+      scopeExcludesAny: ['keyword.operator', 'punctuation.definition.string'],
+      tokenKind: 'punctuation',
+      setBucket: 'text',
+    },
+    {
+      id: 'sql-window-function-title',
       priority: 2000,
       scopeIncludesAny: ['support.function.ranking.sql'],
-      setBucket: 'type',
+      setBucket: 'title-function',
     },
     {
-      id: 'sql-table-database-name-blue',
+      id: 'sql-table-database-name-text',
       priority: 1980,
       scopeIncludesAny: ['constant.other.table-name.sql', 'constant.other.database-name.sql'],
-      setBucket: 'type',
+      setBucket: 'text',
     },
   ],
   java: [
+    {
+      id: 'java-storage-modifier-keyword',
+      priority: 2000,
+      scopeIncludesAny: ['storage.modifier.java', 'storage.modifier.import.java'],
+      tokenKind: 'identifier',
+      setBucket: 'keyword',
+    },
     {
       id: 'java-record-signature-neutral',
       priority: 1995,
@@ -51,16 +139,16 @@ const keywordV4LangRules = {
       setBucket: 'text',
     },
     {
-      id: 'java-package-separator-neutral',
+      id: 'java-package-separator-punctuation',
       priority: 1980,
       scopeIncludesAny: ['punctuation.separator.java'],
-      setBucket: 'text',
+      setBucket: 'punctuation',
     },
     {
-      id: 'java-generic-bracket-neutral',
+      id: 'java-generic-bracket-punctuation',
       priority: 1970,
       scopeIncludesAny: ['punctuation.bracket.angle.java'],
-      setBucket: 'text',
+      setBucket: 'punctuation',
     },
     {
       id: 'java-record-keyword',
@@ -93,16 +181,22 @@ const keywordV4LangRules = {
       setBucket: 'title-function-builtin',
     },
     {
-      id: 'php-core-const-blue',
+      id: 'php-file-and-declare-meta-text',
+      priority: 1990,
+      scopeIncludesAny: ['constant.other.php'],
+      setBucket: 'text',
+    },
+    {
+      id: 'php-core-const-literal',
       priority: 1980,
-      scopeIncludesAny: ['support.constant.core.php', 'constant.other.php'],
-      setBucket: 'variable-const',
+      scopeIncludesAny: ['support.constant.core.php'],
+      setBucket: 'literal',
     },
     {
-      id: 'php-enum-const-blue',
+      id: 'php-enum-const-text',
       priority: 1970,
       scopeIncludesAny: ['constant.enum.php', 'constant.other.class.php'],
-      setBucket: 'variable-const',
+      setBucket: 'text',
     },
   ],
   ruby: [
@@ -112,6 +206,20 @@ const keywordV4LangRules = {
       scopeIncludesAny: ['entity.name.function.ruby'],
       setBucket: 'title-function',
     },
+    {
+      id: 'ruby-instance-variable-token',
+      priority: 1990,
+      scopeIncludesAny: ['variable.other.readwrite.instance.ruby', 'variable.other.block.ruby'],
+      tokenKind: 'identifier',
+      setBucket: 'variable',
+    },
+    {
+      id: 'ruby-variable-separator-punctuation',
+      priority: 1985,
+      scopeIncludesAny: ['punctuation.separator.variable.ruby'],
+      tokenKind: 'punctuation',
+      setBucket: 'punctuation',
+    },
     {
       id: 'ruby-variable-accent',
       priority: 1980,
@@ -152,12 +260,35 @@ const keywordV4LangRules = {
     },
   ],
   csharp: [
+    {
+      id: 'csharp-new-expression-punctuation',
+      priority: 1970,
+      scopeIncludesAny: ['keyword.operator.expression.new.cs', 'punctuation.parenthesis.open.cs'],
+      tokenRegex: /^new\(?$/,
+      setBucket: 'punctuation',
+    },
     {
       id: 'csharp-keyword-type-keyword',
       priority: 1960,
       scopeIncludesAny: ['keyword.type.string.cs'],
       setBucket: 'keyword',
     },
+    {
+      id: 'csharp-record-parameter-name-text',
+      priority: 1955,
+      scopeIncludesAny: ['entity.name.variable.parameter.cs'],
+      tokenKind: 'identifier',
+      setBucket: 'text',
+    },
+    {
+      id: 'csharp-plain-source-identifier-text',
+      priority: 1950,
+      baseIn: ['type-name', 'type', 'variable-plain'],
+      scopeIncludesAny: ['source.cs'],
+      scopeExcludesAny: ['entity.name.', 'support.', 'storage.', 'keyword.', 'variable.'],
+      tokenKind: 'identifier',
+      setBucket: 'text',
+    },
   ],
   c: [
     {
@@ -177,10 +308,42 @@ const keywordV4LangRules = {
       id: 'c-placeholder-blue',
       priority: 1950,
       scopeIncludesAny: ['constant.other.placeholder.c'],
-      setBucket: 'literal',
+      setBucket: 'string',
+    },
+    {
+      id: 'c-plain-source-identifier-text',
+      priority: 1940,
+      baseIn: ['variable-plain'],
+      scopeIncludesAny: ['source.c'],
+      scopeExcludesAny: ['variable.', 'entity.name.', 'support.', 'storage.', 'keyword.', 'constant.'],
+      tokenKind: 'identifier',
+      setBucket: 'text',
     },
   ],
   cpp: [
+    {
+      id: 'cpp-plain-function-body-fragment-text',
+      priority: 1985,
+      scopeIncludesAny: ['meta.body.function.definition.cpp'],
+      scopeExcludesAny: ['entity.name.', 'support.', 'storage.', 'keyword.', 'variable.', 'constant.', 'string.'],
+      tokenRegex: /[A-Za-z_]/,
+      setBucket: 'text',
+    },
+    {
+      id: 'cpp-plain-function-body-identifier-text',
+      priority: 1980,
+      scopeIncludesAny: ['meta.body.function.definition.cpp'],
+      scopeExcludesAny: ['entity.name.', 'support.', 'storage.', 'keyword.', 'variable.', 'constant.', 'string.'],
+      tokenKind: 'identifier',
+      setBucket: 'text',
+    },
+    {
+      id: 'cpp-scope-resolution-name-text',
+      priority: 1970,
+      scopeIncludesAny: ['entity.name.scope-resolution.cpp', 'entity.name.scope-resolution.parameter.cpp'],
+      tokenKind: 'identifier',
+      setBucket: 'text',
+    },
     {
       id: 'cpp-reference-modifier-keyword',
       priority: 1960,
@@ -189,6 +352,20 @@ const keywordV4LangRules = {
     },
   ],
   python: [
+    {
+      id: 'python-fstring-period-punctuation',
+      priority: 1920,
+      scopeIncludesAny: ['meta.fstring.python', 'punctuation.separator.period.python'],
+      tokenEquals: ['.'],
+      setBucket: 'punctuation',
+    },
+    {
+      id: 'python-meta-attribute',
+      priority: 1910,
+      scopeIncludesAny: ['meta.attribute.python'],
+      tokenKind: 'identifier',
+      setBucket: 'attribute',
+    },
     {
       id: 'python-fstring-conversion-neutral',
       priority: 1900,
@@ -208,24 +385,30 @@ const keywordV4LangRules = {
   ],
   css: [
     {
-      id: 'css-function-type-blue',
+      id: 'css-function-title',
       priority: 1940,
       scopeIncludesAny: ['support.function.calc.css', 'support.function.gradient.css'],
-      setBucket: 'type',
+      setBucket: 'title-function',
+    },
+    {
+      id: 'css-property-value-literal',
+      priority: 1930,
+      scopeIncludesAny: ['support.constant.property-value.css'],
+      setBucket: 'literal',
     },
   ],
 }
 
-const keywordV4SortedGlobalRules = keywordV4GlobalRules.slice().sort((a, b) => (b.priority || 0) - (a.priority || 0))
-const keywordV4SortedLangRules = new Map(
-  Object.keys(keywordV4LangRules).map((lang) => [
+const roleV4SortedGlobalRules = roleV4GlobalRules.slice().sort((a, b) => (b.priority || 0) - (a.priority || 0))
+const roleV4SortedLangRules = new Map(
+  Object.keys(roleV4LangRules).map((lang) => [
     lang,
-    keywordV4LangRules[lang].slice().sort((a, b) => (b.priority || 0) - (a.priority || 0)),
+    roleV4LangRules[lang].slice().sort((a, b) => (b.priority || 0) - (a.priority || 0)),
   ]),
 )
 
-const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
-  const postHelper = helper && typeof helper === 'object' ? helper : {}
+const applyShikiRoleLegacyPostRules = (currentBucket, ctx, helper) => {
+  const postHelper = helper && typeof helper === 'object' ? helper : (ctx || {})
   const hasAnyScopePattern = typeof postHelper.hasAnyScopePattern === 'function'
     ? postHelper.hasAnyScopePattern
     : () => false
@@ -234,7 +417,7 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
     : (pattern) => hasAnyScopePattern([pattern])
   const classifyToken = typeof postHelper.classifyToken === 'function'
     ? postHelper.classifyToken
-    : () => null
+    : null
 
   const bucket = String(currentBucket || 'text')
   const langKey = String(ctx && ctx.langKey || '')
@@ -242,10 +425,16 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
   const tokenContent = String(ctx && ctx.tokenContent || '')
   const trimmed = String(ctx && ctx.tokenTrim || '')
   const tokenLower = (ctx && typeof ctx.tokenLower === 'string') ? ctx.tokenLower : trimmed.toLowerCase()
+  const isIdentifier = (ctx && typeof ctx.isIdentifier === 'boolean')
+    ? ctx.isIdentifier
+    : shikiSimpleIdentifierReg.test(trimmed)
+  const isPunctuation = (ctx && typeof ctx.isPunctuation === 'boolean')
+    ? ctx.isPunctuation
+    : shikiPunctuationTokenReg.test(trimmed)
   if (!trimmed) return 'text'
 
   if ((langKey === 'bash' || langKey === 'shellscript') && shikiShellOptionTokenReg.test(trimmed)) {
-    return shikiShellTestOperatorSet.has(tokenLower) ? 'keyword' : 'literal'
+    return shikiShellTestOperatorSet.has(tokenLower) ? 'punctuation' : 'string'
   }
   if ((langKey === 'hcl' || langKey === 'terraform') && trimmed === '=') return 'keyword'
   if (bucket === 'comment' && trimmed.startsWith('#!')) return 'meta-shebang'
@@ -262,15 +451,16 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
         trimmed.startsWith('${') ||
         trimmed === '}'
       )
-    ) return 'literal'
+    ) return hasAnyScopePattern(['variable.parameter.positional.shell', 'variable.language.special.shell'])
+      ? 'variable-plain'
+      : 'string'
     if (
       (langKey === 'bash' || langKey === 'shellscript') &&
       hasAnyScopePattern(['constant.other.option'])
-    ) return shikiShellTestOperatorSet.has(tokenLower) ? 'keyword' : 'literal'
+    ) return shikiShellTestOperatorSet.has(tokenLower) ? 'punctuation' : 'string'
     if (langKey === 'python' && hasAnyScopePattern(['storage.type.string.python'])) return 'keyword'
-    if (langKey === 'go' && hasAnyScopePattern(['entity.name.import.go'])) return 'type-name'
     if (hasAnyScopePattern(['keyword.operator.string'])) return 'keyword'
-    if (hasAnyScopePattern(['constant.character.escape', 'constant.character.format.placeholder'])) return 'number'
+    if (hasAnyScopePattern(['constant.character.escape', 'constant.character.format.placeholder'])) return 'literal'
     if (hasAnyScopePattern(['variable.other.', 'variable.ruby', 'meta.attribute.python'])) return 'variable-plain'
   }
   if (bucket === 'string-unquoted') {
@@ -286,23 +476,24 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
         trimmed.startsWith('${') ||
         trimmed === '}'
       )
-    ) return 'literal'
+    ) return hasAnyScopePattern(['variable.parameter.positional.shell', 'variable.language.special.shell'])
+      ? 'variable-plain'
+      : 'string'
     if (
       (langKey === 'bash' || langKey === 'shellscript') &&
       hasAnyScopePattern(['constant.other.option'])
-    ) return shikiShellTestOperatorSet.has(tokenLower) ? 'keyword' : 'literal'
+    ) return shikiShellTestOperatorSet.has(tokenLower) ? 'punctuation' : 'string'
     if (hasAnyScopePattern(['entity.name.tag.yaml'])) return 'tag'
     return 'string'
   }
   if (bucket === 'title-function') {
-    if (langKey === 'css' && hasAnyScopePattern(['support.function.misc.css'])) return 'type'
     if (hasAnyScopePattern(['support.function.builtin', 'support.function.kernel', 'support.function.construct'])) return 'title-function-builtin'
     if (hasAnyScopePattern(['storage.type.function.arrow', 'keyword.operator'])) return 'keyword'
     if (hasAnyScopePattern(['punctuation.section.function', 'punctuation.definition.arguments', 'meta.function-call.arguments'])) return 'punctuation'
     if (hasAnyScopePattern(['meta.function']) && !hasAnyScopePattern(['entity.name.function', 'support.function'])) return 'meta'
     if (hasAnyScopePattern(['punctuation.accessor'])) return 'text'
     if (!shikiFunctionLikeIdentifierReg.test(trimmed)) {
-      if (shikiPunctuationTokenReg.test(trimmed)) return 'punctuation'
+      if (isPunctuation) return 'punctuation'
       if (/[.\[\](){}:]/.test(trimmed)) return 'text'
     }
   }
@@ -320,7 +511,7 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
   if (bucket === 'variable') {
     if (
       hasAnyScopePattern(['meta.type.annotation']) &&
-      shikiPunctuationTokenReg.test(trimmed)
+      isPunctuation
     ) return 'punctuation'
     if (hasAnyScopePattern(['variable.language.this'])) return 'variable-this'
     if (hasAnyScopePattern(['variable.other.constant', 'constant.other.php', 'variable.other.enummember'])) return 'variable-const'
@@ -330,9 +521,9 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
   }
   if (bucket === 'variable-plain') {
     if (hasAnyScopePattern(['variable.other.constant', 'constant.other.php', 'variable.other.enummember'])) return 'variable-const'
-    if (hasAnyScopePattern(['entity.name.variable.local.cs'])) return 'type-name'
+    if (langKey === 'csharp' && hasAnyScopePattern(['entity.name.variable.local.cs'])) return 'text'
     if (hasAnyScopePattern(['source.sql', 'source.python', 'source.ruby'])) return 'text'
-    if (!shikiSimpleIdentifierReg.test(trimmed) && hasAnyScopePattern(['punctuation.'])) return 'punctuation'
+    if (!isIdentifier && hasAnyScopePattern(['punctuation.'])) return 'punctuation'
   }
   if (bucket === 'variable-member') {
     if (hasAnyScopePattern(['variable.object.property.ts', 'variable-object-property-ts', 'variable.object.property.js', 'variable-object-property-js'])) return 'variable-property'
@@ -345,7 +536,7 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
     if (hasAnyScopePattern(['variable.other.readwrite.hcl', 'variable.other.normal.shell', 'meta.block.hcl'])) return 'variable-plain'
     if (hasAnyScopePattern(['storage.type.built-in.primitive', 'keyword.operator.type.annotation', 'keyword.operator.type'])) return 'keyword'
     if (hasAnyScopePattern(['entity.name.type', 'support.type'])) return 'type-name'
-    if (!shikiSimpleIdentifierReg.test(trimmed)) return 'punctuation'
+    if (!isIdentifier) return 'punctuation'
   }
   if (bucket === 'variable-property') {
     if (hasAnyScopePattern(['variable.object.property', 'variable.other.property'])) return 'variable-parameter'
@@ -354,18 +545,23 @@ const applyShikiKeywordLegacyPostRules = (currentBucket, ctx, helper) => {
   if (bucket === 'keyword' && hasAnyScopePattern(['variable.language.this'])) return 'variable-this'
   if (bucket === 'literal' && langKey === 'sql') return 'text'
   if (bucket === 'text') {
-    const tokenBucket = classifyToken(tokenContent, langKey)
+    const tokenBucket = classifyToken
+      ? classifyToken(tokenContent, langKey)
+      : ((ctx && ctx.tokenBucket) || null)
     if (tokenBucket) return tokenBucket
-    if (shikiSimpleIdentifierReg.test(trimmed)) return 'variable-plain'
+    if (hasAnyScopePattern(['source.sql', 'source.python', 'source.ruby', 'text.html.basic'])) return 'text'
+    if (isIdentifier) return 'variable-plain'
   }
-  if (!shikiSimpleIdentifierReg.test(trimmed) && (bucket === 'text' || bucket === 'meta')) {
-    const tokenBucket = classifyToken(tokenContent, langKey)
+  if (!isIdentifier && (bucket === 'text' || bucket === 'meta')) {
+    const tokenBucket = classifyToken
+      ? classifyToken(tokenContent, langKey)
+      : ((ctx && ctx.tokenBucket) || null)
     if (tokenBucket) return tokenBucket
   }
   return bucket
 }
 
-const matchKeywordV4Rule = (rule, currentBucket, ctx) => {
+const matchRoleV4Rule = (rule, currentBucket, ctx) => {
   const hasAnyScopePattern = (ctx && typeof ctx.hasAnyScopePattern === 'function')
     ? ctx.hasAnyScopePattern
     : (() => false)
@@ -386,22 +582,21 @@ const applyRuleSet = (currentBucket, rules, ctx) => {
   let next = currentBucket
   for (let i = 0; i < rules.length; i++) {
     const rule = rules[i]
-    if (!matchKeywordV4Rule(rule, next, ctx)) continue
+    if (!matchRoleV4Rule(rule, next, ctx)) continue
     next = rule.setBucket || next
     if (rule.stop !== false) break
   }
   return next
 }
 
-const applyKeywordV4Rules = (currentBucket, ctx) => {
-  let next = applyRuleSet(currentBucket, keywordV4SortedGlobalRules, ctx)
-  const langRules = keywordV4SortedLangRules.get(ctx.langKey)
+const applyRoleV4Rules = (currentBucket, ctx) => {
+  let next = applyRuleSet(currentBucket, roleV4SortedGlobalRules, ctx)
+  const langRules = roleV4SortedLangRules.get(ctx.langKey)
   next = applyRuleSet(next, langRules, ctx)
   return next
 }
 
 export {
-  applyKeywordV4Rules,
-  applyShikiKeywordLegacyPostRules,
+  applyRoleV4Rules,
+  applyShikiRoleLegacyPostRules,
 }
-