feat(v2): allow custom output directory for build #2417

ZachJW34 · 2020-03-16T04:58:38Z

Motivation

Resolves #2410

Docusaurus 2 added the ability to specify a siteDir, so it would be nice if the output directory of the build could be changed as well. I have been working in an nx workspace, and all builds end up in dist at the root with my docs website at apps/website. Currently, there is no way to place the build anywhere except for inside the siteDir.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

I tested all these changes by running npx @docusaurus/init@next init to create a new repo. I built the packages and copied them over to the new repo.

Ran yarn build to verify normal behavior
Ran yarn build --outDir build/nested to verify custom output directory
Created a nested version by copying all docusaurus related content into a nested folder called nested
Ran yarn build nested to verify normal behavior
Ran yarn build nested --outDir to verify custom output directory
Created a github repo to test deploy.
Tested the commands above with deploy (Nested project has some tweaks to the docs so as to ensure I could see the difference).

Related PRs

None

docusaurus-bot · 2020-03-16T05:01:28Z

Deploy preview for docusaurus-2 ready!

Built with commit 18e92ec

https://deploy-preview-2417--docusaurus-2.netlify.com

yangshun · 2020-03-16T05:04:48Z

Thanks for the PR. Did you see #2410 before creating this?

ZachJW34 · 2020-03-16T05:14:43Z

I didn't! I started working on this a few days ago and didn't check the issues. I saw this issue from a while back and thought I'd take a crack at it.

lex111

Little improvements.

lex111 · 2020-03-16T09:23:33Z

packages/docusaurus/src/commands/deploy.ts

