Browserslist Average Usage

A command-line client that calculates the median level of browser usage based on custom stats in order to take advantage of Browserslist custom usage feature.

When building out custom usage data, often times the statistics you'll receive from Google Analytics will have browsers and/or versions with zeros. This makes finding a median to use for the in my stats query a bit difficult, since those numbers will deflate your actual audiences. This tool will take in a browserslist-stats.json and return a percentage that is the median number of usage.

Installation

npm install --save @theholocron/browserslist-average-usage

Usage
Changelog
Versioning
Contribution
Tools
Support
License

Usage

Run the --help or -h command to find out how to use the command.

$ browserslist-average-usage --help
Usage: browserslist-average-usage [options]

Options:
  --verbose        Turn on the logging                    [boolean]
  -h, --help       Show help                              [boolean]
  -v, --version    Show version number                    [boolean]

Commands:
  browserslist-average-usage                   Calculates the median level of browser usage based on custom      [aliases: get get-average] [default]
                                               stats in order to take advantage of Browserslist custom usage
  browserslist-average-usage write [source]    Writes to a source of ones choosing of where to store the         [aliases: write-file] 
                                               average usage statistics

Examples:
  browserslist-average-usage

© 2020 The Holocron. All rights reserved.

Input

At this time, the client does not accept any input.

Return

If the command succeeds, it will exit with a 0 code and the average percentage of browsers (e.g. 0.03030739465585173). Otherwise, it will exit with 1 code and an error message.

Commands

`get`

This is the default command and doesn't require that you add get, as its only an alias. Looks for a browserlist-stats.json file at the root of the library or code and calculates the average, then outputs to stdout.

`write [source]`

Grabs the average and writes the statistics to a source using the string <percentage> in my stats. If the stats exist in the source, then it will update the value with the new statistics.

The source can be one of two types: package or config. For the package option, it will create or update the browserslist key within the package.json. For the config option, it will create or update a browserslistrc.json file for use within Browserslist shareable configs option.

How We Track Changes

This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.

How We Version

We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes.
MINOR version when you add functionality in a backward-compatible manner.
PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

How to Contribute

Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:

How do I… (click to expand)

Where to Find Support

Looking to talk to someone or need some help? Please read our support guidelines.

Tools We Use

Browserslist - Used to share to our code which browsers we support
Conventional Changelog - Used to generate our CHANGELOG
Husky - Used for auto-fixing linting errors on each commit
Semantic Release - Used for automating and releasing our library

References

Conventional Commits - For how we format commit messages
Contributor Convenant
Keep a Changelog - For building out a quality CHANGELOG
Make a README - For building out this README
SemVer - For versioning this library

@theholocron/browserslist-average-usage

Browserslist Average Usage

Installation

Table of Contents