sugar-high 1.0.0 → 1.2.0

package/README.md

@@ -4,7 +4,7 @@
 
 Super lightweight syntax highlighter for JavaScript and JSX—about **1 kB** minified and gzipped. Works in the browser or any JS runtime that can set HTML strings.
 
-![Sugar High preview](https://repository-images.githubusercontent.com/453236442/e9c853e9-4af6-45c4-aa4a-c27afbf16a0d)
+![Sugar High preview](https://repository-images.githubusercontent.com/453236442/9aa2144a-3a4c-4a93-a87f-92ca6a37ded6)
 
 ## Install
 
@@ -33,6 +33,8 @@ import { rust } from 'sugar-high/presets'
 const html = highlight(source, { ...rust })
 ```
 
+Available presets: `c`, `css`, `diff`, `go`, `java`, `python`, and `rust`.
+
 For more language presets and syntax color themes, see **[sugar-high.vercel.app](https://sugar-high.vercel.app/)**.
 
 ## Styling

package/lib/index.d.ts

@@ -1,5 +1,9 @@
 type HighlightOptions = {
   keywords?: Set<string>
+  /**
+   * Highlighted as the `class` token type (e.g. built-in types). Checked before `keywords`.
+   */
+  typeKeywords?: Set<string>
   onCommentStart?: (curr: string, next: string) => number | boolean
   onCommentEnd?: (curr: string, prev: string) => number | boolean
   /**
@@ -7,11 +11,12 @@ type HighlightOptions = {
    * or null/undefined or a number below 1 for default JS single-quoted string rules.
    */
   onQuote?: (curr: string, i: number, code: string) => number | null | undefined
+  lineClassName?: (line: string, index: number) => string | null | undefined
 }
 
 export function highlight(code: string, options?: HighlightOptions): string
 export function tokenize(code: string, options?: HighlightOptions): Array<[number, string]>
-export function generate(tokens: Array<[number, string]>): Array<any>
+export function generate(tokens: Array<[number, string]>, options?: Pick<HighlightOptions, 'lineClassName'>): Array<any>
 export const SugarHigh: {
   TokenTypes: {
     [key: number]: string

package/lib/index.js

@@ -69,6 +69,13 @@ const Keywords_Ts = new Set([
   'unknown',
   'never',
   'any',
+  // Built-in type names (annotations / type positions)
+  'number',
+  'string',
+  'boolean',
+  'bigint',
+  'symbol',
+  'object',
 ])
 
 const Signs = new Set([
@@ -298,9 +305,11 @@ function isRegexStart(str) {
  * @param {string} code
  * @param {{
  *   keywords?: Set<string>
+ *   typeKeywords?: Set<string>
  *   onCommentStart?: (curr: string, next: string) => number | boolean
  *   onCommentEnd?: (prev: string, curr: string) => number | boolean
  *   onQuote?: (curr: string, i: number, code: string) => number | null | undefined
+ *   lineClassName?: (line: string, index: number) => string | null | undefined
  * } | undefined} options
  * Optional `onQuote(curr, i, code)` at `code[i] === "'"`: return length to consume from `i` (>= 1),
  * or null/undefined/below 1 for default JS single-quoted strings. No substring allocation.
@@ -319,6 +328,9 @@ function tokenize(code, options) {
     onCommentEnd,
   } = mergedOptions
 
+  const resolvedTypeKeywords =
+    mergedOptions.typeKeywords instanceof Set ? mergedOptions.typeKeywords : null
+
   let current = ''
   let type = -1
   /** @type {[number, string]} */
@@ -388,6 +400,8 @@ function tokenize(code, options) {
     // Determine strings first before other types
     if (inStringQuotes() || inStrTemplateLiterals()) {
       return T_STRING
+    } else if (resolvedTypeKeywords && resolvedTypeKeywords.has(token)) {
+      return last[1] === '.' ? T_IDENTIFIER : T_CLS_NUMBER
     } else if (resolvedKeywords.has(token)) {
       return last[1] === '.' ? T_IDENTIFIER : T_KEYWORD
     } else if (isLineBreak) {
@@ -800,29 +814,42 @@ function tokenize(code, options) {
 
 /**
  * @param {Array<[number, string]>} tokens
+ * @param {{
+ *   lineClassName?: (line: string, index: number) => string | null | undefined
+ * } | undefined} options
  * @return {Array<{type: string, tagName: string, children: any[], properties: Record<string, string>}>}
  */
-function generate(tokens) {
+function generate(tokens, options) {
   const lines = []
+  const lineClassName = options && typeof options.lineClassName === 'function'
+    ? options.lineClassName
+    : null
+  let lineIndex = 0
   /**
    * @param {any} children
+   * @param {string} text
    * @return {{type: string, tagName: string, children: any[], properties: Record<string, string>}}
    */
-  const createLine = (children) =>
-      ({
+  const createLine = (children, text) => {
+    const extraClassName = lineClassName ? lineClassName(text, lineIndex) : ''
+    lineIndex++
+
+    return ({
         type: 'element',
         tagName: 'span',
         children,
         properties: {
-          className: 'sh__line',
+          className: extraClassName ? `sh__line ${extraClassName}` : 'sh__line',
         },
       })
+  }
 
   /**
    * @param {Array<[number, string]>} tokens
    * @returns {void}
    */
   function flushLine(tokens) {
+    const lineText = tokens.map(([, value]) => value).join('')
     /** @type {Array<any>} */
     const lineTokens = (
       tokens
@@ -842,7 +869,7 @@ function generate(tokens) {
           }
         })
     )
-    lines.push(createLine(lineTokens))
+    lines.push(createLine(lineTokens, lineText))
   }
   /** @type {Array<[number, string]>} */
   const lineTokens = []
@@ -928,16 +955,18 @@ function toHtml(lines) {
  * @param {string} code
  * @param {{
  *   keywords?: Set<string>
+ *   typeKeywords?: Set<string>
  *   onCommentStart?: (curr: string, next: string) => number | boolean
  *   onCommentEnd?: (curr: string, prev: string) => number | boolean
  *   onQuote?: (curr: string, i: number, code: string) => number | null | undefined
+ *   lineClassName?: (line: string, index: number) => string | null | undefined
  * } | undefined} options
  * `onQuote` same as `tokenize`.
  * @returns {string}
  */
 function highlight(code, options) {
   const tokens = tokenize(code, options)
-  const lines = generate(tokens)
+  const lines = generate(tokens, options)
   const output = toHtml(lines)
   return output
 }

package/lib/presets/index.d.ts

@@ -1,10 +1,16 @@
 type LanguageConfig = {
   keywords: Set<string>
+  typeKeywords?: Set<string>
   onCommentStart?(curr: string, next: string): 0 | 1 | 2
   onCommentEnd?(prev: string, curr: string): 0 | 1 | 2
   onQuote?(curr: string, i: number, code: string): number | null | undefined
+  lineClassName?(line: string, index: number): string | null | undefined
 }
 
 export const css: LanguageConfig
 export const rust: LanguageConfig
 export const python: LanguageConfig
+export const c: LanguageConfig
+export const go: LanguageConfig
+export const java: LanguageConfig
+export const diff: LanguageConfig

package/lib/presets/index.js

@@ -1,3 +1,7 @@
 export * as css from './lang/css.js'
 export * as rust from './lang/rust.js'
 export * as python from './lang/python.js'
+export * as c from './lang/c.js'
+export * as go from './lang/go.js'
+export * as java from './lang/java.js'
+export * as diff from './lang/diff.js'

package/lib/presets/lang/c.js

@@ -0,0 +1,17 @@
+// @ts-check
+import { onCommentStart, onCommentEnd } from './clike-base.js'
+
+export const typeKeywords = new Set([
+  'void', 'char', 'short', 'int', 'long', 'float', 'double', 'signed', 'unsigned',
+  '_Bool', '_Complex', '_Imaginary',
+])
+
+export const keywords = new Set([
+  'auto', 'break', 'case', 'const', 'continue', 'default', 'do', 'else', 'enum',
+  'extern', 'for', 'goto', 'if', 'inline', 'register', 'restrict', 'return',
+  'sizeof', 'static', 'struct', 'switch', 'typedef', 'union', 'volatile', 'while',
+  '_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn', '_Static_assert',
+  '_Thread_local',
+])
+
+export { onCommentStart, onCommentEnd }

package/lib/presets/lang/clike-base.js

@@ -0,0 +1,12 @@
+// @ts-check
+export const onCommentStart = (currentChar, nextChar) => {
+  const pair = currentChar + nextChar
+  if (pair === '//') return 1
+  if (pair === '/*') return 1
+  return 0
+}
+
+export const onCommentEnd = (prevChar, currChar) => {
+  if (currChar === '\n') return 1
+  return prevChar + currChar === '*/' ? 1 : 0
+}

package/lib/presets/lang/diff.js

@@ -0,0 +1,11 @@
+// @ts-check
+
+export const keywords = new Set([])
+
+export const lineClassName = (line) => {
+  if (line.startsWith('+') && !line.startsWith('+++')) return 'sh__line--diff-add'
+  if (line.startsWith('-') && !line.startsWith('---')) return 'sh__line--diff-remove'
+  if (line.startsWith('@@')) return 'sh__line--diff-hunk'
+  if (/^(diff --git|index |--- |\+\+\+ )/.test(line)) return 'sh__line--diff-meta'
+  return undefined
+}

package/lib/presets/lang/go.js

@@ -0,0 +1,16 @@
+// @ts-check
+import { onCommentStart, onCommentEnd } from './clike-base.js'
+
+export const typeKeywords = new Set([
+  'bool', 'byte', 'complex64', 'complex128', 'error', 'float32', 'float64', 'int',
+  'int8', 'int16', 'int32', 'int64', 'rune', 'string', 'uint', 'uint8', 'uint16',
+  'uint32', 'uint64', 'uintptr',
+])
+
+export const keywords = new Set([
+  'break', 'case', 'chan', 'const', 'continue', 'default', 'defer', 'else',
+  'fallthrough', 'for', 'func', 'go', 'goto', 'if', 'import', 'interface', 'map',
+  'package', 'range', 'return', 'select', 'struct', 'switch', 'type', 'var',
+])
+
+export { onCommentStart, onCommentEnd }

package/lib/presets/lang/java.js

@@ -0,0 +1,17 @@
+// @ts-check
+import { onCommentStart, onCommentEnd } from './clike-base.js'
+
+export const typeKeywords = new Set([
+  'boolean', 'byte', 'char', 'double', 'float', 'int', 'long', 'short', 'void',
+])
+
+export const keywords = new Set([
+  'abstract', 'assert', 'break', 'case', 'catch', 'class', 'const', 'continue',
+  'default', 'do', 'else', 'enum', 'extends', 'final', 'finally', 'for', 'goto',
+  'if', 'implements', 'import', 'instanceof', 'interface', 'native', 'new',
+  'package', 'private', 'protected', 'public', 'return', 'static', 'strictfp',
+  'super', 'switch', 'synchronized', 'this', 'throw', 'throws', 'transient',
+  'try', 'volatile', 'while',
+])
+
+export { onCommentStart, onCommentEnd }

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "sugar-high",
-  "version": "1.0.0",
+  "version": "1.2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/huozhi/sugar-high.git",
+    "directory": "packages/sugar-high"
+  },
   "type": "module",
   "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
@@ -25,7 +30,7 @@
   },
   "devDependencies": {
     "@types/node": "22.12.0",
-    "typescript": "5.7.3",
+    "typescript": "6.0.2",
     "vitest": "^3.0.2"
   }
 }