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

Normalize use of hyphen to underscore in API & LHR? #6371

Closed
paulirish opened this issue Oct 23, 2018 · 0 comments
Closed

Normalize use of hyphen to underscore in API & LHR? #6371

paulirish opened this issue Oct 23, 2018 · 0 comments

Comments

@paulirish
Copy link
Member

paulirish commented Oct 23, 2018

In #6201 we found we have a problem with not-applicable. It can't be represented in proto enum as hyphens are no good but underscores are too.

We're seeing a similar issue with the API: ...&category=pwa&category=best_practices

In both cases, it looks like we can do a mapping to maintain our hyphen-first API, but it's overhead and technical debt that sucks to absorb. The other alternative is we switch to underscore for both of these.

This means all uses of best-practices (and not-applicable) in the LHR would switch to the underscore equivalent. And it'd also apply to CLI usage (--only-categories=best_practices) and LHR handling..


...

TBH at this point I think I've talked myself out of the proposal. 🤣 Also if we're going hard on underscores then we might as well underscorify all the audit ids. Sounds exciting but not something to do right now. :)

Filing for posterity but for now it seems like we'll eat the debt of renaming underscore back to hyphen in our proto->json conversions.

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

No branches or pull requests

1 participant