🖋️ Add grammar for Radar chart

This commit is contained in:
Thomas Di Cizerone
2025-03-16 18:00:50 +01:00
parent d6022408a9
commit d80cc38bb2
11 changed files with 577 additions and 2 deletions

View File

@@ -7,6 +7,7 @@ export {
PieSection,
Architecture,
GitGraph,
Radar,
Branch,
Commit,
Merge,
@@ -31,6 +32,7 @@ export {
PieGeneratedModule,
ArchitectureGeneratedModule,
GitGraphGeneratedModule,
RadarGeneratedModule,
} from './generated/module.js';
export * from './gitGraph/index.js';
@@ -39,3 +41,4 @@ export * from './info/index.js';
export * from './packet/index.js';
export * from './pie/index.js';
export * from './architecture/index.js';
export * from './radar/index.js';

View File

@@ -0,0 +1 @@
export * from './module.js';

View File

@@ -0,0 +1,73 @@
import type {
DefaultSharedCoreModuleContext,
LangiumCoreServices,
LangiumSharedCoreServices,
Module,
PartialLangiumCoreServices,
} from 'langium';
import {
EmptyFileSystem,
createDefaultCoreModule,
createDefaultSharedCoreModule,
inject,
} from 'langium';
import { CommonValueConverter } from '../common/valueConverter.js';
import { MermaidGeneratedSharedModule, RadarGeneratedModule } from '../generated/module.js';
import { RadarTokenBuilder } from './tokenBuilder.js';
/**
* Declaration of `Radar` services.
*/
interface RadarAddedServices {
parser: {
TokenBuilder: RadarTokenBuilder;
ValueConverter: CommonValueConverter;
};
}
/**
* Union of Langium default services and `Radar` services.
*/
export type RadarServices = LangiumCoreServices & RadarAddedServices;
/**
* Dependency injection module that overrides Langium default services and
* contributes the declared `Radar` services.
*/
export const RadarModule: Module<RadarServices, PartialLangiumCoreServices & RadarAddedServices> = {
parser: {
TokenBuilder: () => new RadarTokenBuilder(),
ValueConverter: () => new CommonValueConverter(),
},
};
/**
* Create the full set of services required by Langium.
*
* First inject the shared services by merging two modules:
* - Langium default shared services
* - Services generated by langium-cli
*
* Then inject the language-specific services by merging three modules:
* - Langium default language-specific services
* - Services generated by langium-cli
* - Services specified in this file
* @param context - Optional module context with the LSP connection
* @returns An object wrapping the shared services and the language-specific services
*/
export function createRadarServices(context: DefaultSharedCoreModuleContext = EmptyFileSystem): {
shared: LangiumSharedCoreServices;
Radar: RadarServices;
} {
const shared: LangiumSharedCoreServices = inject(
createDefaultSharedCoreModule(context),
MermaidGeneratedSharedModule
);
const Radar: RadarServices = inject(
createDefaultCoreModule({ shared }),
RadarGeneratedModule,
RadarModule
);
shared.ServiceRegistry.register(Radar);
return { shared, Radar };
}

View File

@@ -0,0 +1,89 @@
grammar Radar
// import "../common/common";
// Note: The import statement breaks TitleAndAccessibilities probably because of terminal order definition
// TODO: May need to change the common.langium to fix this
interface Common {
accDescr?: string;
accTitle?: string;
title?: string;
}
fragment TitleAndAccessibilities:
((accDescr=ACC_DESCR | accTitle=ACC_TITLE | title=TITLE) EOL)+
;
fragment EOL returns string:
NEWLINE+ | EOF
;
terminal NEWLINE: /\r?\n/;
terminal ACC_DESCR: /[\t ]*accDescr(?:[\t ]*:([^\n\r]*?(?=%%)|[^\n\r]*)|\s*{([^}]*)})/;
terminal ACC_TITLE: /[\t ]*accTitle[\t ]*:(?:[^\n\r]*?(?=%%)|[^\n\r]*)/;
terminal TITLE: /[\t ]*title(?:[\t ][^\n\r]*?(?=%%)|[\t ][^\n\r]*|)/;
hidden terminal WHITESPACE: /[\t ]+/;
hidden terminal YAML: /---[\t ]*\r?\n(?:[\S\s]*?\r?\n)?---(?:\r?\n|(?!\S))/;
hidden terminal DIRECTIVE: /[\t ]*%%{[\S\s]*?}%%(?:\r?\n|(?!\S))/;
hidden terminal SINGLE_LINE_COMMENT: /[\t ]*%%[^\n\r]*/;
entry Radar:
NEWLINE*
('radar-beta' | 'radar-beta:' | 'radar-beta' ':')
NEWLINE*
(
TitleAndAccessibilities
| 'axis' axes+=Axis (',' axes+=Axis)*
| 'curve' curves+=Curve (',' curves+=Curve)*
| options+=Option (',' options+=Option)*
| NEWLINE
)*
;
fragment Label:
'[' label=STRING ']'
;
Axis:
name=ID (Label)?
;
Curve:
name=ID (Label)? '{' Entries '}'
;
fragment Entries:
NEWLINE* entries+=NumberEntry (',' NEWLINE* entries+=NumberEntry)* NEWLINE* |
NEWLINE* entries+=DetailedEntry (',' NEWLINE* entries+=DetailedEntry)* NEWLINE*
;
interface Entry {
axis?: @Axis;
value: number;
}
DetailedEntry returns Entry:
axis=[Axis:ID] ':'? value=NUMBER
;
NumberEntry returns Entry:
value=NUMBER
;
Option:
(
name='showLegend' value=BOOLEAN
| name='ticks' value=NUMBER
| name='max' value=NUMBER
| name='min' value=NUMBER
| name='graticule' value=GRATICULE
)
;
terminal NUMBER returns number: /(0|[1-9][0-9]*)(\.[0-9]+)?/;
terminal BOOLEAN returns boolean: 'true' | 'false';
terminal GRATICULE returns string: 'circle' | 'polygon';
terminal ID returns string: /[a-zA-Z_][a-zA-Z0-9\-_]*/;
terminal STRING: /"[^"]*"|'[^']*'/;

