chrome-devtools-frontend/scripts/eslint_rules/lib/jslog-context-list.js

Chrome DevTools UI

// Copyright 2024 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

'use strict';

const fs = require('fs');
const path = require('path');

const FILE = 'front_end/ui/visual_logging/KnownContextValues.ts';
const FRONT_END_PARENT_FOLDER = path.join(__filename, '..', '..', '..', '..');
const ABSOLUTE_FILE_PATH = path.join(FRONT_END_PARENT_FOLDER, FILE);
const LICENSE_HEADER = `// Copyright 2024 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

`;

/**
 * @type {import('eslint').Rule.RuleModule}
 */
module.exports = {
  meta: {
    type: 'problem',

    docs: {
      description: 'Puts jslog context values into KnownContextValues.ts file',
      category: 'Possible Errors',
    },
    fixable: 'code',
    schema: []  // no options
  },
  create: function(context) {
    const formattedValues = new Set(fs.readFileSync(ABSOLUTE_FILE_PATH, 'utf-8')
        .split('\n')
        .filter(l=>l.startsWith('  \'')));
    const checkValue = (value, node) => {
      if (typeof value !== 'string') {
        return;
      }
      if (!value.length) {
        return;
      }
      const formattedValue = '  ' + JSON.stringify(value).replaceAll('"', '\'') + ',';
      if (formattedValues.has(formattedValue)) {
        return;
      }
      formattedValues.add(formattedValue);
      if (process.env.ESLINT_FAIL_ON_UNKNOWN_JSLOG_CONTEXT_VALUE) {
        context.report({node, message: `Found jslog context value '${value}' that is not listed in ${FILE}`});
      }
    };

    const checkPropertyValue = (propertyName, node) => {
      for (const property of node?.properties || []) {
        if (property.key?.name === propertyName || property.key?.value === propertyName) {
          checkValue(property.value?.value, node);
        }
      }
    };
    return {
      CallExpression(node) {
        if (node.callee?.object?.name === 'VisualLogging') {
          checkValue(node.arguments[0]?.value, node);
        } else {
          const propertyName = node.callee?.property?.name;
          if (propertyName === 'registerActionExtension') {
            checkPropertyValue('actionId', node.arguments[0]);
          } else if (propertyName === 'registerViewExtension') {
            checkPropertyValue('id', node.arguments[0]);
          } else if (propertyName === 'registerSettingExtension') {
            checkPropertyValue('settingName', node.arguments[0]);
          } else if (propertyName === 'createSetting') {
            checkValue(node.arguments[0]?.value, node);
          }
        }
      },
      ObjectExpression(node) {
        checkPropertyValue('jslogContext', node);
      },
      VariableDeclarator(node) {
        if (node.id.type === 'Identifier' && node.id.name === 'generatedProperties') {
          for (const element of node.init?.elements || []) {
            checkPropertyValue('name', element);
          }
        }
        if (node.id.type === 'Identifier' && node.id.name === 'generatedAliasesFor') {
          for (const outerElement of node.init?.arguments?.[0]?.elements || []) {
            for (const innerElement of outerElement.elements || []) {
              checkValue(innerElement.value, innerElement);
            }
          }
        }
      },
      'Program:exit'() {
        if (process.env.ESLINT_FAIL_ON_UNKNOWN_JSLOG_CONTEXT_VALUE) {
          return;
        }
        const finalContents = LICENSE_HEADER + 'export const knownContextValues = new Set([\n' +
            [...formattedValues].sort().join('\n') + '\n]);\n';
        fs.writeFileSync(ABSOLUTE_FILE_PATH, finalContents, 'utf-8');
      }
    };
  }
};