npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

front-end-checklist

v2.6.8

Published

front-end-checklist

Downloads

15

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

methamjern292methamjern292

Keywords

front

Readme

It is based on Front-End developers' years of experience, with the additions coming from some other open-source checklists.

How to use?

All items in the Front-End Checklist are required for the majority of the projects, but some elements can be omitted or are not essential (in the case of an administration web app, you may not need RSS feed for example). We choose to use 3 levels of flexibility:

All items in the Front-End Checklist are necessary for the majority of projects, but some elements can be omitted or are not essential. For example, in an administration web app, you may not need an RSS feed. We have categorized the flexibility into three levels:

Low indicates that the item is recommended but can be omitted in certain situations. Medium indicates that the item is highly recommended but can potentially be omitted in very specific cases. However, omitting these elements can negatively impact performance or SEO. High indicates that the item cannot be omitted under any circumstances. Removing these elements may result in page malfunctions or cause accessibility and SEO issues. Testing should prioritize these elements first.

Some resources possess an emoticon to help you understand which type of content / help you may find on the checklist:

  • 📖: documentation or article
  • 🛠: online tool / testing tool
  • 📹: media or video content

You can contribute to the Front-End Checklist App reading the CONTRIBUTING.md file which explains everything about the project.

Head

Notes: You can find a list of everything that could be found in the <head> of an HTML document.

Meta tag

  • [ ] Doctype: High The Doctype is HTML5 and is at the top of all your HTML pages.
<!DOCTYPE html>
<!-- HTML5 -->

The next 2 meta tags (Charset and Viewport) need to come first in the head.

  • [ ] Charset: High The charset (UTF-8) is declared correctly.
<!-- Set character encoding for the document -->
<meta charset="utf-8" />
  • [ ] Viewport: High The viewport is declared correctly.
<!-- Viewport for responsive web design -->
<meta
  name="viewport"
  content="width=device-width, initial-scale=1, viewport-fit=cover"
/>
  • [ ] Title: High A title is used on all pages (SEO: Google calculates the pixel width of the characters used in the title, and it cuts off between 472 and 482 pixels. The average character limit would be around 55-characters).
<!-- Document Title -->
<title>Page Title less than 55 characters</title>
  • [ ] Description: High A meta description is provided, it is unique and doesn't possess more than 150 characters.
<!-- Meta Description -->
<meta
  name="description"
  content="Description of the page less than 150 characters"
/>
  • [ ] Favicons: Medium Each favicon has been created and displays correctly. If you have only a favicon.ico, put it at the root of your site. Normally you won't need to use any markup. However, it's still good practice to link to it using the example below. Today, PNG format is recommended over .ico format (dimensions: 32x32px).
<!-- Standard favicon -->
<link rel="icon" type="image/x-icon" href="https://example.com/favicon.ico" />
<!-- Recommended favicon format -->
<link rel="icon" type="image/png" href="https://example.com/favicon.png" />
<!-- Recommended modern favicon format (not recommended for legacy browsers) -->
<link rel="icon" type="image/svg+xml" href="https://example.com/favicon.svg" />
  • [ ] Apple Web App Meta: Low Apple meta-tags are present.
<!-- Apple Touch Icon (at least 200x200px) -->
<link rel="apple-touch-icon" href="/custom-icon.png" />

<!-- To run the web application in full-screen -->
<meta name="apple-mobile-web-app-capable" content="yes" />

<!-- Status Bar Style (see Supported Meta Tags below for available values) -->
<!-- Has no effect unless you have the previous meta tag -->
<meta name="apple-mobile-web-app-status-bar-style" content="black" />
  • [ ] Windows Tiles: Low Windows tiles are present and linked.
<!-- Microsoft Tiles -->
<meta name="msapplication-config" content="browserconfig.xml" />

Minimum required xml markup for the browserconfig.xml file is as follows:

