initial commit

Author: stevensacks

.editorconfig

@@ -0,0 +1,18 @@
+# editorconfig.org
+
+root = true
+
+# We recommend to keep these unchanged
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.eslintignore

@@ -0,0 +1,2 @@
+commitlint.config.js
+.eslintrc.js

.eslintrc.js

@@ -0,0 +1,40 @@
+module.exports = {
+    root: true,
+    "env": {
+        "es2021": true,
+        "node": true
+    },
+    extends: [
+        "eslint:recommended",
+        "plugin:eslint-plugin/recommended",
+        "plugin:node/recommended",
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+        "indent": [
+            "error",
+            4
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    },
+    overrides: [
+        {
+            files: ["tests/**/*.js"],
+            env: { mocha: true }
+        }
+    ]
+}

.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.thumbs.db
+node_modules
+npm-debug.log*
+
+# Editor directories and files
+.vs
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln

.prettierignore

@@ -0,0 +1,6 @@
+package-lock.json
+.editorconfig
+.gitignore
+.stylelintignore
+.eslintignore
+.prettierignore

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "tabWidth": 4
+}

README.md

@@ -1,2 +1,40 @@
 # eslint-plugin-sort-react-dependency-arrays
-ESLint plugin to alphabetically sort React hook dependency arrays
+ESLint plugin to enforce alphabetically sorted React hook dependency arrays.
+
+Works with --fix.
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-sort-react-dependency-arrays`:
+
+```sh
+npm install eslint-plugin-sort-react-dependency-arrays --save-dev
+```
+
+## Usage
+
+Add `sort-react-dependency-arrays` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": [
+        "sort-react-dependency-arrays"
+    ]
+}
+```
+
+Then configure the rule under the rules section.
+
+```json
+{
+    "rules": {
+        "sort-react-dependency-arrays/sort-react-dependency-arrays": 2
+    }
+}
+```

lib/index.js

@@ -0,0 +1,23 @@
+/**
+ * @fileoverview Sort React dependency arrays with autofix
+ * @author Steven Sacks
+ */
+
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require('requireindex');
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + '/rules');
+
+
+

lib/rules/sort-react-dependency-arrays.js

@@ -0,0 +1,56 @@
+/**
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+const HOOKS = ['useCallback', 'useEffect', 'useLayoutEffect', 'useMemo'];
+
+function isDependencyArrayHook(node) {
+    if (node.type === 'Identifier') {
+        return HOOKS.includes(node.name);
+    }
+    return false;
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+    meta: {
+        type: 'suggestion',
+        fixable: 'code',
+        docs: {
+            category: 'Stylistic Issues',
+            description: 'require react dependency arrays to be sorted',
+            recommended: false,
+            url: 'https://github.com/stevensacks/eslint-plugin-sort-react-dependency-arrays'
+        },
+        schema: [] // no options
+    },
+    create: function(context) {
+        return {
+            CallExpression(node) {
+                if (isDependencyArrayHook(node.callee)) {
+                    const dependencies = node.arguments[1];
+
+                    if (dependencies && dependencies.type === 'ArrayExpression' && dependencies.elements.length > 1) {
+                        const sorted = [...dependencies.elements].sort((a, b) => (a.name < b.name ? -1 : 1));
+                        const sortedNames = sorted.map((dep) => dep.name);
+
+                        context.report({
+                            node,
+                            message: 'Sorting dependencies',
+                            fix: function (fixer) {
+                                return fixer.replaceText(dependencies, `[${sortedNames}]`);
+                            }
+                        });
+                    }
+                }
+            }
+        };
+    }
+};