Skip to content

Instantly share code, notes, and snippets.

@sideshowbarker

sideshowbarker/check-spec-urls.js

Created June 3, 2021 07:29
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save sideshowbarker/2d932874eaf64a2a979d5b145ec464a7 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save sideshowbarker/2d932874eaf64a2a979d5b145ec464a7 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. sideshowbarker created this gist Jun 3, 2021.
    168 changes: 168 additions & 0 deletions check-spec-urls.js
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,168 @@
    #!/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 fs = require('fs');
    const request = require('sync-request');
    const PATH = require('path');
    const URL = require('url');

    const log = msg => console.log(`${msg}`);
    const info = msg => console.log(chalk`{keyword('dimgrey') ${msg}}`);
    const warn = msg => console.warn(chalk`{yellowBright ${msg}}`);
    const error = msg => console.error(chalk`{redBright ${msg}}`);

    const needsSpecURL = mdnURL => {
    const slugSubstringsNotNeedingSpecURLs = [];
    return !slugSubstringsNotNeedingSpecURLs.some(substring =>
    mdnURL.includes(substring),
    );
    };

    var SPECURLS;
    var file;

    chalk.level = 3;

    const checkSpecURLs = (key, data) => {
    let deprecated = false;
    let standard = true;
    if (data && data instanceof Object && '__compat' in data) {
    const feature = key;
    const bcdFeatureData = data.__compat;
    const mdn_url = bcdFeatureData.mdn_url;
    if ('standard_track' in bcdFeatureData.status) {
    standard = bcdFeatureData.status.standard_track;
    if (!standard) {
    info(`${file}:${feature}: non-standard`);
    }
    }
    if ('deprecated' in bcdFeatureData.status) {
    deprecated = bcdFeatureData.status.deprecated;
    if (!deprecated) {
    info(`${file}:${feature}: deprecated`);
    }
    }
    if (!mdn_url && !(deprecated || !standard)) {
    if (!key.includes('_')) {
    warn(`${file}:${feature}: no mdn_url`);
    }
    }
    let spec_url = bcdFeatureData.spec_url;
    if (spec_url && spec_url.length !== 0) {
    if (deprecated) {
    warn(`${file}:${feature}: deprecated but has spec_url`);
    }
    if (!standard) {
    warn(`${file}:${feature}: nonstandard but has spec_url`);
    }
    if (spec_url instanceof Array) {
    for (const url of spec_url) {
    checkSpecURL(file, feature, url, mdn_url, standard, deprecated);
    }
    } else {
    checkSpecURL(file, feature, spec_url, mdn_url, standard, deprecated);
    }
    } else if (mdn_url && !URL.parse(mdn_url).hash && standard && !deprecated) {
    if (needsSpecURL(mdn_url)) {
    warn(`${file}:${feature}: no spec_url`);
    }
    }
    }
    return data;
    };

    const checkSpecURL = (
    file,
    feature,
    spec_url,
    mdn_url,
    standard,
    deprecated,
    ) => {
    if (
    spec_url.startsWith('https://datatracker.ietf.org/doc/html/rfc2324') ||
    spec_url.startsWith('https://datatracker.ietf.org/doc/html/rfc7168')
    ) {
    // "I'm a teapot" RFC; ignore
    return;
    }
    if (
    spec_url.match(
    /https:\/\/www.khronos.org\/registry\/webgl\/extensions\/[^/]+\//,
    )
    ) {
    return;
    }
    if (SPECURLS.includes(spec_url)) {
    return;
    }
    if (mdn_url && standard && !deprecated) {
    error(`${file}:${feature}: bad spec URL ${spec_url} Bad fragment?`);
    }
    };

    /**
    * @param {Promise<void>} filename
    */
    const processFile = filename => {
    log(`Processing ${filename}`);
    JSON.parse(fs.readFileSync(filename, 'utf-8').trim(), checkSpecURLs);
    };

    if (require.main === module) {
    /**
    * @param {string[]} files
    */
    const load = (...files) => {
    const options = {
    headers: { 'User-Agent': 'bcd-maintenance-script' },
    gzip: true,
    };
    const response = request(
    'GET',
    'https://raw.githubusercontent.com/w3c/mdn-spec-links/master/SPECURLS.json',
    options,
    );
    SPECURLS = JSON.parse(response.getBody('utf8'));
    for (file of files) {
    if (file.indexOf(__dirname) !== 0) {
    file = PATH.resolve(__dirname, '..', file);
    }
    if (!fs.existsSync(file)) {
    continue; // Ignore non-existent files
    }
    if (fs.statSync(file).isFile()) {
    if (PATH.extname(file) === '.json') {
    processFile(file);
    }
    continue;
    }
    load(...subFiles(file));
    }
    };

    const subFiles = file =>
    fs.readdirSync(file).map(subfile => {
    return PATH.join(file, subfile);
    });

    if (process.argv[2] && process.argv[2] !== 'fullupdate') {
    load(process.argv[2]);
    } else {
    load(
    'api',
    'css',
    'html',
    'http',
    'javascript',
    'mathml',
    'svg',
    'webdriver',
    );
    }
    }

    module.exports = { checkSpecURLs, processFile };