feat: @lexical/eslint-plugin - add a rules-of-lexical linter to help …

…with $function rules

.eslintrc.js

@@ -11,6 +11,7 @@
 const restrictedGlobals = require('confusing-browser-globals');
 
 const OFF = 0;
+const WARN = 1;
 const ERROR = 2;
 
 module.exports = {
@@ -64,6 +65,7 @@ module.exports = {
         'eslint:recommended',
         'plugin:@typescript-eslint/eslint-recommended',
         'plugin:@typescript-eslint/recommended',
+        'plugin:@lexical/all',
       ],
       files: ['**/*.ts', '**/*.tsx'],
       parser: '@typescript-eslint/parser',
@@ -72,15 +74,28 @@ module.exports = {
       },
       plugins: ['react', '@typescript-eslint', 'header'],
       rules: {
+        '@lexical/rules-of-lexical': [
+          WARN,
+          /** @type import('./packages/lexical-eslint-plugin/src').RulesOfLexicalOptions */ ({
+            isDollarFunction: ['^INTERNAL_\\$'],
+            isIgnoredFunction: [
+              // @lexical/yjs
+              'createBinding',
+            ],
+            isSafeDollarFunction: '$createRootNode',
+          }),
+        ],
         '@typescript-eslint/ban-ts-comment': OFF,
         '@typescript-eslint/no-this-alias': OFF,
         '@typescript-eslint/no-unused-vars': [ERROR, {args: 'none'}],
         'header/header': [2, 'scripts/www/headerTemplate.js'],
       },
     },
     {
-      // These aren't compiled, but they're written in module JS
-      files: ['packages/lexical-playground/esm/*.mjs'],
+      files: [
+        // These aren't compiled, but they're written in module JS
+        'packages/lexical-playground/esm/*.mjs',
+      ],
       parserOptions: {
         sourceType: 'module',
       },
@@ -119,6 +134,7 @@ module.exports = {
     'react',
     'no-only-tests',
     'lexical',
+    '@lexical',
   ],
 
   // Stop ESLint from looking for a configuration file in parent folders

.flowconfig

@@ -24,6 +24,7 @@ module.name_mapper='^@lexical/clipboard$' -> '<PROJECT_ROOT>/packages/lexical-cl
 module.name_mapper='^@lexical/code$' -> '<PROJECT_ROOT>/packages/lexical-code/flow/LexicalCode.js.flow'
 module.name_mapper='^@lexical/devtools-core$' -> '<PROJECT_ROOT>/packages/lexical-devtools-core/flow/LexicalDevtoolsCore.js.flow'
 module.name_mapper='^@lexical/dragon$' -> '<PROJECT_ROOT>/packages/lexical-dragon/flow/LexicalDragon.js.flow'
+module.name_mapper='^@lexical/eslint-plugin$' -> '<PROJECT_ROOT>/packages/lexical-eslint-plugin/flow/LexicalEslintPlugin.js.flow'
 module.name_mapper='^@lexical/file$' -> '<PROJECT_ROOT>/packages/lexical-file/flow/LexicalFile.js.flow'
 module.name_mapper='^@lexical/hashtag$' -> '<PROJECT_ROOT>/packages/lexical-hashtag/flow/LexicalHashtag.js.flow'
 module.name_mapper='^@lexical/headless$' -> '<PROJECT_ROOT>/packages/lexical-headless/flow/LexicalHeadless.js.flow'

eslint-plugin/package.json

@@ -4,6 +4,6 @@
   "description": "ESLint plugin for lexical",
   "main": "src/index.js",
   "peerDependencies": {
-    "eslint": ">=4.19.1"
+    "eslint": "^7.31.0 || ^8.0.0"
   }
 }

package.json

@@ -114,6 +114,7 @@
     "@babel/preset-flow": "^7.14.5",
     "@babel/preset-react": "^7.14.5",
     "@babel/preset-typescript": "^7.16.7",
+    "@lexical/eslint-plugin": "file:./packages/lexical-eslint-plugin",
     "@playwright/test": "^1.41.2",
     "@rollup/plugin-alias": "^3.1.4",
     "@rollup/plugin-babel": "^5.3.0",

packages/lexical-devtools/tsconfig.json

@@ -14,6 +14,7 @@
       "@lexical/code": ["../lexical-code/src/index.ts"],
       "@lexical/devtools-core": ["../lexical-devtools-core/src/index.ts"],
       "@lexical/dragon": ["../lexical-dragon/src/index.ts"],
+      "@lexical/eslint-plugin": ["../lexical-eslint-plugin/src/index.ts"],
       "@lexical/file": ["../lexical-file/src/index.ts"],
       "@lexical/hashtag": ["../lexical-hashtag/src/index.ts"],
       "@lexical/headless": ["../lexical-headless/src/index.ts"],

packages/lexical-eslint-plugin/LexicalEslintPlugin.js

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ *
+ */
+
+'use strict';
+// This file is here for bootstrapping reasons so we can use it without
+// building anything and still comply with the monorepo conventions
+module.exports = require('./src/LexicalEslintPlugin.js');