lite-hl 0.0.1 → 0.1.1

package/README.md

@@ -28,8 +28,9 @@ To maintain its ultra-light footprint, `lite-hl` makes specific engineering trad
 
 *   **Ultra-Lightweight**: At under 10KB, it is a fraction of the size of `highlight.js`.
 *   **Zero-Config Coverage**: Supports every programming language automatically. There is no need to "register" or import language definitions.
+*   **Deep Shell Script Support**: Robust parsing of Bash/Shell conventions, recognizing 60+ common utilities (`grep`, `awk`, `docker`, etc.) and dynamic variables (`$VAR`, `${VAR}`).
 *   **High Performance**: Tokenization happens in a single regex pass. It is optimized for large-scale documentation generators and real-time previews.
-*   **Legacy Compatibility**: natively supports a `mimicHljs` mode, allowing you to use existing `highlight.js` CSS themes (like GitHub, Atom, or Monokai) as a drop-in replacement.
+*   **Legacy Compatibility**: natively supports a `mimicHljs` mode, allowing you to use existing `highlight.js` CSS themes (like GitHub, Atom, or Monokai) exactly as they are without modification.
 *   **Runtime Agnostic**: Works perfectly in Node.js, the browser, and Edge environments.
 
 ## Installation

package/dist/index.js

@@ -19,7 +19,8 @@ const COMMON_KEYWORDS = [
     'void', 'null', 'undefined', 'true', 'false', 'def', 'pass', 'None', 'True', 'False',
     'match', 'with', 'as', 'struct', 'func', 'go', 'chan', 'defer', 'select', 'fallthrough',
     'namespace', 'using', 'pkg', 'mod', 'require', 'fn', 'pub', 'mut', 'impl', 'loop', 'unsafe',
-    'trait', 'where', 'macro_rules', 'use', 'int', 'float', 'double', 'char', 'bool'
+    'trait', 'where', 'macro_rules', 'use', 'int', 'float', 'double', 'char', 'bool',
+    'bash', 'sh', 'sudo', 'grep', 'sed', 'awk', 'ls', 'cd', 'cp', 'mv', 'rm', 'mkdir', 'chmod', 'chown', 'git', 'pnpm', 'npm', 'yarn', 'node', 'curl', 'wget', 'echo', 'printf', 'cat', 'grep', 'find', 'xargs', 'alias', 'export', 'set', 'unset', 'read', 'source', 'type', 'which', 'whoami', 'id', 'groups', 'ps', 'top', 'kill', 'df', 'du', 'free', 'uname', 'hostname', 'ip', 'ping', 'ssh', 'scp', 'rsync', 'tar', 'gzip', 'gunzip', 'zip', 'unzip', 'sudo', 'systemctl', 'journalctl', 'docker', 'kubectl', 'apt', 'yum', 'brew', 'cargo'
 ].join('|');
 // We use named capture groups so we can easily map matches back to their token types.
 // Order is critical: comments first, then strings, then numbers, then keywords, etc.
@@ -27,6 +28,7 @@ const UNIVERSAL_REGEX = new RegExp(`(?<comment>\\/\\/[^\\n]*|\\/\\*[\\s\\S]*?\\*
     `|(?<string>"(?:\\\\.|[^"\\\\])*"|'(?:\\\\.|[^'\\\\])*'|\`(?:\\\\.|[^\`\\\\])*\`)` +
     `|(?<number>\\b\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?\\b|\\b0x[a-fA-F0-9]+\\b)` +
     `|(?<keyword>\\b(?:${COMMON_KEYWORDS})\\b)` +
+    `|(?<variable>\\$[a-zA-Z0-9_$]+|\\$\\{[a-zA-Z0-9_$]+\\})` +
     `|(?<function>[a-zA-Z_$][a-zA-Z0-9_$]*(?=\\s*\\())` +
     `|(?<property>(?<=\\.)[a-zA-Z_$][a-zA-Z0-9_$]*)` +
     `|(?<operator>[=+\\-*\\/%&|<>!^~?:]+)`, 'g');
