Skip to content

Make it possible for third party cli extensions to use [siteDir] and --config #8903

Open
@Dr-Electron

Description

Have you read the Contributing Guidelines on issues?

Motivation

For some use cases, it would be nice to have a possibility for a third party to extend the CLI in a way so that those two options can be passed for custom setups.

As an example, look at this issue, where you would want to use their extendCli functionality, but can't as your config is in a subfolder or named differently.

Obviously plugins could also "just" add siteDir and --config to their extendCli, but that seems weird to me as most get that from the context they get on initialization.

Maybe it would be possible to make those two arguments part of the "main" docusaurus cli, so it can be parsed before and be passed to the plugin. Something like https://www.npmjs.com/package/commander#parsing-configuration

I'm not a plugin dev so maybe I understood something wrong here.
So would be nice to hear your opinion on that topic.

Self-service

  • I'd be willing to do some initial work on this proposal myself.

Metadata

Assignees

No one assigned

    Labels

    difficulty: advancedIssues that are complex, e.g. large scoping for long-term maintainability.proposalThis issue is a proposal, usually non-trivial change

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions