Skip to content

Bullet Format File Error Message #697

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

Merged
merged 4 commits into from
Dec 12, 2024

Conversation

LePips
Copy link
Contributor

@LePips LePips commented Dec 11, 2024

Motivation

Generated my first package and initially had my config and schema files in the wrong location which generated the following error message:

error: Issues with required files: No config file found in the target named 'BlueskyKit'. Add a file called 'openapi-generator-config.yaml' or 'openapi-generator-config.yml' to the target's source directory. See documentation for details., andNo OpenAPI document found in the target named 'BlueskyKit'. Add a file called 'openapi.yaml', 'openapi.yml' or 'openapi.json' (can also be a symlink) to the target's source directory. See documentation for details..

The issue is the separation between multiple error messages, resulting in etails., andNo and that was confusing.

Modifications

For these file error messages, formats them to spit out into a bulleted - list.

Note: This does not fix the (pretty much) unnecessary added periods to the end of these messages that wrap other messages that have periods. I will save that for a later time.

Result

error: Issues with required files:
- No config file found in the target named 'BlueskyKit'. Add a file called 'openapi-generator-config.yaml' or 'openapi-generator-config.yml' to the target's source directory. See documentation for details.
- No OpenAPI document found in the target named 'BlueskyKit'. Add a file called 'openapi.yaml', 'openapi.yml' or 'openapi.json' (can also be a symlink) to the target's source directory. See documentation for details..

@LePips LePips changed the title bullet format file errors Bullet Format File Error Message Dec 11, 2024
Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

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

Thanks for the fix, just one suggestion on simplifying it

Co-authored-by: Honza Dvorsky <[email protected]>
@czechboy0 czechboy0 enabled auto-merge (squash) December 11, 2024 22:26
@simonjbeaumont simonjbeaumont added the 🆕 semver/minor Adds new public API. label Dec 12, 2024
@czechboy0 czechboy0 merged commit a5052b9 into apple:main Dec 12, 2024
32 of 33 checks passed
@czechboy0 czechboy0 added 🔨 semver/patch No public API change. and removed 🆕 semver/minor Adds new public API. labels Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants