Add warnings for conflicting/deprecated component attribs #1057
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
nbriannl
commented
Feb 26, 2020
nbriannl
commented
Feb 27, 2020
nbriannl
changed the title
ang-zeyu
reviewed
Feb 27, 2020
Contributor
ang-zeyu
left a comment
ang-zeyu
left a comment
There was a problem hiding this comment.
Looks good 👍 Just some nits:
openorclose
requested changes
Feb 28, 2020
Contributor
openorclose
left a comment
openorclose
left a comment
There was a problem hiding this comment.
Should we use console.warn for now since they are warnings? Then we can change back to logger once it's working.
openorclose
reviewed
Feb 28, 2020
nbriannl
changed the title
marvinchin
requested changes
Feb 28, 2020
Contributor
marvinchin
left a comment
marvinchin
left a comment
There was a problem hiding this comment.
Great to see a more structured way of flagging errors to the user :) Added a couple of suggestions to make these logging functions more versatile.
Member
|
@nbriannl resolve the conflicts |
nbriannl
force-pushed
the
1045-component-warnings
branch
from
0e04800 to
f9e2e31
Compare
Use console log instead of logger add warning for modal slots Rewrite more efficient methods and use element Rewrite docs and reduce obvious code Reduce obvious code Remove empty lines Add gaurd clause and remove excessive todo Change console log to warn and remove return Change console log to warn Add more warns for dropdown Use conflicting instead of inconsistent Change c to child Add note regarding conlifcting attribs Restructure warnDeprecatedAttributes Use Foreach instead of loop Group all warns and put at start of parsing methods Restructure warnDeprecatedSlotName
nbriannl
force-pushed
the
1045-component-warnings
branch
from
f9e2e31 to
de67b19
Compare
Tejas2805
added a commit
to Tejas2805/markbind
that referenced
this pull request
Mar 9, 2020
* 'master' of https://github.com/MarkBind/markbind: 2.12.0 Update outdated test files Update vue-strap version to v2.0.1-markbind.37 Fix refactor to processDynamicResources (MarkBind#1092) Implement lazy page building for markbind serve (MarkBind#1038) Add warnings for conflicting/deprecated component attribs (MarkBind#1057) Allow changing parameter properties (MarkBind#1075) Custom timezone for built-in timestamp (MarkBind#1073) Fix reload inconsistency when updating frontmatter (MarkBind#1068) Implement an api to ignore content in certain tags (MarkBind#1047) Enable AppVeyor CI (MarkBind#1040) Add heading and line highlighting to code blocks (MarkBind#1034) Add dividers and fix bug in siteNav (MarkBind#1063) Fixed navbar no longer covers modals (MarkBind#1070) Add copy code-block plugin (MarkBind#1043) Render plugins on dynamic resources (MarkBind#1051) Documentation for Implement no-* attributes for <box> (MarkBind#1042) Migrate to bootstrap-vue popovers (MarkBind#1033) Refactor preprocess and url processing functions (MarkBind#1026) Add pageNav to Using Plugins Page (MarkBind#1062)
marvinchin
pushed a commit
that referenced
this pull request
Apr 10, 2020
nbriannl
added a commit
that referenced
this pull request
May 7, 2020
Replace console with logger A follow up to #1057. Let us also remove the error handler instance var And directly use logger instead
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Other, please explain: Add warning for bad markbind attribute usage
Fixes #1048
What is the rationale for this request?
Discussion here MarkBind/vue-strap#118 (comment)
Warning the user at compile time of the usage of conflicting/deprecated attributes in components is good for author usability.
What changes did you make? (Give an overview)
When parsing component attributes, check for presence of inconsistent, and deprecated attributes and warn accordingly.
Used console.log instead of logger utility because
parser.test.jsfails. This might possibly be a bug regarding howlogger.jsresolves the directory. See #1060No documentation needed since it is a warning on the CLI side.
Provide some example code that this change will affect:
The code in this gist will now produce warnings
https://gist.github.com/nbriannl/5c44b3ee8a8af78c45a7a4f3659ce196
Is there anything you'd like reviewers to focus on?
Instead of writing another method to warn for deprecated slot name (which is incurring an addtional 1 pass search on the element's children), I wanted to change
renameSlottoprocessSlotwhich will do both checking for deprecated slot name, and renaming. But this assumes that every rename of a slot is for a deprecated name. Therefore, I stuck with making two separate functions.Testing instructions:
markbind servethe example code in the gist.https://gist.github.com/nbriannl/5c44b3ee8a8af78c45a7a4f3659ce196
You should see
Proposed commit message: (wrap lines at 72 characters)
Add warnings for conflicting/deprecated component attribs