githubmirror/react-native

packages/eslint-plugin-specs/react-native-modules.js
220 строк6 KB
Marco Wang
switch to hermes for eslint-plugin-specs (#56023)
10 мар 2026, 23:53
10 мар 2026, 23:531c79fd5
/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 * @noflow
 */

'use strict';

const withBabelRegister = require('./with-babel-register');
const path = require('path');

// We use the prepack hook before publishing package to set this value to true
const PACKAGE_USAGE = false;
let RNModuleParser;
let RNParserUtils;
let RNFlowParser;
let RNParserCommons;
let RNFlowParserUtils;

function requireModuleParser() {
  if (
    RNModuleParser == null ||
    RNParserUtils == null ||
    RNFlowParser == null ||
    RNParserCommons == null ||
    RNFlowParserUtils == null
  ) {
    // If using this externally, we leverage @react-native/codegen as published form
    if (!PACKAGE_USAGE) {
      const config = {
        babelrc: false,
        configFile: false,
        only: [/react-native-codegen\/src\//],
        plugins: [
          require('babel-plugin-syntax-hermes-parser'),
          require('@babel/plugin-transform-flow-strip-types').default,
        ],
      };

      withBabelRegister(config, () => {
        RNModuleParser = require('@react-native/codegen/src/parsers/flow/modules');
        RNParserUtils = require('@react-native/codegen/src/parsers/utils');
        RNFlowParser = require('@react-native/codegen/src/parsers/flow/parser');
        RNParserCommons = require('@react-native/codegen/src/parsers/parsers-commons');
        RNFlowParserUtils = require('@react-native/codegen/src/parsers/flow/utils');
      });
    } else {
      const config = {
        babelrc: false,
        configFile: false,
        only: [/@react-native\/codegen\/lib\//],
        plugins: [
          require('babel-plugin-syntax-hermes-parser'),
          require('@babel/plugin-transform-flow-strip-types').default,
        ],
      };

      withBabelRegister(config, () => {
        RNModuleParser = require('@react-native/codegen/lib/parsers/flow/modules');
        RNParserUtils = require('@react-native/codegen/lib/parsers/utils');
        RNFlowParser = require('@react-native/codegen/lib/parsers/flow/parser');
        RNParserCommons = require('@react-native/codegen/lib/parsers/parsers-commons');
        RNFlowParserUtils = require('@react-native/codegen/lib/parsers/flow/utils');
      });
    }
  }

  return {
    buildModuleSchema: RNParserCommons.buildModuleSchema,
    createParserErrorCapturer: RNParserUtils.createParserErrorCapturer,
    parser: new RNFlowParser.FlowParser(),
    translateTypeAnnotation: RNModuleParser.flowTranslateTypeAnnotation,
  };
}

const VALID_SPEC_NAMES = /^Native\S+$/;

function isModuleRequire(node) {
  if (node.type !== 'CallExpression') {
    return false;
  }

  const callExpression = node;

  if (callExpression.callee.type !== 'MemberExpression') {
    return false;
  }

  const memberExpression = callExpression.callee;
  if (
    !(
      memberExpression.object.type === 'Identifier' &&
      memberExpression.object.name === 'TurboModuleRegistry'
    )
  ) {
    return false;
  }

  if (
    !(
      memberExpression.property.type === 'Identifier' &&
      (memberExpression.property.name === 'get' ||
        memberExpression.property.name === 'getEnforcing')
    )
  ) {
    return false;
  }
  return true;
}

function isGeneratedFile(context) {
  return (
    context
      .getSourceCode()
      .getText()
      .indexOf('@' + 'generated SignedSource<<') !== -1
  );
}

/**
 * A lint rule to guide best practices in writing type safe React NativeModules.
 */
module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description:
        'Enforce best practices for writing type-safe React Native TurboModules',
      recommended: false,
    },
    messages: {
      misnamedHasteModule:
        'Module {{hasteModuleName}}: All files using TurboModuleRegistry must start with Native.',
      parsingError: '{{message}}',
    },
    schema: [],
  },

  create(context) {
    const filename = context.getFilename();
    const hasteModuleName = path.basename(filename).replace(/\.js$/, '');

    if (isGeneratedFile(context)) {
      return {};
    }

    let isModule = false;

    return {
      'Program:exit': function (node) {
        if (!isModule) {
          return;
        }

        // Report invalid file names
        if (!VALID_SPEC_NAMES.test(hasteModuleName)) {
          context.report({
            node,
            messageId: 'misnamedHasteModule',
            data: {
              hasteModuleName,
            },
          });
        }

        const {
          buildModuleSchema,
          createParserErrorCapturer,
          parser,
          translateTypeAnnotation,
        } = requireModuleParser();

        const [parsingErrors, tryParse] = createParserErrorCapturer();

        const sourceCode = context.getSourceCode().getText();
        const ast = parser.getAst(sourceCode, filename);

        tryParse(() => {
          buildModuleSchema(
            hasteModuleName,
            ast,
            tryParse,
            parser,
            translateTypeAnnotation,
          );
        });

        parsingErrors.forEach(error => {
          error.nodes.forEach(flowNode => {
            context.report({
              loc: flowNode.loc,
              messageId: 'parsingError',
              data: {
                message: error.message,
              },
            });
          });
        });
      },
      CallExpression(node) {
        if (!isModuleRequire(node)) {
          return;
        }

        isModule = true;
      },
      InterfaceExtends(node) {
        if (node.id.name !== 'TurboModule') {
          return;
        }

        isModule = true;
      },
    };
  },
};