patternfly / patternfly/patternfly-react

Spike: investigate removing src from pf npm packages

Open
#10,868 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team Pinned Spike
Dominant language
TypeScript
Stars
862
Forks
392
Avg merge
4d 8h
Merged PRs (30d)
9

Description

currently, the various packages published to npm pf-react all include the src directories which bloat the published pkg size to 6.05 MB https://www.npmjs.com/package/@patternfly/react-core?activeTab=code

it also does create scenarios where products could be importing from our src directories, then their own custom typescript configurations will result in compiled typescript different than the PF distributions. (and possibly build errors for the product)

Would it be possible to remove the src from the pf packages without requiring further breaking changes from the pf packages? If so, this could be possibly framed as a bug fix. That's the goal of this spike.


Jira Issue: PF-26

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 by inspecting how the pf-react packages are published and compare their npm contents, especially the included src directories. Check whether removing src would affect existing imports or custom TypeScript configurations; done means documenting feasibility, compatibility risks, and any required package changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
build-system, release
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 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.