Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Proposal: docusaurus clear command #3370

Closed
slorber opened this issue Aug 31, 2020 · 4 comments · Fixed by #3446
Closed

Proposal: docusaurus clear command #3370

slorber opened this issue Aug 31, 2020 · 4 comments · Fixed by #3446
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.

Comments

@slorber
Copy link
Collaborator

slorber commented Aug 31, 2020

🚀 Feature

Having a clear command can be helpful, because sometimes errors are related to caching.

I think this clear command could just be a shortcut for:

rm -rf .docusaurus
rm -rf build
rm -rf node_modules/.cache/cache-loader

We should recommend users to try this command before reporting bugs, and also after upgrading Docusaurus version.
@slorber slorber added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. help wanted Asking for outside help and/or contributions to this particular issue or PR. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. labels Aug 31, 2020
@slorber slorber mentioned this issue Aug 31, 2020
Closed
@abadon7
Copy link
Contributor

abadon7 commented Sep 4, 2020

Hi @slorber, I would like to work on this. I suppose the idea is to have a "yarn clear", am I right?

@abadon7
Copy link
Contributor

abadon7 commented Sep 4, 2020

@slorber, I already see in package.json a "clear" command: "clear": "yarn rimraf website/.docusaurus && rimraf -rf website/node_modules/.cache && yarn lerna exec 'yarn rimraf lib' --ignore docusaurus"
The only thing that I see missing is the rm -rf build. Please guide me and let me know what you have in mind. Thanks.

@slorber
Copy link
Collaborator Author

slorber commented Sep 5, 2020

Hi

This clear command is for our own repo. What we must provide is a cli for all repos, should be added to packages/docusaurus using commander

@abadon7
Copy link
Contributor

abadon7 commented Sep 8, 2020

Hi.

😅 Thanks. Now I get it. I haven't worked with commander yet, but I think I can do it with some of help.

@abadon7 abadon7 mentioned this issue Sep 13, 2020
Merged
@slorber slorber linked a pull request Sep 28, 2020 that will close this issue
feat(v2): new docusaurus clear command #3446
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(v2): new docusaurus clear command abadon7/docusaurus
2 participants
@slorber @abadon7