Bug - Package Publishing - Published Libraries should follow NPM dual module package standards
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 42/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- nodejs, typescript
- Domínio
- build-system, developer-experience, release
Direção de pesquisa
Revise os campos de metadados de pacote mostrados na issue em todos os pacotes PatternFly e, em seguida, reproduza o problema atual de resolução de módulos com vitest. Verifique primeiro as referências NPM package-examples e Vite library-mode; a tarefa estará concluída quando todos os pacotes afetados oferecerem suporte a ESM e CommonJS por meio de metadados de pacote padrão.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
PatternFly libraries should follow NPM standards for publishing dual module (CommonJS/ESModule) packages.
PatternFly packages have
"main": "dist/js/index.js",
"module": "dist/esm/index.js",
"types": "dist/esm/index.d.ts",
This is a really early format when es modules were being initially developed and not supported by modern tooling.
NPM documentation links to this as the right way to handle dual module packages.
{
"type": "module",
"exports": {
"import": "./index.mjs",
"require": "./index.cjs"
}
}
Modern tooling like vite builds libraries with a combination of both for compatibility.
{
"name": "my-lib",
"type": "module",
"main": "./dist/my-lib.umd.cjs",
"types": "./dist/my-lib.d.ts",
"module": "./dist/my-lib.js",
"exports": {
".": {
"import": "./dist/my-lib.js",
"require": "./dist/my-lib.umd.cjs"
}
}
}
This is currently blocking us from using vitest to test because it gets really confused. It tries to import the code as ESM but then is unhappy that the package is not marked as type "module". If we manually add type 'module', it then runs into some code that uses a 'require', which is not valid in the scope of a module.
PatternFly packages should support both ESM and CommonJS using NPM standards for better compatibility.
This affects all PF packages not just react-core.
- Linguagem predominante
- TypeScript
- Estrelas
- 862
- Forks
- 392
- Merge médio
- 4d 8h
- PRs com merge (30d)
- 9
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de patternfly/patternfly-react
-
PF Team
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
patternfly/patternfly-react#12651 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
patternfly/patternfly-react#12637 ·
-
PF Team
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
patternfly/patternfly-react#12617 · 1 comentário ·
-
PF Team
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
patternfly/patternfly-react#12610 · 1 comentário · 1 reação ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
patternfly/patternfly-react#12600 ·
Todas as issues de patternfly/patternfly-react
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
bcgov/bc-wallet-mobile#4761 · 1 comentário ·
-
external-issue to-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
-
area-deployment area-integrations triage:bot-seen
Dificuldade 2/5 Meio dia Facilidade para iniciantes 86/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
-
refactor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100