<?xml version="1.0" encoding="utf-8"?>
<browserconfig>
   <msapplication>
     <tile>
        <square70x70logo src="small.png"/>
        <square150x150logo src="medium.png"/>
        <wide310x150logo src="wide.png"/>
        <square310x310logo src="large.png"/>
     </tile>
   </msapplication>
</browserconfig>
  • [ ] Canonical: Medium Use rel="canonical" to avoid duplicate content.
<!-- Helps prevent duplicate content issues -->
<link
  rel="canonical"
  href="http://example.com/2017/09/a-new-article-to-read.html"
/>

HTML tags

  • [ ] Language attribute: High The lang attribute of your website is specified and related to the language of the current page.
<html lang="en"></html>
  • [ ] Direction attribute: Medium The direction of lecture is specified on the html tag (It can be used on another HTML tag).
<html dir="rtl"></html>
  • [ ] Alternate language: Low The language tag of your website is specified and related to the language of the current page.
<link rel="alternate" href="https://es.example.com/" hreflang="es" />
  • [ ] x-default: Low The language tag of your website for international landing pages.
<link rel="alternate" href="https://example.com/" hreflang="x-default" />
  • [ ] Conditional comments: Low Conditional comments are present for IE if needed.

  • [ ] RSS feed: Low If your project is a blog or has articles, an RSS link was provided.

  • [ ] CSS Critical: Medium The CSS critical (or "above the fold") collects all the CSS used to render the visible portion of the page. It is embedded before your principal CSS call and between <style></style> in a single line (minified).

  • [ ] CSS order: High All CSS files are loaded before any JavaScript files in the <head>. (Except the case where sometimes JS files are loaded asynchronously on top of your page).

Social meta

Visualize and generate automatically our social meta tags with Meta Tags

Facebook OG and Twitter Cards are, for any website, highly recommended. The other social media tags can be considered if you target a particular presence on those and want to ensure the display.

  • [ ] Facebook Open Graph: Low All Facebook Open Graph (OG) are tested and no one is missing or with false information. Images need to be at least 600 x 315 pixels, although 1200 x 630 pixels is recommended.

Notes: Using og:image:width and og:image:height will specify the image dimensions to the crawler so that it can render the image immediately without having to asynchronously download and process it.

<meta property="og:type" content="website" />
<meta property="og:url" content="https://example.com/page.html" />
<meta property="og:title" content="Content Title" />
<meta property="og:image" content="https://example.com/image.jpg" />
<meta property="og:description" content="Description Here" />
<meta property="og:site_name" content="Site Name" />
<meta property="og:locale" content="en_US" />
<!-- Next tags are optional but recommended -->
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
  • [ ] Twitter Card: Low
<meta name="twitter:card" content="summary" />
<meta name="twitter:site" content="@site_account" />
<meta name="twitter:creator" content="@individual_account" />
<meta name="twitter:url" content="https://example.com/page.html" />
<meta name="twitter:title" content="Content Title" />
<meta
  name="twitter:description"
  content="Content description less than 200 characters"
/>
<meta name="twitter:image" content="https://example.com/image.jpg" />

⬆ back to top

HTML

Best practices

  • [ ] HTML5 Semantic Elements: High HTML5 Semantic Elements are used appropriately (header, section, footer, main...).

  • [ ] Error pages: High Error 404 page and 5xx exist. Remember that the 5xx error pages need to have their CSS integrated (no external call on the current server).

  • [ ] Noopener: Medium In case you are using external links with target="_blank", your link should have a rel="noopener" attribute to prevent tab nabbing. If you need to support older versions of Firefox, use rel="noopener noreferrer".

  • [ ] Clean up comments: Low Unnecessary code needs to be removed before sending the page to production.