View File

@@ -0,0 +1,7 @@
import { AbstractMermaidTokenBuilder } from '../common/index.js';
export class RadarTokenBuilder extends AbstractMermaidTokenBuilder {
public constructor() {
super(['radar-beta']);
}
}

View File

@@ -1,8 +1,8 @@
import type { LangiumParser, ParseResult } from 'langium';
import type { Info, Packet, Pie, Architecture, GitGraph } from './index.js';
import type { Info, Packet, Pie, Architecture, GitGraph, Radar } from './index.js';
export type DiagramAST = Info | Packet | Pie | Architecture | GitGraph;
export type DiagramAST = Info | Packet | Pie | Architecture | GitGraph | Radar;
const parsers: Record<string, LangiumParser> = {};
const initializers = {
@@ -31,6 +31,11 @@ const initializers = {
const parser = createGitGraphServices().GitGraph.parser.LangiumParser;
parsers.gitGraph = parser;
},
radar: async () => {
const { createRadarServices } = await import('./language/radar/index.js');
const parser = createRadarServices().Radar.parser.LangiumParser;
parsers.radar = parser;
},
} as const;
export async function parse(diagramType: 'info', text: string): Promise<Info>;
@@ -38,6 +43,7 @@ export async function parse(diagramType: 'packet', text: string): Promise<Packet
export async function parse(diagramType: 'pie', text: string): Promise<Pie>;
export async function parse(diagramType: 'architecture', text: string): Promise<Architecture>;
export async function parse(diagramType: 'gitGraph', text: string): Promise<GitGraph>;
export async function parse(diagramType: 'radar', text: string): Promise<Radar>;
export async function parse<T extends DiagramAST>(
diagramType: keyof typeof initializers,