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

entryPoints with 3+ folders on the path doesn't works #25

Open
sambugj opened this issue Nov 3, 2022 · 0 comments
Open

entryPoints with 3+ folders on the path doesn't works #25

sambugj opened this issue Nov 3, 2022 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@sambugj
Copy link

sambugj commented Nov 3, 2022

The following entryPoints configuration has problems making a documentation folder (please, see the logs):

"tsdocsOptions": {
    "entryPoints": ["./src/api/auth/auth.model.ts"],
    "logNotDocumented": ["class", "interface", "enum"],
    "documentImports": true,
    "sort": "alphabetical",
    "out": "./doc"
  }

Logs:

> ts-docs

node:fs:1386
  handleErrorFromBinding(ctx);
  ^

Error: EINVAL: invalid argument, mkdir 'doc\m.C:'
    at Object.mkdirSync (node:fs:1386:3)
    at Object.createDir (C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\fileHost\index.js:35:26)
    at Generator.generateModule (C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\generator\index.js:178:42)
    at Generator.generateThingsInsideModule (C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\generator\index.js:173:18)
    at Generator.generate (C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\generator\index.js:99:18)
    at C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\cli.js:58:21
    at Object.<anonymous> (C:\Users\gonza\sources\tsreactmercury\node_modules\@ts-docs\ts-docs\dist\cli.js:67:3)
    at Module._compile (node:internal/modules/cjs/loader:1126:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1180:10)
    at Module.load (node:internal/modules/cjs/loader:1004:32) {
  errno: -4071,
  syscall: 'mkdir',
  code: 'EINVAL',
  path: 'doc\\m.C:'
}

The following path in the entryPoints works fine, note: the path in the configuration has 2 folders (src & api):

 "tsdocsOptions": {
    "entryPoints": ["./src/api/auth.model.ts"],
    "logNotDocumented": ["class", "interface", "enum"],
    "documentImports": true,
    "sort": "alphabetical",
    "out": "./doc"
  }

Please, support a path with 3+ folders.

@sambugj sambugj added the bug Something isn't working label Nov 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants