This repository was archived by the owner on Feb 22, 2019. It is now read-only.
Add option to define a file-specific comment to be added to all strings in a file #21
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
yoavf
force-pushed
the
add/default-comment-per-file
branch
from
a342b79 to
5861c2e
Compare
Member
|
There should be a way to disable this, I'd do this by making the |
akirk
reviewed
Oct 7, 2016
cli/index.js
Outdated
| var inputComment; | ||
|
|
||
| var input = fs.readFileSync( inputFile, 'utf8' ); | ||
| var rxFileCommentMatch = new RegExp( "^//\\s((Screenshot|Example):\\s(.*))$", 'm' ); |
Tug
reviewed
Sep 22, 2017
Contributor
Tug
left a comment
Tug
left a comment
There was a problem hiding this comment.
Nice addition. Just not sure about throwing an error here, they don't seem to be actually part of any specification.
cli/index.js
Outdated
| if ( validUrl.isWebUri( commentMatches[3] ) ) { | ||
| inputComment = commentMatches[1]; | ||
| } else { | ||
| throw new Error( 'File comment must be a valid web uri' ); |
Contributor
There was a problem hiding this comment.
Do we really want to throw here? Sounds like just skipping the comment silently would be a smoother solution
… use 'demo' instead of 'example' which is imo less likely to already serve another purpose
yoavf
force-pushed
the
add/default-comment-per-file
branch
from
e1b8859 to
a601643
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The goal of this PR is to enable developers to add either a screenshot or a public example link to their files, to assist translators:
For example a Calypso block could link to its render in devdocs, by adding the following comment
// Screenshot URL: https://cloudup.com/c5SgAxNZEoMor
// Demo URL: https://wpcalypso.wordpress.com/devdocs/blocks/author-selectorIf a string already has a comment, it will be appended.