mb21 / mb21/markdown-it-pandoc

Update to modern peer dependency style

Open
#12 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
18
Forks
5
PR merge metrics
No merged PRs in 30d

Description

I'm admittedly new to npm/webpack stuff but my understanding is that this project currently uses an old style of peer dependencies. Modern webpack does a full static analysis of the code and expects everything it finds require()'d to be available. The impact of this is that, for example, even though I don't have markdown-it-mathjax3 enabled in either markdown-it-pandoc or panwriter, panwriter still complains that it's missing. It's possible to configure panwriter to ignore it, but that's a change to the panwriter config. Might as well fix it properly in this repo.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting this repository's npm dependency metadata and how its markdown-it plugins are declared, then compare that setup with webpack's static-analysis requirements. Done means panwriter no longer reports an unused markdown-it-mathjax3 dependency when that plugin is disabled, without requiring a panwriter configuration workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, webpack
Domain
build-system, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.