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.

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

Could not write when excludeScopesInPaths true. #610

Closed
fenilli opened this issue May 9, 2024 · 1 comment
Closed

Could not write when excludeScopesInPaths true. #610

fenilli opened this issue May 9, 2024 · 1 comment
Labels

Comments

@fenilli
Copy link

fenilli commented May 9, 2024

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

When adding "excludeScopesInPaths": true, the project gves:

[error] Could not write C:\Users\gusta\Documents\Projects\docs-ui\content\api-reference
[error] Documentation could not be generated due to the errors above.

TypeDoc configuration

{
  "entryPoints": [
    "packages/core",
    "packages/vue",
    "packages/addons",
    "packages/i18n",
    "packages/inputs",
    "packages/observer",
    "packages/utils",
    "packages/validation",
    "packages/zod",
  ],
  "plugin": [
    "typedoc-plugin-markdown",
  ],
  "entryPointStrategy": "packages",
  "excludeNotDocumented": true,
  "excludeInternal": true,
  "excludePrivate": true,
  "readme": "none",
  // typedoc-plugin-markdown
  "entryFileName": "index",
  "enumMembersFormat": "table",
  "parametersFormat": "table",
  "propertiesFormat": "table",
  "typeDeclarationFormat": "table",
  "indexFormat": "table",
  "mergeReadme": true,
  "excludeScopesInPaths": true,
}

Expected behavior

It is expected to create a flat structure without the @scope for the projects.

@tgreyuk
Copy link
Member

tgreyuk commented May 15, 2024

Thank you. Fixed in typedoc-plugin-markdown@4.0.2.

@tgreyuk tgreyuk closed this as completed May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants