Feature/add icon packs

[owynrichen]

feat(markdown_mermaidjs.py,-test_markdown_mermaid.py,-some-tasks): adds the ability to register icon packs with mermaid via extension configuration

Some newer diagrams (like architecture-beta) leverage icons that can be customized via mermaid.registerIconPacks() https://mermaid.js.org/config/icons.html, this exposes that capability via extension configuration and adds some tests.

Types of changes

• New feature
• Refactoring
• Documentation Update

Description

In addition to the registerIconPacks() work (with tests/etc), I also did some refactoring.

It also adds the ability to decide to bypass pty for tasks that require it so they can run on Windows. The big exception is the git.commit task doesn't work properly as prompt_toolkit can't seem to detect when running in cmd.exe (even when it is). It functions as expected in Ubuntu, though.

Checklist:

• Add test cases to all the changes you introduce
• Run inv style locally to ensure all linter checks pass
• Run inv test locally to ensure all test cases pass
• Run inv secure locally to ensure no major vulnerability is introduced
• it did note that jinja2 could use a patch version bump, but that seemed like a dependency issue
• Update the documentation if necessary
• added examples for how to use it in both python and Pelican

Steps to Test This Pull Request

The unit tests and documentation additions should cover the primary cases. Basically pass in an extension config
with icon_packs declared that match the { name : url } pattern i.e.:

{
  icon_packs : {
    'logos' : 'https://unpkg.com/@iconify-json/logos@1/icons.json'
  }
}

and it should add corresponding mermaid.registerIconPacks() calls in the script module declaration i.e.:

<script type="module">
    import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
    mermaid.registerIconPacks([
      { name: 'logos', loader: () => fetch('https://unpkg.com/@iconify-json/logos@1/icons.json').then((res) => res.json()) }
    ]);
    mermaid.initialize({ startOnLoad: true });
</script>

Expected behavior

The unit tests assert this behavior, specifically:

test_add_mermaid_script_and_tag_with_icons()

Related Issue

Additional context

[Lee-W]

Hi @owynrichen , could you please fix the EOL before reviewing? It changes too many things now make it harder to review

[owynrichen]

Can do, let me take a look and update it.

[owynrichen]

Got it done! Sorry for the delay. It should be ready for review now.

[Lee-W]

Got it done! Sorry for the delay. It should be ready for review now.

It still contains lots of files I think might not need to be changed 🤔 Could you please use git diff main and check whether these are the expected changes? Thanks!

[owynrichen]

Hey, I appreciate the POV. The changes in /tasks were to enable the passing of choice for pty from the command-line vs. forcing it to True always, to aide in execution on Windows (and corresponding documentation referencing the option). It still defaults to True so it's a no-op for folks generally.

The other changes are related to the additions themselves and adjustments to unit tests to match. The updates to the pre-commit-hook happened automatically when running the contributing documentation. I'm happy to revert those if you'd prefer.

[Lee-W]

The idea looks good. left some suggestions. Thanks for helping out!

[Lee-W]

Hey, I appreciate the POV. The changes in /tasks were to enable the passing of choice for pty from the command-line vs. forcing it to True always, to aide in execution on Windows (and corresponding documentation referencing the option). It still defaults to True so it's a no-op for folks generally.

The other changes are related to the additions themselves and adjustments to unit tests to match. The updates to the pre-commit-hook happened automatically when running the contributing documentation. I'm happy to revert those if you'd prefer.

I just checked again. Somehow the last time it did not reflect the changes 🤔 Thanks for updating!

[owynrichen]

Awesome, thanks for the feedback! I've updated things based on your recommendations.

[Lee-W]

Most of the remaining things are just nitpicks. We're really close to merge. Thanks for helping out!

[Lee-W]

one last nitpick and then we can merge it!

[Lee-W]

Let's move it to class docstring

[Lee-W]

we might need to take care of the blacken-docs version as well