@react-native/eslint-plugin-specs 0.0.1

package/BUCK

@@ -0,0 +1,23 @@
+load("@fbsource//tools/build_defs/third_party:yarn_defs.bzl", "yarn_workspace")
+
+yarn_workspace(
+    name = "yarn-workspace",
+    srcs = glob(
+        ["**/*.js"],
+        exclude = [
+            "**/__fixtures__/**",
+            "**/__flowtests__/**",
+            "**/__mocks__/**",
+            "**/__server_snapshot_tests__/**",
+            "**/__tests__/**",
+            "**/node_modules/**",
+            "**/node_modules/.bin/**",
+            "**/.*",
+            "**/.*/**",
+            "**/.*/.*",
+            "**/*.xcodeproj/**",
+            "**/*.xcworkspace/**",
+        ],
+    ),
+    visibility = ["PUBLIC"],
+)

package/__tests__/eslint-tester.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ */
+
+'use strict';
+
+const ESLintTester = require('eslint').RuleTester;
+
+ESLintTester.setDefaultConfig({
+  parser: require.resolve('babel-eslint'),
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+});
+
+module.exports = ESLintTester;

package/__tests__/react-native-modules-test.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails react_native
+ * @format
+ */
+
+'use strict';
+
+const ESLintTester = require('./eslint-tester.js');
+
+const rule = require('../react-native-modules');
+
+const NATIVE_MODULES_DIR = __dirname;
+
+const eslintTester = new ESLintTester();
+
+const VALID_SPECS = [
+  {
+    code: `
+import {TurboModuleRegistry, type TurboModule} from 'react-native';
+import type {UnsafeObject} from 'react-native/Libraries/Types/CodegenTypes';
+
+export interface Spec extends TurboModule {
+  func1(a: string): UnsafeObject,
+}
+export default TurboModuleRegistry.get<Spec>('XYZ');
+    `,
+    filename: `${NATIVE_MODULES_DIR}/NativeXYZ.js`,
+  },
+];
+
+const INVALID_SPECS = [
+  // Untyped NativeModule require
+  {
+    code: `
+import {TurboModuleRegistry, type TurboModule} from 'react-native';
+export interface Spec extends TurboModule {
+  func1(a: string): {||},
+}
+export default TurboModuleRegistry.get<Spec>('XYZ');
+      `,
+    filename: `${NATIVE_MODULES_DIR}/XYZ.js`,
+    errors: [
+      {
+        message: rule.errors.misnamedHasteModule('XYZ'),
+      },
+    ],
+  },
+];
+
+eslintTester.run('../react-native-modules', rule, {
+  valid: VALID_SPECS,
+  invalid: INVALID_SPECS,
+});

package/index.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails react_native
+ * @format
+ */
+
+'use strict';
+
+const reactNativeModules = require('./react-native-modules');
+
+module.exports = {
+  rules: {
+    'react-native-modules': reactNativeModules,
+  },
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@react-native/eslint-plugin-specs",
+  "version": "0.0.1",
+  "description": "ESLint rules to validate NativeModule and Component Specs",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:facebook/react-native.git",
+    "directory": "packages/eslint-plugin-specs"
+  },
+  "dependencies": {
+    "@babel/core": "^7.14.0",
+    "@babel/plugin-transform-flow-strip-types": "^7.0.0",
+    "flow-parser": "^0.121.0",
+    "make-dir": "^2.1.0",
+    "pirates":"^4.0.1",
+    "react-native-codegen": "*",
+    "source-map-support": "0.5.0"
+  },
+  "license": "MIT"
+}

package/react-native-modules.js

@@ -0,0 +1,156 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails react_native
+ * @format
+ */
+
+'use strict';
+
+const path = require('path');
+const withBabelRegister = require('./with-babel-register');
+
+const ERRORS = {
+  misnamedHasteModule(hasteModuleName) {
+    return `Module ${hasteModuleName}: All files using TurboModuleRegistry must start with Native.`;
+  },
+};
+
+let RNModuleParser;
+let RNParserUtils;
+
+function requireModuleParser() {
+  if (RNModuleParser == null || RNParserUtils == null) {
+    const config = {
+      only: [/react-native-codegen\/src\//],
+      plugins: [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/flow/utils');
+    });
+  }
+
+  return {
+    buildModuleSchema: RNModuleParser.buildModuleSchema,
+    createParserErrorCapturer: RNParserUtils.createParserErrorCapturer,
+  };
+}
+
+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.
+ */
+function rule(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,
+          message: ERRORS.misnamedHasteModule(hasteModuleName),
+        });
+      }
+
+      const {buildModuleSchema, createParserErrorCapturer} =
+        requireModuleParser();
+      const flowParser = require('flow-parser');
+
+      const [parsingErrors, tryParse] = createParserErrorCapturer();
+
+      const sourceCode = context.getSourceCode().getText();
+      const ast = flowParser.parse(sourceCode);
+
+      tryParse(() => {
+        buildModuleSchema(hasteModuleName, ast, tryParse);
+      });
+
+      parsingErrors.forEach(error => {
+        error.nodes.forEach(flowNode => {
+          context.report({
+            loc: flowNode.loc,
+            message: error.message,
+          });
+        });
+      });
+    },
+    CallExpression(node) {
+      if (!isModuleRequire(node)) {
+        return;
+      }
+
+      isModule = true;
+    },
+    InterfaceExtends(node) {
+      if (node.id.name !== 'TurboModule') {
+        return;
+      }
+
+      isModule = true;
+    },
+  };
+}
+
+rule.errors = ERRORS;
+
+module.exports = rule;

package/with-babel-register/disk-cache.js