-export async function deploy(siteDir: string): Promise<void> {
+export async function deploy(
+  siteDir: string,
+  cliOptions: Partial<BuildCLIOptions>,


Suggested change

cliOptions: Partial<BuildCLIOptions>,

cliOptions: Partial<BuildCLIOptions> = {},

lex111 · 2020-03-16T09:27:00Z

website/docs/cli.md

@@ -59,6 +59,7 @@ Compiles your site for production.
 | Options | Default | Description |
 | --- | --- | --- |
 | `--bundle-analyzer` |  | Analyze your bundle with [bundle analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) |
+| `--outDir` | build | The full path for the new output directory, relative to the current workspace. |


lex111 · 2020-03-16T09:27:39Z

website/docs/cli.md

+
+| Options | Default | Description |
+| --- | --- | --- |
+| `--outDir` | build | The full path for the new output directory, relative to the current workspace. |


lex111 · 2020-03-16T09:30:27Z

packages/docusaurus/bin/docusaurus.js

-  .action((siteDir = '.', {bundleAnalyzer}) => {
+  .option(
+    '--outDir <outDir>',
+    'The full path for the new output directory, relative to the current workspace.',


Suggested change

'The full path for the new output directory, relative to the current workspace.',

'The full path for the new output directory, relative to the current workspace (default = build).',

lex111 · 2020-03-16T09:30:46Z

packages/docusaurus/bin/docusaurus.js

-    wrapCommand(deploy)(path.resolve(siteDir));
+  .option(
+    '--outDir <outDir>',
+    'The full path for the new output directory, relative to the current workspace.',


Suggested change

'The full path for the new output directory, relative to the current workspace.',

'The full path for the new output directory, relative to the current workspace (default = build).',

ZachJW34 · 2020-03-16T22:39:32Z

Updated!

yangshun

Thanks for this PR. I was thinking of just adding it to docusaurus.config.js. Was there any particular reasoning to add this option to the CLI command?

ZachJW34 · 2020-03-18T14:15:42Z

@yangshun Partly due to the talk in this issue. That was back in V1 so thoughts might have changed on that. Also, keeping the siteDir and outDir options next to each other made sense to me and having both the paths relative to some workspace root.

yangshun · 2020-03-18T15:03:11Z

@lex111 what do you think? Should it be in the config or as a CLI option? Next.js puts it in the config while Gatsby added it then reverted it and now still don't have it (gatsbyjs/gatsby#1878).

lex111 · 2020-03-18T15:18:57Z

I actually prefer to have this feature as a option to the CLI command. Current implementation is fine with me. ср, 18 мар. 2020 г. в 18:03, Yangshun Tay <[email protected]>:

…

@lex111 <https://github.com/lex111> what do you think? Should it be in the config or as a CLI option? Next.js puts it in the config <https://nextjs.org/docs/api-reference/next.config.js/setting-a-custom-build-directory> while Gatsby added it then reverted it and now still don't have it ( gatsbyjs/gatsby#1878 <https://github.com/gatsbyjs/gatsby/issues/1878>). — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2417 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABBUIO37MP4OCWPWM5ZGM33RIDPEBANCNFSM4LLX5KFA> .

yangshun

Thank you!

yangshun

Sorry can we do --out-dir instead to have consistent naming with our other CLI options?

Lemme know if you're not available to do it, I should be able to take it over and do the rename.

ZachJW34 · 2020-03-19T15:36:52Z

@yangshun Updated!

yangshun

Awesome, thank you!

ZachJW34 requested review from wgao19 and yangshun as code owners March 16, 2020 04:58

facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 16, 2020

lex111 reviewed Mar 16, 2020

View reviewed changes

ZachJW34 force-pushed the add-outdir branch from 5fb8710 to bd66c57 Compare March 16, 2020 22:38

lex111 approved these changes Mar 17, 2020

View reviewed changes

yangshun reviewed Mar 18, 2020

View reviewed changes

yangshun changed the title ~~feat(v2) add custom output directory to build~~ feat(v2): allow custom output directory for build Mar 18, 2020

yangshun approved these changes Mar 19, 2020

View reviewed changes

yangshun suggested changes Mar 19, 2020

View reviewed changes

feat(v2) add custom output directory to build

18e92ec

ZachJW34 force-pushed the add-outdir branch from bd66c57 to 18e92ec Compare March 19, 2020 15:29

yangshun approved these changes Mar 19, 2020

View reviewed changes

yangshun merged commit ce45413 into facebook:master Mar 19, 2020

yangshun added the pr: new feature This PR adds a new API or behavior. label Mar 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v2): allow custom output directory for build #2417

feat(v2): allow custom output directory for build #2417

ZachJW34 commented Mar 16, 2020 •

edited by lex111

Loading

docusaurus-bot commented Mar 16, 2020 •

edited

Loading

yangshun commented Mar 16, 2020

ZachJW34 commented Mar 16, 2020

lex111 left a comment

lex111 Mar 16, 2020

lex111 Mar 16, 2020

lex111 Mar 16, 2020

lex111 Mar 16, 2020

lex111 Mar 16, 2020

ZachJW34 commented Mar 16, 2020

yangshun left a comment

ZachJW34 commented Mar 18, 2020

yangshun commented Mar 18, 2020

lex111 commented Mar 18, 2020 via email

yangshun left a comment

yangshun left a comment •

edited

Loading

ZachJW34 commented Mar 19, 2020

yangshun left a comment

	cliOptions: Partial<BuildCLIOptions>,
	cliOptions: Partial<BuildCLIOptions> = {},

	\| `--outDir` \| build \| The full path for the new output directory, relative to the current workspace. \|
	\| `--outDir` \| `build` \| The full path for the new output directory, relative to the current workspace. \|

	'The full path for the new output directory, relative to the current workspace.',
	'The full path for the new output directory, relative to the current workspace (default = build).',

feat(v2): allow custom output directory for build #2417

feat(v2): allow custom output directory for build #2417

Conversation

ZachJW34 commented Mar 16, 2020 • edited by lex111 Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Related PRs

docusaurus-bot commented Mar 16, 2020 • edited Loading

yangshun commented Mar 16, 2020

ZachJW34 commented Mar 16, 2020

lex111 left a comment

Choose a reason for hiding this comment

lex111 Mar 16, 2020

Choose a reason for hiding this comment

lex111 Mar 16, 2020

Choose a reason for hiding this comment

lex111 Mar 16, 2020

Choose a reason for hiding this comment

lex111 Mar 16, 2020

Choose a reason for hiding this comment

lex111 Mar 16, 2020

Choose a reason for hiding this comment

ZachJW34 commented Mar 16, 2020

yangshun left a comment

Choose a reason for hiding this comment

ZachJW34 commented Mar 18, 2020

yangshun commented Mar 18, 2020

lex111 commented Mar 18, 2020 via email

yangshun left a comment

Choose a reason for hiding this comment

yangshun left a comment • edited Loading

Choose a reason for hiding this comment

ZachJW34 commented Mar 19, 2020

yangshun left a comment

Choose a reason for hiding this comment

ZachJW34 commented Mar 16, 2020 •

edited by lex111

Loading

docusaurus-bot commented Mar 16, 2020 •

edited

Loading

yangshun left a comment •

edited

Loading