search

no-stack-dub-sack / apexdox-vs-code

A lightweight VS Code extension that makes documenting your Salesforce Apex files an easy, integrated experience.
Other
49 stars 7 forks source link

ENOENT: no such file or directory, scandir #80

Closed pbornath closed 1 year ago

pbornath commented 1 year ago

I get the above error when I try to run apexdox. I am on a Mac running on MacOS Ventura. My understanding from the error would be that the code is looking for scandir but I am not finding it on the computer. Is there an assumption that it is available through a separate install or should be available generally?

no-stack-dub-sack commented 1 year ago

UPDATE: See most recent comment. Leaving this answer but latest message supersedes this advice.

Hi @pbornath, admittedly this unfriendly error message can be improved, but my guess is that you have not configured apex dox, which uses a default configuration by default. There appears to be a bug with the default configuration settings which I can address soon.

In the meantime, check out the docs on how to explicitly configure apex dox's source and target directories. Be sure to use the ${workspaceFolder} variable in apexdoc.engine.source.path. E.g. if the classes you want to document live in force-app/main/default/classes you would set the path to ${workspaceFolder}/force-app/main/default/classes.

Hope this helps.

no-stack-dub-sack commented 1 year ago

@pbornath The bug has been fixed and released (v2.0.3). Once you upgrade to the latest release you should be able to use the default settings. If the default folder does not exist, you'll get a helpful error message rather than a cryptic one like you received before.