@@ -54,8 +56,16 @@ export function highlight(code, options = {}) {
         // Process Token Class
         let className = tokenType;
         if (isHljs) {
+            // Remap token types to match highlight.js CSS class names
             if (tokenType === 'function')
                 className = 'title function_';
+            else if (tokenType === 'property')
+                className = 'attr';
+            else if (tokenType === 'operator')
+                className = 'punctuation';
+            else if (tokenType === 'variable')
+                className = 'variable';
+            // 'comment', 'string', 'number', 'keyword' stay as-is (already match hljs names)
             className = `hljs-${className}`;
         }
         result += `<span class="${className}">${escapeHtml(text)}</span>`;

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "lite-hl",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "A universal, zero-config, heuristic code tokenizer and highlighter.",
   "type": "module",
+  "files": [
+    "dist"
+  ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -32,11 +35,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/docmd-io/docmd.git",
+    "url": "git+https://github.com/docmd-io/lite-hl.git",
     "directory": "lite-hl"
   },
   "bugs": {
-    "url": "https://github.com/docmd-io/docmd/issues"
+    "url": "https://github.com/docmd-io/lite-hl/issues"
   },
   "homepage": "https://docmd.io",
   "funding": "https://github.com/sponsors/mgks",

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/.github/workflows/publish.yml

@@ -1,32 +0,0 @@
-name: Publish to NPM
-on:
-  release:
-    types: [published]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  id-token: write
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          registry-url: 'https://registry.npmjs.org'
-          
-      - name: Install dependencies
-        run: npm install
-        
-      - name: Build package
-        run: npm run build
-        
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/src/index.ts

@@ -1,101 +0,0 @@
-/**
- * lite-hl: Universal Heuristic Syntax Highlighter
- * Tokenizes generic programming code without relying on language-specific grammars.
- */
-
-// Escape HTML securely
-function escapeHtml(str: string): string {
-  return str
-    .replace(/&/g, '&')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&#039;');
-}
-
-const COMMON_KEYWORDS = [
-  'return', 'if', 'else', 'while', 'for', 'do', 'break', 'continue', 'switch', 'case', 'default',
-  'try', 'catch', 'finally', 'throw', 'class', 'function', 'var', 'let', 'const', 'import', 'export', 'from',
-  'public', 'private', 'protected', 'static', 'extends', 'implements', 'new', 'this', 'super',
-  'typeof', 'instanceof', 'in', 'of', 'yield', 'await', 'async', 'interface', 'type', 'enum',
-  'void', 'null', 'undefined', 'true', 'false', 'def', 'pass', 'None', 'True', 'False',
-  'match', 'with', 'as', 'struct', 'func', 'go', 'chan', 'defer', 'select', 'fallthrough',
-  'namespace', 'using', 'pkg', 'mod', 'require', 'fn', 'pub', 'mut', 'impl', 'loop', 'unsafe',
-  'trait', 'where', 'macro_rules', 'use', 'int', 'float', 'double', 'char', 'bool'
-].join('|');
-
-// We use named capture groups so we can easily map matches back to their token types.
-// Order is critical: comments first, then strings, then numbers, then keywords, etc.
-const UNIVERSAL_REGEX = new RegExp(
-  `(?<comment>\\/\\/[^\\n]*|\\/\\*[\\s\\S]*?\\*\\/|#[^\\n]*|<!--[\\s\\S]*?-->)` +
-  `|(?<string>"(?:\\\\.|[^"\\\\])*"|'(?:\\\\.|[^'\\\\])*'|\`(?:\\\\.|[^\`\\\\])*\`)` +
-  `|(?<number>\\b\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?\\b|\\b0x[a-fA-F0-9]+\\b)` +
-  `|(?<keyword>\\b(?:${COMMON_KEYWORDS})\\b)` +
-  `|(?<function>[a-zA-Z_$][a-zA-Z0-9_$]*(?=\\s*\\())` +
-  `|(?<property>(?<=\\.)[a-zA-Z_$][a-zA-Z0-9_$]*)` +
-  `|(?<operator>[=+\\-*\\/%&|<>!^~?:]+)`,
-  'g'
-);
-
-export interface HighlightOptions {
-  /**
-   * Used strictly for class attribution, does not change the heuristic tokenization.
-   */
-  language?: string;
-  /**
-   * Mimic `highlight.js` class names to maintain compatibility with existing themes.
-   */
-  mimicHljs?: boolean;
-}
-
-export function highlight(code: string, options: HighlightOptions = {}): { value: string; language: string } {
-  const isHljs = options.mimicHljs !== false;
-  let result = '';
-  let lastIndex = 0;
-
-  for (const match of code.matchAll(UNIVERSAL_REGEX)) {
-    const start = match.index!;
-    const text = match[0];
-    const groups = match.groups!;
-
-    // Append un-matched text (escaped)
-    if (start > lastIndex) {
-      result += escapeHtml(code.slice(lastIndex, start));
-    }
-    lastIndex = start + text.length;
-
-    // Identify token
-    let tokenType = '';
-    for (const key in groups) {
-      if (groups[key] !== undefined) {
-        tokenType = key;
-        break;
-      }
-    }
-
-    // Process Token Class
-    let className = tokenType;
-    if (isHljs) {
-      if (tokenType === 'function') className = 'title function_';
-      className = `hljs-${className}`;
-    }
-
-    result += `<span class="${className}">${escapeHtml(text)}</span>`;
-  }
-
-  // Append remaining text
-  if (lastIndex < code.length) {
-    result += escapeHtml(code.slice(lastIndex));
-  }
-
-  return {
-    value: result,
-    language: options.language || 'plaintext'
-  };
-}
-
-// Ensure similar API signature to highlight.js
-export default {
-  highlight,
-  getLanguage: () => true // Assume support for all languages requested!
-};

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "Node16",
-    "moduleResolution": "node16",
-    "strict": true,
-    "declaration": true,
-    "outDir": "dist",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "skipLibCheck": true
-  },
-  "include": ["src/**/*"]
-}