#!/usr/bin/env node /* Any copyright is dedicated to the Public Domain. * http://creativecommons.org/publicdomain/zero/1.0/ */ 'use strict'; const chalk = require('chalk'); const bcd = require('..'); const { argv } = require('yargs').command( '$0 [folder]', 'Print a markdown-formatted table displaying the statistics of real, ranged, true, and null values for each browser', yargs => { yargs .positional('folder', { describe: 'Limit the statistics to a specific folder', type: 'string', default: '', }) .option('all', { describe: 'Show statistics for all browsers within BCD', type: 'flags', nargs: 0, }); }, ); /** * @typedef {import('../../types').Identifier} Identifier * * @typedef {object} VersionStats * @property {number} all The total number of occurrences for the browser. * @property {number} true The total number of `true` values for the browser. * @property {number} null The total number of `null` values for the browser. * @property {number} range The total number of range values for the browser. * @property {number} real The total number of real values for the browser. */ /** * @constant {string[]} */ const browsers = argv.all ? Object.keys(bcd.browsers) : [ 'chrome', 'chrome_android', 'edge', 'firefox', 'ie', 'safari', 'safari_ios', 'webview_android', ]; /** @type {object.} */ let stats = { total: { all: 0, true: 0, null: 0, range: 0, real: 0 } }; browsers.forEach(browser => { stats[browser] = { all: 0, true: 0, null: 0, range: 0, real: 0 }; }); /** * Check whether a support statement is a specified type * * @param {Identifier} supportData The support statement to check * @param {string|boolean|null} type What type of support (true, null, ranged) * @returns {boolean} If the support statement has the type */ const checkSupport = (supportData, type) => { if (!Array.isArray(supportData)) { supportData = [supportData]; } if (type == '≤') { return supportData.some( item => (typeof item.version_added == 'string' && item.version_added.startsWith('≤')) || (typeof item.version_removed == 'string' && item.version_removed.startsWith('≤')), ); } return supportData.some( item => item.version_added === type || item.version_removed === type, ); }; /** * Iterate through all of the browsers and count the number of true, null, real, and ranged values for each browser * * @param {Identifier} data The data to process and count stats for * @returns {void} */ const processData = data => { if (data.support) { browsers.forEach(browser => { stats[browser].all++; stats.total.all++; if (!data.support[browser]) { stats[browser].null++; stats.total.null++; } else if (checkSupport(data.support[browser], null)) { stats[browser].null++; stats.total.null++; } else if (checkSupport(data.support[browser], true)) { stats[browser].true++; stats.total.true++; } else if (checkSupport(data.support[browser], '≤')) { stats[browser].range++; stats.total.range++; } else { stats[browser].real++; stats.total.real++; } }); } }; /** * Iterate through all of the data and process statistics * * @param {Identifier} data The compat data to iterate * @returns {void} */ const iterateData = data => { for (const key in data) { if (key === '__compat') { processData(data[key]); } else { iterateData(data[key]); } } }; /** * Print a Markdown-formatted table of the statistics * * @returns {void} */ const printTable = () => { let table = `| browser | real values | ranged values | \`true\` values | \`null\` values | | --- | --- | --- | --- | --- | `; Object.keys(stats).forEach(entry => { table += `| ${entry.replace('_', ' ')} | `; table += `${((stats[entry].real / stats[entry].all) * 100).toFixed(2)}% | `; table += `${((stats[entry].range / stats[entry].all) * 100).toFixed( 2, )}% | `; table += `${((stats[entry].true / stats[entry].all) * 100).toFixed(2)}% | `; table += `${((stats[entry].null / stats[entry].all) * 100).toFixed(2)}% | `; }); console.log(table); }; /** * Print statistics of BCD * * @param {string} folder The folder to show statistics for (or all folders if blank) * @returns {boolean} False if the folder specified wasn't found */ const printStats = folder => { if (folder) { if (bcd[folder]) { iterateData(bcd[folder]); } else { console.error(chalk`{red.bold Folder "${folder}/" doesn't exist!}`); return false; } } else { for (const data in bcd) { if (!(data === 'browsers' || data === 'webextensions')) { iterateData(bcd[data]); } } } console.log( chalk`{bold Status as of version 1.0.xx (released on 2020-MM-DD) for ${ folder ? `${folder}/ directory` : 'web platform features' }}: \n`, ); printTable(); return true; }; if (require.main === module) { printStats(argv.folder); }