HTML testing

  • [ ] W3C compliant: High All pages need to be tested with the W3C validator to identify possible issues in the HTML code.
  • [ ] HTML Lint: High I use tools to help me analyze any issues I could have on my HTML code.
  • [ ] Link checker: High There are no broken links in my page, verify that you don't have any 404 error.
  • [ ] Adblockers test: Medium Your website shows your content correctly with adblockers enabled (You can provide a message encouraging people to disable their adblocker).

⬆ back to top

Webfonts

Notes: Using web fonts may cause Flash Of Unstyled Text/Flash Of Invisible Text - consider having fallback fonts and/or utilizing web font loaders to control behavior.

  • [ ] Webfont format: High WOFF, WOFF2 and TTF are supported by all modern browsers.

  • [ ] Webfont size: High Webfont sizes don't exceed 2 MB (all variants included).

  • [ ] Webfont loader: Low Control loading behavior with a webfont loader

⬆ back to top

CSS

Notes: Take a look at CSS guidelines and Sass Guidelines followed by most Front-End developers. If you have a doubt about CSS properties, you can visit CSS Reference. There is also a short Code Guide for consistency.

  • [ ] Responsive Web Design: High The website is using responsive web design.
  • [ ] CSS Print: Medium A print stylesheet is provided and is correct on each page.
  • [ ] Preprocessors: Low Your project is using a CSS preprocessor (e.g Sass, Less, Stylus).
  • [ ] Unique ID: High If IDs are used, they are unique to a page.
  • [ ] Reset CSS: High A CSS reset (reset, normalize or reboot) is used and up to date. (If you are using a CSS Framework like Bootstrap or Foundation, a Normalize is already included into it.)
  • [ ] JS prefix: Low All classes (or id- used in JavaScript files) begin with js- and are not styled into the CSS files.
<div id="js-slider" class="my-slider">
  <!-- Or -->
  <div id="id-used-by-cms" class="js-slider my-slider"></div>
</div>
  • [ ] embedded or inline CSS: High Avoid at all cost embedding CSS in <style> tags or using inline CSS: only use for valid reasons (e.g. background-image for slider, critical CSS).
  • [ ] Vendor prefixes: High CSS vendor prefixes are used and are generated accordingly with your browser support compatibility.

Performance

  • [ ] Concatenation: High CSS files are concatenated in a single file (Not for HTTP/2).
  • [ ] Minification: High All CSS files are minified.
  • [ ] Non-blocking: Medium CSS files need to be non-blocking to prevent the DOM from taking time to load.
  • [ ] Unused CSS: Low Remove unused CSS.

CSS testing

  • [ ] Stylelint: High All CSS or SCSS files are without any errors.

  • [ ] Desktop Browsers: High All pages were tested on all current desktop browsers (Safari, Firefox, Chrome, Internet Explorer, EDGE...).

  • [ ] Mobile Browsers: High All pages were tested on all current mobile browsers (Native browser, Chrome, Safari...).

  • [ ] OS: High All pages were tested on all current OS (Windows, Android, iOS, Mac...).

  • [ ] Design fidelity: Low Depending on the project and the quality of the creatives, you may be asked to be close to the design. You can use some tools to compare creatives with your code implementation and ensure consistency.

Pixel Perfect - Chrome Extension

  • [ ] Reading direction: High All pages need to be tested for LTR and RTL languages if they need to be supported.

⬆ back to top

Images

Notes: For a complete understanding of image optimization, check the free ebook Essential Image Optimization from Addy Osmani.

