Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add mermaid version option #566

Merged
merged 1 commit into from
Apr 6, 2022
Merged

feat: add mermaid version option #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,24 @@ export class Mermaid { }

[![Example](./media/example.png)](https://kamiazya.github.io/typedoc-plugin-samples/classes/hoge.html)

### Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

```bash
$ typedoc --help
...
Options:
--mermaidVersion [Mermaid Plugin] The version of mermaid.js to use.
...
```

- `--mermaidVersion`

Specify mermaid.js version to use.

Default: `latest`, Example: `8.14.0`

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ import { Application } from 'typedoc';
import { MermaidPlugin } from './plugin';

export function load(app: Application): void {
new MermaidPlugin().addToApplication(app);
new MermaidPlugin(app).initialize();
}
31 changes: 23 additions & 8 deletions src/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as html from 'html-escaper';
import { Converter, Context, PageEvent, Application, ReflectionKind, MarkdownEvent } from 'typedoc';
import { Converter, Context, PageEvent, Application, ReflectionKind, MarkdownEvent, ParameterType } from 'typedoc';

const style = String.raw`
<style>
Expand Down Expand Up @@ -49,8 +49,9 @@ body.dark, :root[data-theme="dark"] {
* 2. Initialize mermaid.
* 3. Add special attribute after SVG has been inserted.
*/
const script = String.raw`
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
function createScript(version: string): string {
return String.raw`
<script src="https://unpkg.com/mermaid@${version}/dist/mermaid.min.js"></script>
<script>
(function() {
if (typeof mermaid === "undefined") {
Expand All @@ -77,24 +78,34 @@ const script = String.raw`
})();
</script>
`;
}

const mermaidBlockStart = '<div class="mermaid-block">';
const mermaidBlockEnd = '</div>';

export class MermaidPlugin {
public addToApplication(app: Application): void {
app.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context: Context) => {
constructor(private app: Application) {}

public initialize(): void {
this.app.options.addDeclaration({
help: '[Mermaid Plugin] The version of mermaid.js to use.',
name: 'mermaidVersion',
type: ParameterType.String,
defaultValue: 'latest',
});

this.app.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context: Context) => {
this.onConverterResolveBegin(context);
});

app.renderer.on({
this.app.renderer.on({
[PageEvent.END]: (event: PageEvent) => {
this.onEndPage(event);
},
});

// high priority markdown parser to catch blocks before the built-in parser
app.renderer.on(
this.app.renderer.on(
MarkdownEvent.PARSE,
(event: MarkdownEvent) => {
this.onParseMarkdown(event);
Expand Down Expand Up @@ -174,6 +185,10 @@ export class MermaidPlugin {

// find the closing </body> tag and insert our mermaid scripts
const bodyEndIndex = html.lastIndexOf('</body>');
return html.slice(0, bodyEndIndex) + script + html.slice(bodyEndIndex);
return (
html.slice(0, bodyEndIndex) +
createScript(this.app.options.getValue('mermaidVersion') as string) +
html.slice(bodyEndIndex)
);
}
}
2 changes: 1 addition & 1 deletion test/__snapshots__/plugin.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ body.dark, :root[data-theme=\\"dark\\"] {
}
</style>
</head><body><div class=\\"mermaid-block\\"></div>
<script src=\\"https://unpkg.com/mermaid/dist/mermaid.min.js\\"></script>
<script src=\\"https://unpkg.com/mermaid@latest/dist/mermaid.min.js\\"></script>
<script>
(function() {
if (typeof mermaid === \\"undefined\\") {
Expand Down
7 changes: 5 additions & 2 deletions test/plugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { Application } from 'typedoc';
import { MermaidPlugin } from '../src/plugin';

describe('MermaidPlugin', () => {
const plugin = new MermaidPlugin();
const app = new Application();
const plugin = new MermaidPlugin(app);
plugin.initialize();

it('convert CommentTag', () => {
const input = 'title\ngraph';
Expand All @@ -16,7 +19,7 @@ describe('MermaidPlugin', () => {
const result = plugin.insertMermaidScript(input);
expect(result).toMatch('</body>');
expect(result).toMatch('mermaid.initialize({');
expect(result).toMatch(/src="https:\/\/unpkg.com\/mermaid\/dist\/mermaid.min.js"/);
expect(result).toMatch(/src="https:\/\/unpkg.com\/mermaid\@latest\/dist\/mermaid.min.js"/);
expect(result).toMatchSnapshot();
});

Expand Down