@@ -0,0 +1,131 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails react_native
+ * @format
+ */
+
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+const {sync: makeDirSync} = require('make-dir');
+
+const packageJson = JSON.parse(
+  fs.readFileSync(require.resolve('../package.json'), 'utf8'),
+);
+
+/**
+ * This file is a fork of
+ * https://github.com/babel/babel/blob/2782a549e99d2ef1816332d23d7dfd5190f58a0f/packages/babel-register/src/cache.js#L1
+ */
+
+const FILENAME = path.join(
+  os.tmpdir(),
+  `.eslint-plugin-specs.${packageJson.version}.disk-cache.json`,
+);
+
+let data = {};
+
+let cacheDisabled = process.env.NODE_ENV === 'test';
+
+function isCacheDisabled() {
+  return cacheDisabled;
+}
+
+/**
+ * Write stringified cache to disk.
+ */
+function save() {
+  if (isCacheDisabled()) {
+    return;
+  }
+
+  let serialised = '{}';
+
+  try {
+    serialised = JSON.stringify(data, null, '  ');
+  } catch (err) {
+    if (err.message === 'Invalid string length') {
+      err.message = "Cache too large so it's been cleared.";
+      console.error(err.stack);
+    } else {
+      throw err;
+    }
+  }
+
+  try {
+    makeDirSync(path.dirname(FILENAME));
+    fs.writeFileSync(FILENAME, serialised);
+  } catch (e) {
+    switch (e.code) {
+      // workaround https://github.com/nodejs/node/issues/31481
+      // todo: remove the ENOENT error check when we drop node.js 13 support
+      case 'ENOENT':
+      case 'EACCES':
+      case 'EPERM':
+        console.warn(
+          `Could not write cache to file: ${FILENAME} due to a permission issue. Cache is disabled.`,
+        );
+        cacheDisabled = true;
+        break;
+      case 'EROFS':
+        console.warn(
+          `Could not write cache to file: ${FILENAME} because it resides in a readonly filesystem. Cache is disabled.`,
+        );
+        cacheDisabled = true;
+        break;
+      default:
+        throw e;
+    }
+  }
+}
+
+/**
+ * Load cache from disk and parse.
+ */
+
+function load() {
+  if (isCacheDisabled()) {
+    data = {};
+    return;
+  }
+
+  process.on('exit', save);
+  process.nextTick(save);
+
+  let cacheContent;
+
+  try {
+    cacheContent = fs.readFileSync(FILENAME);
+  } catch (e) {
+    switch (e.code) {
+      // check EACCES only as fs.readFileSync will never throw EPERM on Windows
+      // https://github.com/libuv/libuv/blob/076df64dbbda4320f93375913a728efc40e12d37/src/win/fs.c#L735
+      case 'EACCES':
+        console.warn(
+          `Babel could not read cache file: ${FILENAME} due to a permission issue. Cache is disabled.`,
+        );
+        cacheDisabled = true;
+      /* fall through */
+      default:
+        return;
+    }
+  }
+
+  try {
+    data = JSON.parse(cacheContent);
+  } catch {}
+}
+
+/**
+ * Retrieve data from cache.
+ */
+
+function get() {
+  return data;
+}
+
+module.exports = {load, get};

package/with-babel-register/index.js

@@ -0,0 +1,110 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails react_native
+ * @format
+ */
+
+const babel = require('@babel/core');
+const {OptionManager, DEFAULT_EXTENSIONS} = require('@babel/core');
+const sourceMapSupport = require('source-map-support');
+const {addHook} = require('pirates');
+const path = require('path');
+const fs = require('fs');
+const diskCache = require('./disk-cache');
+
+function compile(sourceMapManager, cache, options, code, filename) {
+  const opts = new OptionManager().init({
+    sourceRoot: path.dirname(filename) + path.sep,
+    ...options,
+    filename,
+  });
+
+  // Bail out ASAP if the file has been ignored.
+  if (opts === null) {
+    return code;
+  }
+
+  let output = cache[filename];
+
+  if (!output || output.mtime !== mtime(filename)) {
+    output = babel.transformSync(code, {
+      ...opts,
+      sourceMaps: opts.sourceMaps === undefined ? 'both' : opts.sourceMaps,
+      ast: false,
+    });
+
+    cache[filename] = output;
+    output.mtime = mtime(filename);
+  }
+
+  if (!sourceMapManager.isInstalled) {
+    sourceMapManager.install();
+  }
+
+  if (output.map) {
+    sourceMapManager.maps[filename] = output.map;
+  }
+
+  return output.code;
+}
+
+function mtime(filename) {
+  return +fs.statSync(filename).mtime;
+}
+
+function withBabelRegister(options, fn) {
+  let revertHook;
+  /**
+   * TODO: Do source maps break when we use a require hook
+   * to before we initialize the ESLint plugin?
+   */
+  const sourceMapManager = {
+    isInstalled: false,
+    maps: {},
+    install() {
+      if (sourceMapManager.isInstalled) {
+        return;
+      }
+      sourceMapManager.isInstalled = true;
+      sourceMapSupport.install({
+        handleUncaughtExceptions: true,
+        environment: 'node',
+        retrieveSourceMap(filename) {
+          const map = sourceMapManager.maps && sourceMapManager.maps[filename];
+          if (map) {
+            return {
+              url: null,
+              map: map,
+            };
+          } else {
+            return null;
+          }
+        },
+      });
+    },
+  };
+
+  diskCache.load();
+  const cache = diskCache.get();
+
+  try {
+    revertHook = addHook(
+      (code, filename) => {
+        return compile(sourceMapManager, cache, options, code, filename);
+      },
+      {
+        exts: DEFAULT_EXTENSIONS,
+        ignoreNodeModules: false,
+      },
+    );
+    return fn();
+  } finally {
+    revertHook();
+  }
+}
+
+module.exports = withBabelRegister;