Best practices

  • [ ] Optimization: High All images are optimized to be rendered in the browser. WebP format could be used for critical pages (like Homepage).
  • 🛠 Imagemin
  • 🛠 Use ImageOptim to optimise your images for free.
  • 🛠 Use KeyCDN Image Processing for image optimization in real time.
  • 🛠 Use Kraken.io awesome alternative for both png and jpg optimization. Up to 1mb per files on free plan.
  • 🛠 TinyPNG optimises png, apng (animated png) and jpg images with very small loss in quality. Free and paid version available.
  • 🛠 ZorroSVG jpg-like compression for transparent images using svg masking.
  • 🛠 SVGO a Nodejs-based tool for optimizing SVG vector graphics files.
  • 🛠 SVGOMG a web-based GUI version of SVGO for optimising your svgs online.
  • [ ] Picture/Srcset: Medium You use picture/srcset to provide the most appropriate image for the current viewport of the user.
  • [ ] Retina: Low You provide layout images 2x or 3x, support retina display.
  • [ ] Sprite: Medium Small images are in a sprite file (in the case of icons, they can be in an SVG sprite image).
  • [ ] Width and Height: High Set width and height attributes on <img> if the final rendered image size is known (can be omitted for CSS sizing).
  • [ ] Alternative text: High All <img> have an alternative text which describes the image visually.

⬆ back to top

JavaScript

Best practices

  • [ ] JavaScript Inline: High You don't have any JavaScript code inline (mixed with your HTML code).
  • [ ] Concatenation: High JavaScript files are concatenated.
  • [ ] Minification: High JavaScript files are minified (you can add the .min suffix).
  • [ ] JavaScript security: High
  • [ ] noscript tag: Medium Use <noscript> tag in the HTML body if a script type on the page is unsupported or if scripting is currently turned off in the browser. This will be helpful in client-side rendering heavy apps such as React.js, see examples.
<noscript> You need to enable JavaScript to run this app. </noscript>
  • [ ] Non-blocking: Medium JavaScript files are loaded asynchronously using async or deferred using defer attribute.
  • [ ] Optimized and updated JS libraries: Medium All JavaScript libraries used in your project are necessary (prefer Vanilla Javascript for simple functionalities), updated to their latest version and don't overwhelm your JavaScript with unnecessary methods.
  • [ ] Modernizr: Low If you need to target some specific features you can use a custom Modernizr to add classes in your <html> tag.

JavaScript testing

  • [ ] ESLint: High No errors are flagged by ESLint (based on your configuration or standards rules).

⬆ back to top

Security

Scan and check your web site

Best practices

  • [ ] HTTPS: High HTTPS is used on every page and for all external content (plugins, images...).
  • [ ] HTTP Strict Transport Security (HSTS): Medium The HTTP header is set to 'Strict-Transport-Security'.
  • [ ] Cross Site Request Forgery (CSRF): High You ensure that requests made to your server-side are legitimate and originate from your website / app to prevent CSRF attacks.
  • [ ] Cross Site Scripting (XSS): High Your page or website is free from XSS possible issues.
  • [ ] Content Type Options: Medium Prevents Google Chrome and Internet Explorer from trying to mime-sniff the content-type of a response away from the one being declared by the server.
  • [ ] X-Frame-Options (XFO): Medium Protects your visitors against clickjacking attacks.
  • [ ] Content Security Policy: Medium Defines how content is loaded on your site and from where it is permitted to be loaded. Can also be used to protect against clickjacking attacks.

⬆ back to top

Performance

Best practices

  • [ ] Goals to achieve: Medium Your pages should reach these goals:
    • First Meaningful Paint under 1 second
    • Time To Interactive under 5 seconds for the "average" configuration (a $200 Android on a slow 3G network with 400ms RTT and 400kbps transfer speed) and under 2 seconds for repeat visits
    • Critical file size under 170Kb gzipped

  • [ ] Minified HTML: Medium Your HTML is minified.

  • [ ] Lazy loading: Medium Images, scripts and CSS need to be lazy loaded to improve the response time of the current page (See details in their respective sections).

  • [ ] Cookie size: Medium If you are using cookies be sure each cookie doesn't exceed 4096 bytes and your domain name doesn't have more than 20 cookies.

  • [ ] Third party components: Medium Third party iframes or components relying on external JS (like sharing buttons) are replaced by static components when possible, thus limiting calls to external APIs and keeping your user's activity private.

