The real power of HTML Inspector lies in its ability to enforce your team's chosen conventions. Again, more information can be found here. Here are the default configuration values: config:, which is just asking for trouble. The function is passed an array of errors that were reported by individual rules. onComplete: (Function) the callback to be invoked when the inspection is finished.excludeSubTrees: (selector | element | Array) the descendants of any DOM element that matches the selector, element, or list of selectors/elements will be excluded from traversal.excludeElements: (selector | element | Array) any DOM element that matches the selector, element, or list of selectors/elements will be excluded from traversal (note: its descendants will still be traversed).If useRules and excludeRules are both set, the excluded rules are removed from the list of rules to use. excludeRules: (Array) a list of rule names not to run when inspecting.Defaults to running all rules not excluded via excludeRules useRules: (Array) a list of rule names to run when inspecting.domRoot: (selector | element) the DOM element to start traversing from.
The inspect method takes a config object to allow you to change any of this behavior. Configuring HTML Inspectorīy default, HTML Inspector runs all added rules, starts traversing from the element, and logs errors to the console when complete, but all of this can be customized. Make sure you call inspect after any other DOM-altering scripts have finished running or those alterations won't get inspected. HTMLInspector.inspect() Īfter the script runs, any errors will be reported to the console (unless you change this behavior). Calling inspect with no options will load all rules and run them with their default configuration options. Once HTML Inspector is added, you can run HTMLInspector.inspect() to see the results.
If you clone the Github repo, just use the file named html-inspector.js in the project root. Htmlinspector - help # Bower (for browser usage) # Inspect a file from the command line # Note: the CLI requires phantomjs to be installed # It can also be installed via NPM or Bower: # NPM (for command line usage) The easiest way to try out HTML Inspector is to link to the source file hosted on CDNJS: It's also easy to extend, allowing teams to write their own rules to enforce their chosen conventions.įor a more formal introduction, please refer to this blog post which goes into more detail as to why HTML Inspector was created and why you should consider using it. HTML Inspector is opinionated, but every rule is completely customizable, so you can take what you like and change what you don't. It aims to find a balance between the uncompromisingly strict W3C validator and having absolutely no rules at all (the unfortunate reality for most of us).
#Html inspector warnings code
HTML Inspector is a highly-customizable, code quality tool to help you (and your team) write better markup.
0 kommentar(er)
