fix(module-type-aliases): move @type packages to dependencies #5601
Conversation
|
✔️ [V2] 🔨 Explore the source changes: 14cc853 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/614ad3a6e4b86f00073b7b0d 😎 Browse the preview: https://deploy-preview-5601--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5601--docusaurus-2.netlify.app/ |
|
✔️ [V2] 🔨 Explore the source changes: e3a3cff 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/614b0c2655799c0007486391 😎 Browse the preview: https://deploy-preview-5601--docusaurus-2.netlify.app |
|
|
||
| ```bash npm2yarn | ||
| npm install --save-dev typescript @docusaurus/module-type-aliases @types/react @types/react-router-dom @types/react-helmet @tsconfig/docusaurus |
There was a problem hiding this comment.
should we remove those from the TS template as well?
Are you sure it works? I don't think we have any e2e test on this yet
There was a problem hiding this comment.
dependencies will be installed transitively but devDependencies don't, so afaik it should work. I'll update the template and check it out
There was a problem hiding this comment.
Thanks, let me know if the TS template still works
There was a problem hiding this comment.
Taking longer than I thought🧐 Tried to set up a verdaccio registry locally, but when I npm_config_registry=http://localhost:4873 yarn install, I still get the real 2.0.0-beta.6 version on npm
There was a problem hiding this comment.
@slorber Tested, it's working🎉
There was a problem hiding this comment.
Thanks 👍
FYI I added a readme in init package with simpler local testing instructions without Verdaccio:
@docusaurus/init
Create Docusaurus apps easily.
Usage
Please see the installation documentation.
For maintainers
For Docusaurus maintainers, templates can be tested with:
cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website
yarn docusaurus-init init test-website classic
cd test-website
yarn startNote: test-website is not part of the workspace and use packages from npm.
Use the following to test the templates against local packages:
cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn docusaurus-init init test-website-in-workspace classic
cd test-website-in-workspace
yarn startThere was a problem hiding this comment.
Um, the problem here is whether npm installs @types/ dependencies transitively, so I do need to mock that process of running the whole yarn install process
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Josh-Cena
force-pushed
the
types-js-file
branch
from
5abc440
to
e3a3cff
Compare
Motivation
Should fix #5463. It seems we can also update the docs since installing
@docusaurus/module-type-aliaseswould install all the@types/*dependencies so they no longer need to be installed separately?Also removed
index.jsfile fromdocusaurus-typesas it doesn't really make sense.Have you read the Contributing Guidelines on pull requests?
Yes