Preparing upcoming requests

  • [ ] DNS resolution: Low DNS of third-party services that may be needed are resolved in advance during idle time using dns-prefetch.
<link rel="dns-prefetch" href="https://example.com" />
  • [ ] Preconnection: Low DNS lookup, TCP handshake and TLS negotiation with services that will be needed soon is done in advance during idle time using preconnect.
<link rel="preconnect" href="https://example.com" />
  • [ ] Prefetching: Low Resources that will be needed soon (e.g. lazy loaded images) are requested in advance during idle time using prefetch.
<link rel="prefetch" href="image.png" />
  • [ ] Preloading: Low Resources needed in the current page (e.g. scripts placed at the end of <body>) in advance using preload.
<link rel="preload" href="app.js" />

Performance testing

  • [ ] Google PageSpeed: High All your pages were tested (not only the homepage) and have a score of at least 90/100.

⬆ back to top

Accessibility

Notes: You can watch the playlist A11ycasts with Rob Dodson 📹

Best practices

  • [ ] Progressive enhancement: Medium Major functionality like main navigation and search should work without JavaScript enabled.
  • [ ] Color contrast: Medium Color contrast should at least pass WCAG AA (AAA for mobile).

Headings

  • [ ] H1: High All pages have an H1 which is not the title of the website.
  • [ ] Headings: High Headings should be used properly and in the right order (H1 to H6).

Semantics

  • [ ] Specific HTML5 input types are used: Medium This is especially important for mobile devices that show customized keypads and widgets for different types.

Form

  • [ ] Label: High A label is associated with each input form element. In case a label can't be displayed, use aria-label instead.

Accessibility testing

  • [ ] Accessibility standards testing: High Use the WAVE tool to test if your page respects the accessibility standards.
  • [ ] Keyboard navigation: High Test your website using only your keyboard in a previsible order. All interactive elements are reachable and usable.
  • [ ] Screen-reader: Medium All pages were tested in a screen-reader (VoiceOver, ChromeVox, NVDA or Lynx).
  • [ ] Focus style: High If the focus is disabled, it is replaced by visible state in CSS.

⬆ back to top

SEO

  • [ ] Google Analytics: Low Google Analytics is installed and correctly configured.
  • [ ] Search Console: Low Search Console is installed and correctly configured. It is a free service offered by Google that helps you monitor, maintain, and troubleshoot your site's presence in Google Search results.
  • [ ] Headings logic: Medium Heading text helps to understand the content in the current page.
  • [ ] sitemap.xml: High A sitemap.xml exists and was submitted to Google Search Console (previously Google Webmaster Tools).
  • [ ] robots.txt: High The robots.txt is not blocking webpages.
  • [ ] Structured Data: High Pages using structured data are tested and are without errors. Structured data helps crawlers understand the content in the current page.
  • [ ] Sitemap HTML: Medium An HTML sitemap is provided and is accessible via a link in the footer of your website.

⬆ back to top

Translations

The Front-End Checklist is also available in other languages. Thanks for all translators and their awesome work!

Front-End Checklist Badge

If you want to show you are following the rules of the Front-End Checklist, put this badge on your README file!

➔ Front‑End_Checklist followed

[![Front‑End_Checklist followed](https://img.shields.io/badge/Front‑End_Checklist-followed-brightgreen.svg)](https://github.com/thedaviddias/Front-End-Checklist/)

⬆ back to top

Contributing

Open an issue or a pull request to suggest changes or additions.

Guide

The Front-End Checklist repository consists of two branches:

1. master

This branch consists of the README.md file that is automatically reflected on the Front-End Checklist website.

2. develop

This branch will be used to make some significant changes to the structure, content if needed. It is preferable to use the master branch to fix small errors or add a new item.

Support

If you have any question or suggestion, don't hesitate to use Gitter or Twitter:

Author

David Dias

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

CC0

⬆ back to top