forked from mermaid-js/mermaid
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' of https://github.com/mermaid-js/mermaid into …
…feature/4661_gantt_customize_days_of_weekend
- Loading branch information
Showing
171 changed files
with
4,390 additions
and
1,985 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/** | ||
* Shared common options for both ESBuild and Vite | ||
*/ | ||
export const packageOptions = { | ||
parser: { | ||
name: 'mermaid-parser', | ||
packageName: 'parser', | ||
file: 'index.ts', | ||
}, | ||
mermaid: { | ||
name: 'mermaid', | ||
packageName: 'mermaid', | ||
file: 'mermaid.ts', | ||
}, | ||
'mermaid-example-diagram': { | ||
name: 'mermaid-example-diagram', | ||
packageName: 'mermaid-example-diagram', | ||
file: 'detector.ts', | ||
}, | ||
'mermaid-zenuml': { | ||
name: 'mermaid-zenuml', | ||
packageName: 'mermaid-zenuml', | ||
file: 'detector.ts', | ||
}, | ||
'mermaid-flowchart-elk': { | ||
name: 'mermaid-flowchart-elk', | ||
packageName: 'mermaid-flowchart-elk', | ||
file: 'detector.ts', | ||
}, | ||
} as const; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
import { generate } from 'langium-cli'; | ||
|
||
export async function generateLangium() { | ||
await generate({ file: `./packages/parser/langium-config.json` }); | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
import { load, JSON_SCHEMA } from 'js-yaml'; | ||
import assert from 'node:assert'; | ||
import Ajv2019, { type JSONSchemaType } from 'ajv/dist/2019.js'; | ||
import type { MermaidConfig, BaseDiagramConfig } from '../packages/mermaid/src/config.type.js'; | ||
|
||
/** | ||
* All of the keys in the mermaid config that have a mermaid diagram config. | ||
*/ | ||
const MERMAID_CONFIG_DIAGRAM_KEYS = [ | ||
'flowchart', | ||
'sequence', | ||
'gantt', | ||
'journey', | ||
'class', | ||
'state', | ||
'er', | ||
'pie', | ||
'quadrantChart', | ||
'xyChart', | ||
'requirement', | ||
'mindmap', | ||
'timeline', | ||
'gitGraph', | ||
'c4', | ||
'sankey', | ||
'block', | ||
'packet', | ||
] as const; | ||
|
||
/** | ||
* Generate default values from the JSON Schema. | ||
* | ||
* AJV does not support nested default values yet (or default values with $ref), | ||
* so we need to manually find them (this may be fixed in ajv v9). | ||
* | ||
* @param mermaidConfigSchema - The Mermaid JSON Schema to use. | ||
* @returns The default mermaid config object. | ||
*/ | ||
function generateDefaults(mermaidConfigSchema: JSONSchemaType<MermaidConfig>) { | ||
const ajv = new Ajv2019({ | ||
useDefaults: true, | ||
allowUnionTypes: true, | ||
strict: true, | ||
}); | ||
|
||
ajv.addKeyword({ | ||
keyword: 'meta:enum', // used by jsonschema2md | ||
errors: false, | ||
}); | ||
ajv.addKeyword({ | ||
keyword: 'tsType', // used by json-schema-to-typescript | ||
errors: false, | ||
}); | ||
|
||
// ajv currently doesn't support nested default values, see https://github.com/ajv-validator/ajv/issues/1718 | ||
// (may be fixed in v9) so we need to manually use sub-schemas | ||
const mermaidDefaultConfig = {}; | ||
|
||
assert.ok(mermaidConfigSchema.$defs); | ||
const baseDiagramConfig = mermaidConfigSchema.$defs.BaseDiagramConfig; | ||
|
||
for (const key of MERMAID_CONFIG_DIAGRAM_KEYS) { | ||
const subSchemaRef = mermaidConfigSchema.properties[key].$ref; | ||
const [root, defs, defName] = subSchemaRef.split('/'); | ||
assert.strictEqual(root, '#'); | ||
assert.strictEqual(defs, '$defs'); | ||
const subSchema = { | ||
$schema: mermaidConfigSchema.$schema, | ||
$defs: mermaidConfigSchema.$defs, | ||
...mermaidConfigSchema.$defs[defName], | ||
} as JSONSchemaType<BaseDiagramConfig>; | ||
|
||
const validate = ajv.compile(subSchema); | ||
|
||
mermaidDefaultConfig[key] = {}; | ||
|
||
for (const required of subSchema.required ?? []) { | ||
if (subSchema.properties[required] === undefined && baseDiagramConfig.properties[required]) { | ||
mermaidDefaultConfig[key][required] = baseDiagramConfig.properties[required].default; | ||
} | ||
} | ||
if (!validate(mermaidDefaultConfig[key])) { | ||
throw new Error( | ||
`schema for subconfig ${key} does not have valid defaults! Errors were ${JSON.stringify( | ||
validate.errors, | ||
undefined, | ||
2 | ||
)}` | ||
); | ||
} | ||
} | ||
|
||
const validate = ajv.compile(mermaidConfigSchema); | ||
|
||
if (!validate(mermaidDefaultConfig)) { | ||
throw new Error( | ||
`Mermaid config JSON Schema does not have valid defaults! Errors were ${JSON.stringify( | ||
validate.errors, | ||
undefined, | ||
2 | ||
)}` | ||
); | ||
} | ||
|
||
return mermaidDefaultConfig; | ||
} | ||
|
||
export const loadSchema = (src: string, filename: string): JSONSchemaType<MermaidConfig> => { | ||
const jsonSchema = load(src, { | ||
filename, | ||
// only allow JSON types in our YAML doc (will probably be default in YAML 1.3) | ||
// e.g. `true` will be parsed a boolean `true`, `True` will be parsed as string `"True"`. | ||
schema: JSON_SCHEMA, | ||
}) as JSONSchemaType<MermaidConfig>; | ||
return jsonSchema; | ||
}; | ||
|
||
export const getDefaults = (schema: JSONSchemaType<MermaidConfig>) => { | ||
return `export default ${JSON.stringify(generateDefaults(schema), undefined, 2)};`; | ||
}; | ||
|
||
export const getSchema = (schema: JSONSchemaType<MermaidConfig>) => { | ||
return `export default ${JSON.stringify(schema, undefined, 2)};`; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import { packageOptions } from './common.js'; | ||
import { execSync } from 'child_process'; | ||
|
||
const buildType = (packageName: string) => { | ||
console.log(`Building types for ${packageName}`); | ||
try { | ||
const out = execSync(`tsc -p ./packages/${packageName}/tsconfig.json --emitDeclarationOnly`); | ||
out.length > 0 && console.log(out.toString()); | ||
} catch (e) { | ||
console.error(e); | ||
e.stdout.length > 0 && console.error(e.stdout.toString()); | ||
e.stderr.length > 0 && console.error(e.stderr.toString()); | ||
} | ||
}; | ||
|
||
for (const { packageName } of Object.values(packageOptions)) { | ||
buildType(packageName); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,6 +36,7 @@ jsfiddle | |
jsonschema | ||
katex | ||
khroma | ||
langium | ||
mathml | ||
matplotlib | ||
mdbook | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
import { build } from 'esbuild'; | ||
import { mkdir, writeFile } from 'node:fs/promises'; | ||
import { packageOptions } from '../.build/common.js'; | ||
import { generateLangium } from '../.build/generateLangium.js'; | ||
import { MermaidBuildOptions, defaultOptions, getBuildConfig } from './util.js'; | ||
|
||
const shouldVisualize = process.argv.includes('--visualize'); | ||
|
||
const buildPackage = async (entryName: keyof typeof packageOptions) => { | ||
const commonOptions = { ...defaultOptions, entryName } as const; | ||
const buildConfigs = [ | ||
// package.mjs | ||
{ ...commonOptions }, | ||
// package.min.mjs | ||
{ | ||
...commonOptions, | ||
minify: true, | ||
metafile: shouldVisualize, | ||
}, | ||
// package.core.mjs | ||
{ ...commonOptions, core: true }, | ||
]; | ||
|
||
if (entryName === 'mermaid') { | ||
const iifeOptions: MermaidBuildOptions = { ...commonOptions, format: 'iife' }; | ||
buildConfigs.push( | ||
// mermaid.js | ||
{ ...iifeOptions }, | ||
// mermaid.min.js | ||
{ ...iifeOptions, minify: true, metafile: shouldVisualize } | ||
); | ||
} | ||
|
||
const results = await Promise.all(buildConfigs.map((option) => build(getBuildConfig(option)))); | ||
|
||
if (shouldVisualize) { | ||
for (const { metafile } of results) { | ||
if (!metafile) { | ||
continue; | ||
} | ||
const fileName = Object.keys(metafile.outputs) | ||
.filter((file) => !file.includes('chunks') && file.endsWith('js'))[0] | ||
.replace('dist/', ''); | ||
// Upload metafile into https://esbuild.github.io/analyze/ | ||
await writeFile(`stats/${fileName}.meta.json`, JSON.stringify(metafile)); | ||
} | ||
} | ||
}; | ||
|
||
const handler = (e) => { | ||
console.error(e); | ||
process.exit(1); | ||
}; | ||
|
||
const main = async () => { | ||
await generateLangium(); | ||
await mkdir('stats').catch(() => {}); | ||
const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[]; | ||
// it should build `parser` before `mermaid` because it's a dependency | ||
for (const pkg of packageNames) { | ||
await buildPackage(pkg).catch(handler); | ||
} | ||
}; | ||
|
||
void main(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import { readFile } from 'node:fs/promises'; | ||
import { transformJison } from '../.build/jisonTransformer.js'; | ||
import { Plugin } from 'esbuild'; | ||
|
||
export const jisonPlugin: Plugin = { | ||
name: 'jison', | ||
setup(build) { | ||
build.onLoad({ filter: /\.jison$/ }, async (args) => { | ||
// Load the file from the file system | ||
const source = await readFile(args.path, 'utf8'); | ||
const contents = transformJison(source); | ||
return { contents, warnings: [] }; | ||
}); | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import type { JSONSchemaType } from 'ajv/dist/2019.js'; | ||
import type { MermaidConfig } from '../packages/mermaid/src/config.type.js'; | ||
import { readFile } from 'node:fs/promises'; | ||
import { getDefaults, getSchema, loadSchema } from '../.build/jsonSchema.js'; | ||
|
||
/** | ||
* ESBuild plugin that handles JSON Schemas saved as a `.schema.yaml` file. | ||
* | ||
* Use `my-example.schema.yaml?only-defaults=true` to only load the default values. | ||
*/ | ||
|
||
export const jsonSchemaPlugin = { | ||
name: 'json-schema-plugin', | ||
setup(build) { | ||
let schema: JSONSchemaType<MermaidConfig> | undefined = undefined; | ||
let content = ''; | ||
|
||
build.onLoad({ filter: /config\.schema\.yaml$/ }, async (args) => { | ||
// Load the file from the file system | ||
const source = await readFile(args.path, 'utf8'); | ||
const resolvedSchema: JSONSchemaType<MermaidConfig> = | ||
content === source && schema ? schema : loadSchema(source, args.path); | ||
if (content !== source) { | ||
content = source; | ||
schema = resolvedSchema; | ||
} | ||
const contents = args.suffix.includes('only-defaults') | ||
? getDefaults(resolvedSchema) | ||
: getSchema(resolvedSchema); | ||
return { contents, warnings: [] }; | ||
}); | ||
}, | ||
}; | ||
|
||
export default jsonSchemaPlugin; |
Oops, something went wrong.