Simplify and fix issue documentation #7
Merged
Conversation
This file contains hidden or 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
bin/build-content Outdated
There was a problem hiding this comment.
It might feel like overkill, but we probably want a mapping for this. I'm sure there will be more in the future.
There was a problem hiding this comment.
👍 thanks for suggestion
This commit updates build-content script (invoked during docker build) to write all rules to simply `./content/{#rule}.txt` instead of nesting them under: `./content/#{category}/#{rule}.txt` The update is cleaner and fixes a problem: 1) no complexity content due to phpmd quirky discrepancy between rule category name in documentation and in phpmd code itself. `!tldr`: My first approach tried to make the doc path during build match the check-naming in phpmd code, but this was messy and required conditional logic in a few places. The rule names are unique so they suffice for the lookup. https://github.com/codeclimate/codeclimate-phpmd/blob/master/Category.php#L72 
ABaldwinHunter force-pushed the abh-issue-content branch from eb520e2 to ac5f153 Compare 
| LGTM |
ABaldwinHunter pushed a commit that referenced this pull request Dec 8, 2015
Simplify and fix issue documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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 commit updates build-content script (invoked during docker build)
to write all rules to simply
./content/{#rule}.txtinstead of nesting them under:
./content/#{category}/#{rule}.txtThe update is cleaner and fixes a problem:
category name in documentation and in phpmd code itself.
!tldr:My first approach tried to make the doc path during
build match the check-naming in phpmd code, but this was messy and required
conditional logic in a few places.
The rule names are unique so they suffice for the lookup.
https://github.com/codeclimate/codeclimate-phpmd/blob/master/Category.php#L72
@codeclimate/review