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

Error running the demo locally #7

Closed
SimoneEnet opened this issue Oct 21, 2019 · 2 comments
Closed

Error running the demo locally #7

SimoneEnet opened this issue Oct 21, 2019 · 2 comments
Labels

Comments

@SimoneEnet
Copy link

Hello,
I wanted to try this compodoc demo locally but I'm getting an error.
To replicate:
npm install
npm run compodoc

> compodoc-demo-todomvc-angular@0.0.0 compodoc C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master
> compodoc --config .compodocrc

C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master\node_modules\cosmiconfig\dist\readFile.js:38
    throw err;
    ^

Error: ENOENT: no such file or directory, open 'C:\Users\simone.casarosa\Documents\workspaces\compodoc-demo-todomvc-angular-master\.compodocrc'
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the compodoc-demo-todomvc-angular@0.0.0 compodoc script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

Running npm run doc throws an error as well

1.1.11

TypeScript version used by Compodoc : 2.9.1

TypeScript version of current project : 3.5.3

Node.js version : v10.16.3

Operating system : Windows 10

[10:26:09] No configuration file found, switching to CLI flags.
[10:26:09] Provided source folder Angular was not found in the current directory
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! compodoc-demo-todomvc-angular@0.0.0 doc: `compodoc -p tsconfig.app.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the compodoc-demo-todomvc-angular@0.0.0 doc script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

It seems like the compodoc configuration file is missing, or is there something else I'm missing?

@vogloblinsky
Copy link
Contributor

ok reproduced...

@vogloblinsky
Copy link
Contributor

ok fixed, it is the custom name of the documentation in windows that breaks the flags algorithm.

compodoc -p tsconfig.app.json -a screenshots -n 'TodoMVC Angular documentation' --includes additional-doc breaks

compodoc -p tsconfig.app.json -a screenshots -n "TodoMVC Angular documentation" --includes additional-doc works

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