Move "good" badge helpers from lib/ to services/ #3101
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paulmelnikow
added
service-badge
paulmelnikow
changed the title
|
|
This will keep causing merge conflicts as service are changed. It would be great to get this merged. Have added a list of affected files to the top post. |
|
I can look at this one tonight |
|
Was debating whether to ask this here or back over on #2832 (or #2698), but how are we qualifying "good" and "bad" for helper functions? (not implying any of the functions in this PR are "bad", just not sure what puts a helper into a category) Is "bad" just helper functions that are for legacy code/that will be unneeded once the service refactor is complete? |
Yes, and |
| @@ -96,32 +93,35 @@ Each service has a directory for its files: | |||
| All service badge classes inherit from [BaseService] or another class which extends it. | |||
| Other classes implement useful behavior on top of [BaseService]. | |||
|
|
|||
| * [BaseJsonService](https://github.com/badges/shields/blob/master/services/base-json.js) | |||
| - [BaseJsonService](https://github.com/badges/shields/blob/master/services/base-json.js) | |||
There was a problem hiding this comment.
Ah just realized these links are bad now, should be https://github.com/badges/shields/blob/master/core/base-service/base-json.js
| implements methods for performing requests to a JSON API and schema validation. | ||
| * [BaseXmlService](https://github.com/badges/shields/blob/master/services/base-xml.js) | ||
| - [BaseXmlService](https://github.com/badges/shields/blob/master/services/base-xml.js) |
There was a problem hiding this comment.
should be https://github.com/badges/shields/blob/master/core/base-service/base-xml.js
| class for the badges or one may already exist. | ||
|
|
||
| [BaseService]: https://github.com/badges/shields/blob/master/services/base.js | ||
| [baseservice]: https://github.com/badges/shields/blob/master/services/base.js |
There was a problem hiding this comment.
should be https://github.com/badges/shields/blob/master/core/base-service/base.js
|
|
||
| module.exports = class Example extends BaseService { // (3) | ||
| module.exports = class Example extends BaseService { | ||
| // (3) |
There was a problem hiding this comment.
I'm still not a fan of how prettier moves these comments around (especially num. 3) due to their relation to the bullets below.
Maybe we could move all the numbered comments to above the line the reference to both be consistent and satisfy prettier?
This doesn't need to be a blocker IMO (given all the changes in this PR) but if we merge these Tutorial changes as-is then I do feel we should update these inline code blocks soon
There was a problem hiding this comment.
Ahhh my editor must have done that. Thanks for catching it.
Do you think the inline numbers would look okay? They would be a lot easier to maintain, and it'd let us stop prettier-ignoring this file.
There was a problem hiding this comment.
How about we merge this and one of us can deal with the broken links and formatting as a follow-on?
There was a problem hiding this comment.
How about we merge this and one of us can deal with the broken links and formatting as a follow-on?
Works for me!
There was a problem hiding this comment.
I opened #3116 just to make sure we don't accidentally forget
calebcartwright
approved these changes
Feb 28, 2019
Closed
|
Thanks for the careful review! |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This moves a few helpers from
lib/toservices/:build-status.js
build-status.spec.js
color-formatters.js
color-formatters.spec.js
contributor-count.js
licenses.js
licenses.spec.js
php-version.js
php-version.spec.js
text-formatters.js
text-formatters.spec.js
version.js
version.spec.js
And one from
lib/tocore/:unhandled-rejection.spec.js
The diff is long, but the changes are straightforward.
Ref #2832