feat: Init eslint-plugin-react-native

Author: Simoon-F

.editorconfig

@@ -0,0 +1,16 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc.js

@@ -0,0 +1,28 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  env: {
+    es2022: true,
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  rules: {
+    "node/no-unpublished-require": ["error", {
+      "allowModules": ["requireindex"]
+    }]
+  },
+  overrides: [
+    {
+      files: ["tests/**/*.js"],
+      env: { mocha: true },
+    },
+  ],
+};

.gitignore

@@ -0,0 +1 @@
+/node_modules

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "EditorConfig.EditorConfig"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "editor.quickSuggestions": {
+    "strings": true
+  },
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "prettier.requireConfig": true
+}

README.md

@@ -0,0 +1,36 @@
+# @sj-distributor/eslint-plugin-react-native
+
+ESLint presets for react native
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+yarn add eslint
+
+or
+
+npm i eslint --save-dev
+```
+
+Next, install `@sj-distributor/eslint-plugin-react-native`:
+
+```sh
+
+yarn add @sj-distributor/eslint-plugin-react-native
+
+or
+
+npm install @sj-distributor/eslint-plugin-react-native --save-dev
+```
+
+## Usage
+
+Add `eslint-plugin-react-native` to the plugins section of your `.eslintrc` configuration file:
+
+```json
+{
+  "plugins": ["@sj-distributor/eslint-plugin-react-native/recommended"]
+}
+```

configs/.eslintrc.json

@@ -0,0 +1,66 @@
+{
+  "env": {
+    "es2022": true,
+    "browser": true,
+    "react-native/react-native": true
+  },
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": "latest",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "react",
+    "react-native",
+    "simple-import-sort",
+    "unicorn",
+    "import"
+  ],
+  "rules": {
+    "camelcase": "error",
+    "spaced-comment": "error",
+    "import/extensions": "off",
+    "import/no-unresolved": "off",
+    "no-duplicate-imports": "error",
+    "react/react-in-jsx-scope": "off",
+    "react-hooks/rules-of-hooks": "error",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "unicorn/filename-case": [
+      "error",
+      {
+        "cases": {
+          "kebabCase": true,
+          "camelCase": false,
+          "snakeCase": false,
+          "pascalCase": false
+        }
+      }
+    ],
+    "react-hooks/exhaustive-deps": [
+      "error",
+      {
+        "additionalHooks": "(useMyCustomHook|useMyOtherCustomHook|useRecoilCallback)"
+      }
+    ]
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".jsx", ".ts", ".tsx"]
+      }
+    },
+    "react": {
+      "version": "detect"
+    }
+  }
+}

docs/rules/demo.md

@@ -0,0 +1,31 @@
+# demo example (demo)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+// fill me in
+```
+
+Examples of **correct** code for this rule:
+
+```js
+// fill me in
+```
+
+### Options
+
+If there are any options, describe them here. Otherwise, delete this section.
+
+## When Not To Use It
+
+Give a short description of when it would be appropriate to turn off this rule.
+
+## Further Reading
+
+If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

lib/index.js

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview ESLint presets for react native
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+const eslintrc = require("../configs/.eslintrc.json");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+module.exports = {
+  // 引入所有的自定义的规则
+  rules: requireIndex(__dirname + "/rules"),
+  configs: {
+    recommended: eslintrc
+  },
+}
+
+

lib/rules/demo.js

@@ -0,0 +1,43 @@
+/* eslint-disable no-unused-vars */
+
+/**
+ * @fileoverview demo example
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    messages: "demo example",
+    type: 'suggestion', // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "demo example",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [], // Add a schema if the rule has options
+  },
+
+  create(context) {
+    // variables should be defined here
+
+    //----------------------------------------------------------------------
+    // Helpers
+    //----------------------------------------------------------------------
+
+    // any helper functions should go here or else delete this section
+
+    //----------------------------------------------------------------------
+    // Public
+    //----------------------------------------------------------------------
+
+    return {
+      // visitor functions for different types of nodes
+    };
+  },
+};