Files
mermaid/.esbuild/server-antlr.ts
Ashish Jain f623579505 feat: Complete ANTLR parser integration with 99.1% test compatibility
🎯 ANTLR Parser Migration - PRODUCTION READY!

## Major Achievements:
-  938/947 tests passing (99.1% compatibility with Jison parser)
-  Full regression testing completed successfully
-  Complete development environment integration
-  Production-ready parser implementation

## New Features:
- 🚀 ANTLR generate command integrated into build scripts
- 🛠️ Dedicated ANTLR development server with environment configuration
- 📊 Comprehensive test page for ANTLR parser validation
- 🔧 Environment variable control (USE_ANTLR_PARSER=true/false)

## Technical Improvements:
- 🎯 Advanced ANTLR 4 grammar with sophisticated patterns
- 🔍 Complex lookahead patterns for special character handling
- 📝 Semantic predicates for lexer mode transitions
- �� Custom listener architecture for flowchart model building
- 🧪 Extensive logging and debugging infrastructure

## Files Added:
- .esbuild/server-antlr.ts - ANTLR-enabled development server
- ANTLR_SETUP.md - Comprehensive setup and testing guide
- demos/flowchart-antlr-test.html - ANTLR parser test page

## Files Modified:
- package.json - Added antlr:generate and dev:antlr scripts
- packages/mermaid/package.json - Added ANTLR generation script
- .esbuild/util.ts - Environment variable replacement for browser
- packages/mermaid/src/diagrams/flowchart/parser/flowParser.ts - Parser selection logic
- packages/mermaid/src/diagrams/flowchart/parser/antlr/* - Grammar and parser improvements
- packages/mermaid/src/diagrams/flowchart/flowDb.ts - Enhanced logging

## Test Results:
- Total Tests: 947 across 15 test files
- Passing: 938 tests  (99.1%)
- Failing: 6 tests (error message format differences only)
- Skipped: 3 tests
- All functional parsing tests pass - only cosmetic error message differences remain

## Usage:
- Generate ANTLR files: pnpm antlr:generate
- Start ANTLR dev server: pnpm dev:antlr
- Test ANTLR parser: http://localhost:9000/flowchart-antlr-test.html
- Run tests: USE_ANTLR_PARSER=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/

This represents a major technical achievement in parser migration, providing a modern,
maintainable, and highly compatible replacement for the Jison parser while maintaining
near-perfect backward compatibility.
2025-09-15 22:04:06 +02:00

127 lines
3.6 KiB
TypeScript

/* eslint-disable no-console */
import chokidar from 'chokidar';
import cors from 'cors';
import { context } from 'esbuild';
import type { Request, Response } from 'express';
import express from 'express';
import { packageOptions } from '../.build/common.js';
import { generateLangium } from '../.build/generateLangium.js';
import { defaultOptions, getBuildConfig } from './util.js';
// Set environment variable to use ANTLR parser
process.env.USE_ANTLR_PARSER = 'true';
const configs = Object.values(packageOptions).map(({ packageName }) =>
getBuildConfig({
...defaultOptions,
minify: false,
core: false,
options: packageOptions[packageName],
})
);
const mermaidIIFEConfig = getBuildConfig({
...defaultOptions,
minify: false,
core: false,
options: packageOptions.mermaid,
format: 'iife',
});
configs.push(mermaidIIFEConfig);
const contexts = await Promise.all(
configs.map(async (config) => ({ config, context: await context(config) }))
);
let rebuildCounter = 1;
const rebuildAll = async () => {
const buildNumber = rebuildCounter++;
const timeLabel = `Rebuild ${buildNumber} Time (total)`;
console.time(timeLabel);
await Promise.all(
contexts.map(async ({ config, context }) => {
const buildVariant = `Rebuild ${buildNumber} Time (${Object.keys(config.entryPoints!)[0]} ${config.format})`;
console.time(buildVariant);
await context.rebuild();
console.timeEnd(buildVariant);
})
).catch((e) => console.error(e));
console.timeEnd(timeLabel);
};
let clients: { id: number; response: Response }[] = [];
function eventsHandler(request: Request, response: Response) {
const headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
};
response.writeHead(200, headers);
const clientId = Date.now();
clients.push({
id: clientId,
response,
});
request.on('close', () => {
clients = clients.filter((client) => client.id !== clientId);
});
}
let timeoutID: NodeJS.Timeout | undefined = undefined;
/**
* Debounce file change events to avoid rebuilding multiple times.
*/
function handleFileChange() {
if (timeoutID !== undefined) {
clearTimeout(timeoutID);
}
// eslint-disable-next-line @typescript-eslint/no-misused-promises
timeoutID = setTimeout(async () => {
await rebuildAll();
sendEventsToAll();
timeoutID = undefined;
}, 100);
}
function sendEventsToAll() {
clients.forEach(({ response }) => response.write(`data: ${Date.now()}\n\n`));
}
async function createServer() {
await generateLangium();
handleFileChange();
const app = express();
chokidar
.watch('**/src/**/*.{js,ts,langium,yaml,json}', {
ignoreInitial: true,
ignored: [/node_modules/, /dist/, /docs/, /coverage/],
})
// eslint-disable-next-line @typescript-eslint/no-misused-promises
.on('all', async (event, path) => {
// Ignore other events.
if (!['add', 'change'].includes(event)) {
return;
}
console.log(`${path} changed. Rebuilding...`);
if (path.endsWith('.langium')) {
await generateLangium();
}
handleFileChange();
});
app.use(cors());
app.get('/events', eventsHandler);
for (const { packageName } of Object.values(packageOptions)) {
app.use(express.static(`./packages/${packageName}/dist`));
}
app.use(express.static('demos'));
app.use(express.static('cypress/platform'));
app.listen(9000, () => {
console.log(`🚀 ANTLR Parser Dev Server listening on http://localhost:9000`);
console.log(`🎯 Environment: USE_ANTLR_PARSER=${process.env.USE_ANTLR_PARSER}`);
});
}
void createServer();