Packages upgrade in v0.24.0 introduce many breaking changes
@satya164 ya está trabajando en esto.
Desde el 4/11/2020.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
Environment
- macOS 10.15
- Node.js 12.18.4
component-docs@ 0.24.0
Description
Although the example in this repo work as expected, if we use component-docs@0.24.0 as a dependency in another project, the new version breaks the serve as well as build command like in below screenshot:
Another escalation of the issue I found out next is that, if my main project has react as direct dependency but its major version is different from component-docs@0.24.0's one (which is ^17.0.1). Say, my project still has react@^16.14.0, then when I execute the component-docs serve command, I got this error:
Error: Cannot find module '@mdx-js/tag'
...
I have to install @mdx-js/tag as direct dependency now, then get a couple of errors regarding missing: react-dom and redbox-react. However, once I installed those missing dependencies, I get this run time error:
Error: Invalid hook call. Hooks can only be called inside of the body of a function component.
This could happen for one of the following reasons:
1. You might have mismatching versions
of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem.
Reproducible Demo
cd into example folder, and init a package.json. Add component-docs@0.24.0 as dependency and with some scripts like so:
{
"name": "test-component-docs",
"version": "1.0.0",
"license": "MIT",
"scripts": {
"build": "component-docs build",
"docs": "component-docs serve"
},
"devDependencies": {
"component-docs": "^0.24.0"
}
}
- First execute
yarn docsand observe the broken layout of the preview site. - Add
react@16.14.0as direct dependency and observe the compile time error - Add the missing dependencies and observe the errors.
Suggestion
I don't know what happen yet but regarding the mismatch react version, I think we should move react, react-dom to devDependencies and peerDependencies so that component-docs should use the react version in consuming projects and avoid versions conflict.
- Lenguaje dominante
- TypeScript
- Estrellas
- 141
- Forks
- 12
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de callstack/component-docs
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
callstack/component-docs#48 · 1 reacción ·
-
Add support for iframe Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
callstack/component-docs#44 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
callstack/component-docs#34 ·
-
Support RNW Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 30/100
callstack/component-docs#30 · 1 reacción ·
-
greenkeeper
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
callstack/component-docs#18 ·
Todos los issues de callstack/component-docs
Issues similares
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
Mend: dependency security vulnerability untriaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100