Giter Club home page Giter Club logo

hyf-code-validator's Introduction

HYF Code Validator

Opinionated in-browser code validator

Browser extension to validate (simple) webpages. Validating on HTML and CSS syntax errors and code standards.

Main validation code is located in: source/validate.js

Based on: https://github.com/notlmn/browser-extension-template

Setup

  1. Clone this repo
  2. Go to browser extension settings and load this extension's manifest.json file in the source folder
  3. A new debug tools panel should appear where validation results appear of that page

Validation rules

✅ Valid HTML

HtML gets send to https://validator.w3.org/nu/

Checked if there is an <h1>

✅ Descriptive CSS classnames

Finds and validates CSS classnames

TODO

  • Add more non-descriptive classnames
  • Improve detection using partial match

✅ DRY CSS

Duplicate CSS is found by comparing all CSS code blocks with eachother

❌ Magic numbers

Try to detect use of magic numbers (like margin-left: 23.5%)

❌ Mixing rem and pixels

font-size which are sometimes defined in rem and sometimes in px

❌ Semantic HTML

Maybe find a menu element which is not a <nav>

❌ Unecesarry usage of ids

Classes all the way except when there is no other way

❌ Classnames or ids written with capitals

Detect classnames and ids written with capitals

❌ Out commented HTML or CSS

Try to detect comment which are not informative, but just 'old' code

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.