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

npm run docs does not work #60

Closed
knolleary opened this issue Aug 14, 2023 · 0 comments · Fixed by #61
Closed

npm run docs does not work #60

knolleary opened this issue Aug 14, 2023 · 0 comments · Fixed by #61
Assignees
Labels
size:XS - 1 Sizing estimation point
Milestone

Comments

@knolleary
Copy link
Member

Current Behavior

$ 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:
@knolleary knolleary added the needs-triage Needs looking at to decide what to do label Aug 14, 2023
@knolleary knolleary added size:XS - 1 Sizing estimation point and removed needs-triage Needs looking at to decide what to do labels Aug 14, 2023
@knolleary knolleary added this to the 1.11 milestone Aug 14, 2023
@knolleary knolleary moved this to Todo in 🛠 Development Aug 14, 2023
@knolleary knolleary self-assigned this Aug 14, 2023
@Steve-Mcl Steve-Mcl moved this from Todo to Verify in 🛠 Development Aug 14, 2023
@knolleary knolleary moved this from Verify to Done in 🛠 Development Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS - 1 Sizing estimation point
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant