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

Autogenerate docs and autocompletion for composite block types #632

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rhazn
Copy link
Contributor

@rhazn rhazn commented Dec 20, 2024

This PR adds autogenerated documentation and autocompletion for composite block types.

Code autocompletion for composite block types

Because we have a lot of composite block types in domain extensions in the stdlib this PR also introduces an additional level in the documentation, blocks are now categorized as either "builtin" or by domain:
Screenshot 2024-12-20 at 3 23 34 PM

Inside each domain, the expected block definitions can be found:
Screenshot 2024-12-20 at 3 24 31 PM

Code autocompletion for composite block types

As a (happy?) accident of the refactoring, this PR also adds the existing composite block types to the autocompletion.

Screenshot 2024-12-20 at 3 29 09 PM

@rhazn rhazn changed the title Autogenerate docs for composite block types Autogenerate docs and autocompletion for composite block types Dec 20, 2024
@rhazn rhazn marked this pull request as ready for review December 20, 2024 14:38
@rhazn rhazn requested review from georg-schwarz and joluj December 20, 2024 14:38
@rhazn
Copy link
Contributor Author

rhazn commented Dec 20, 2024

Not sure I understand why the license compliance fails. The error seems to be

reuse._util - ERROR - Could not parse 'AGPL-3.0-only`;'
reuse.project - ERROR - 'apps/docs-generator/src/UserDocCategoryBuilder.ts' holds an SPDX expression that cannot be parsed, skipping the file

But I can spot no mistake in the license definition there? Does anyone else have a hunch?

Copy link
Member

@georg-schwarz georg-schwarz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome 🥳 !

Does this also list the composite block types on root level of the stdlib, like the CSVExtractor?

@rhazn
Copy link
Contributor Author

rhazn commented Dec 20, 2024

It does, they get listed as Built-in Blocktypes (imho correctly) :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants