patternfly / patternfly/patternfly-org

Revert update to ParseMD and investigate ESM compatible solution

Open
#4,005 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Is this a new page or a change to an existing one?
Revert the change made in https://github.com/patternfly/patternfly-org/pull/4004/files#diff-97bd431987a2e7dda0f66ad7f07ac6cf4eeebf21fbe44a1b45ef905968aa14caR207

Describe the enhancement

In order to get Typescript 4.7.4 to work in v6 with the visit function, we will have to investigate some potential approaches.

This may involve:

  • Upgrading to use ESM throughout org and generally moving away from CommonJS

or

  • Investigating if we can use another set of tools instead of unist-util to avoid any ESM-related issues

Contributor guide

Open the contributing guide

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 with the referenced patternfly-org pull request diff and trace the update to ParseMD, then inspect how the TypeScript 4.7.4 visit function interacts with the current CommonJS setup. Compare the ESM migration and alternative-tool approaches, and document a viable direction with the ParseMD change reverted or replaced.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
build-system, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.