You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
$ npm run docs
> @flowforge/[email protected] docs
> jsdoc -c ./config/jsdoc.json
ERROR: Unable to find the source file or directory /Users/nol/code/ff/flowforge-dev-env/packages/flowforge-file-server/lib
There is no lib directory in this repo.
When I change config/jsdoc.json to point at ./forge (which does exist), the command gets a lot of errors similar to:
ERROR: Unable to parse a tag's type expression for source file /Users/nol/code/ff/flowforge-dev-env/packages/flowforge-file-server/forge/routes/files.js in line 12 with tag title "typedef" and text "{import('fastify').FastifyRequest} FastifyRequest": Invalid type expression "import('fastify').FastifyRequest": Expected "!", "=", "?", "[]", "|", or end of input but "(" found.
I propose we remove the docs task - it doesn't work and we haven't needed it for anything. Instead we should ensure all fastify routes have proper schemas and we can consider using the swagger plugin to generate route level docs.
But for now, we should remove jsdoc and the associated task.
Expected Behavior
No response
Steps To Reproduce
No response
Environment
FlowForge version:
Node.js version:
npm version:
Platform/OS:
Browser:
The text was updated successfully, but these errors were encountered:
Current Behavior
There is no
lib
directory in this repo.When I change
config/jsdoc.json
to point at./forge
(which does exist), the command gets a lot of errors similar to:I propose we remove the docs task - it doesn't work and we haven't needed it for anything. Instead we should ensure all fastify routes have proper schemas and we can consider using the swagger plugin to generate route level docs.
But for now, we should remove jsdoc and the associated task.
Expected Behavior
No response
Steps To Reproduce
No response
Environment
The text was updated successfully, but these errors were encountered: