3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-09 23:27:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

polish(v2): improve codesandbox template package.json (#4074)

Browse source
This commit is contained in:
Sébastien Lorber 2021-01-20 13:29:45 +01:00 • committed by GitHub
parent 0a5d3069ee
commit eeb167e244
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 119 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

20
generateExamples.js
View file

@ -39,6 +39,20 @@ function generateTemplateExample(template) {
// attach the dev script which would be used in code sandbox by default
templatePackageJson.scripts.dev = 'docusaurus start';
// these example projects are not meant to be published to npm
templatePackageJson.private = true;
// make sure package.json name is not "examples-classic"
// the package.json name appear in CodeSandbox UI so let's display a good name!
// unfortunately we can't use uppercase or spaces
// see also https://github.com/codesandbox/codesandbox-client/pull/5136#issuecomment-763521662
templatePackageJson.name =
template === 'classic' ? 'docusaurus' : `docusaurus-${template}`;
templatePackageJson.description =
template === 'classic'
? 'Docusaurus example project'
: `Docusaurus example project (${template} template)`;
// rewrite the package.json file with the new edit
writeFileSync(
`./examples/${template}/package.json`,
@ -65,8 +79,10 @@ function generateTemplateExample(template) {
}
}
// delete the examples directory if it exists
rimraf.sync('./examples');
// delete the examples directories if they exists
rimraf.sync('./examples/classic');
rimraf.sync('./examples/facebook');
rimraf.sync('./examples/bootstrap');
// get the list of all available templates
readdir('./packages/docusaurus-init/templates', (err, data) => {