Skip to content

Add flag to re-write sidebar.js (and other auto-generated files)Β #983

Open
@rossdanlm

Description

@rossdanlm

Is your feature request related to a problem?

Similar to #615 (comment), I noticed that changes to the OpenAPI specs aren't reflected in sidebar.ts file:

if (!fs.existsSync(`${outputDir}/sidebar.ts`)) {
try {
fs.writeFileSync(`${outputDir}/sidebar.ts`, view, "utf8");
console.log(
chalk.green(`Successfully created "${outputDir}/sidebar.ts"`)
);
} catch (err) {
console.error(
chalk.red(`Failed to write "${outputDir}/sidebar.ts"`),
chalk.yellow(err)
);
}
}
}

I think it would be nice to add an --overwrite arg in CLI that would allow you to overwrite this!

Describe the solution you'd like

Something similar to docusaurus gen-api-docs <plugin_id> --overwrite

Describe alternatives you've considered

Not blocked, able to just clean/delete the repo but it would be a nice step to include. It wasn't super obvious to me when I first did this and spend some time trying to debug why my updates weren't appearing in my docs.

Perhaps also maybe in output text say "warning: OpenAPI spec differs from data currently saved in <destination_path>.sidebar.ts file. If you would like to update this file, please re-run with the --overwrite flag: docusaurus gen-api-docs <plugin_id> --overwrite"

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions