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

feat(snippets): splitting apart package and variable name configs #816

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

Conversation

erunion
Copy link
Member

@erunion erunion commented Nov 8, 2023

🧰 Changes

This splits apart some confusing work I did in httpsnippet-client-api where I was always tying the @api/<package name> to the variable name if a custom variable name was supplied. For example if you supplied an identifier of petstore and variableName of buster, the variable name would be buster but @api/<package name> would also be @api/buster. Very confusing and not really now we intend this custom variable name support to be handled.

Instead I've renamed the identifier option to the clearer packageName and added a new dedicated variableName config for custom variable names. This small refactor will require a couple small changes to @readme/oas-to-snippet.

@erunion erunion added refactor Issues about tackling technical debt area:snippets Issues related to code snippets labels Nov 8, 2023
@erunion erunion marked this pull request as ready for review November 8, 2023 08:45
packages/httpsnippet-client-api/src/index.ts Show resolved Hide resolved
packages/httpsnippet-client-api/src/index.ts Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:snippets Issues related to code snippets refactor Issues about tackling technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants