fix: Fix rules and publishing (#6)

* ESLint

* Import alias test

* Docs

* Fix rules and config

* Alias test

* Use key as sorted element

* Add main field

* Fix rules

Author: mskelton

.eslintignore

@@ -0,0 +1 @@
+lib/

.eslintrc

@@ -8,8 +8,8 @@
   },
   "extends": [
     "eslint:recommended",
-    "plugin:prettier/recommended",
     "plugin:@typescript-eslint/recommended",
+    "prettier",
     "prettier/@typescript-eslint"
   ],
   "parser": "@typescript-eslint/parser",

README.md

@@ -1,20 +1,76 @@
 # eslint-plugin-sort
 
 [![Build status](https://github.com/mskelton/eslint-plugin-sort/workflows/Build/badge.svg)](https://github.com/mskelton/eslint-plugin-sort/actions)
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors)
+[![npm](https://img.shields.io/npm/v/eslint-plugin-sort)](https://www.npmjs.com/package/eslint-plugin-sort)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors)
 
 > Autofixable sort rules for ESLint.
 
 ## Installation
 
 ```sh
+# npm
 npm install -D eslint-plugin-sort
+
+# Yarn
+yarn add -D eslint-plugin-sort
 ```
 
 ## Usage
 
-// TODO
+After installing, add `sort` to your list of ESLint plugins and extend the recommended configuration. This will enable all available rules as warnings.
+
+```json
+{
+  "extends": ["plugin:sort/recommended"],
+  "plugins": ["sort"]
+}
+```
+
+## Rules
+
+While the recommended configuration is the simplest way to use this plugin, you can also configure the rules manually based on your needs.
+
+### `sort/destructured-properties` 🔧
+
+Sorts properties in object destructuring patterns.
+
+Examples of **incorrect** code for this rule.
+
+```js
+let { b, c, a } = {}
+let { C, b } = {}
+let { b: a, a: b } = {}
+```
+
+Examples of **correct** code for this rule.
+
+```js
+let { a, b, c } = {}
+let { b, C } = {}
+let { a: b, b: a } = {}
+```
+
+### `sort/imported-variables` 🔧
+
+Sorts imported variable names alphabetically and case insensitive.
+
+Examples of **incorrect** code for this rule.
+
+```js
+import { b, c, a } from "a"
+import { C, b } from "a"
+import { b as a, a as b } from "a"
+```
+
+Examples of **correct** code for this rule.
+
+```js
+import { a, b, c } from "a"
+import { b, C } from "a"
+import { a as b, b as a } from "a"
+```
 
 ## Contributors ✨
 

package-lock.json

@@ -18,6 +18,7 @@
     "sort",
     "fix"
   ],
+  "main": "lib/index.js",
   "files": [
     "lib"
   ],
@@ -38,9 +39,10 @@
     "@types/eslint": "^6.8.0",
     "@types/node": "^13.13.2",
     "@typescript-eslint/eslint-plugin": "^2.29.0",
+    "@typescript-eslint/parser": "^2.29.0",
     "babel-jest": "^25.4.0",
     "eslint": "^6.8.0",
-    "eslint-plugin-prettier": "^3.1.3",
+    "eslint-config-prettier": "^6.11.0",
     "jest": "^25.4.0",
     "prettier": "^2.0.5",
     "typescript": "^3.8.3"

package.json

@@ -43,7 +43,7 @@ ruleTester.run("sort/imported-variables", rule, {
     valid("* as React"),
     valid("React, {a, b}"),
 
-    //
+    // Import aliases
     valid("{a as b, b as a}"),
 
     // Comments
@@ -89,6 +89,14 @@ ruleTester.run("sort/imported-variables", rule, {
       error("a", "c")
     ),
 
+    // Import aliases
+    invalid(
+      "{b as a, a as b}",
+      "{a as b, b as a}",
+      messages.unsortedSpecifiers,
+      error("a", "b")
+    ),
+
     // All properties are sorted with a single sort
     invalid(
       "{z,y,x,w,v,u,t,s,r,q,p}",

src/__tests__/sort-import-specifiers.spec.ts

@@ -41,6 +41,9 @@ ruleTester.run("sort/destructured-properties", rule, {
     valid("{a, B, c, D}"),
     valid("{_, A, b}"),
 
+    // Aliases
+    valid("{a: b, b: a}"),
+
     // Rest element
     valid("{a, b, ...c}"),
     valid("{...rest}"),
@@ -80,6 +83,14 @@ ruleTester.run("sort/destructured-properties", rule, {
       error("B", "c")
     ),
 
+    // Aliases
+    invalid(
+      "{b: a, a: b}",
+      "{a: b, b: a}",
+      messages.unsortedPattern,
+      error("a", "b")
+    ),
+
     // Rest element
     invalid(
       "{c, a, b, ...rest}",

src/__tests__/sort-object-patterns.spec.ts

@@ -1,24 +1,24 @@
-import sortImports from "./rules/sort-imports"
-import sortImportSpecifiers from "./rules/sort-imports"
+// import sortImports from "./rules/sort-imports"
+import sortImportSpecifiers from "./rules/sort-import-specifiers"
 import sortObjectPatterns from "./rules/sort-object-patterns"
-import sortObjectProperties from "./rules/sort-object-properties"
+// import sortObjectProperties from "./rules/sort-object-properties"
 
 module.exports = {
   configs: {
     recommended: {
       plugins: ["sort"],
       rules: {
-        "sort/imports": "warn",
-        "sort/imported-variables": "warn",
         "sort/destructured-properties": "warn",
-        "sort/object-properties": "warn",
+        "sort/imported-variables": "warn",
+        // "sort/imports": "warn",
+        // "sort/object-properties": "warn",
       },
     },
   },
   rules: {
-    "sort/imports": sortImports,
-    "sort/imported-variables": sortImportSpecifiers,
-    "sort/destructured-properties": sortObjectPatterns,
-    "sort/object-properties": sortObjectProperties,
+    "destructured-properties": sortObjectPatterns,
+    "imported-variables": sortImportSpecifiers,
+    // "imports": sortImports,
+    // "object-properties": sortObjectProperties,
   },
 }

src/index.ts

@@ -15,7 +15,7 @@ import {
 type Property = AssignmentProperty | RestElement
 
 function getNodeText(node: AssignmentProperty) {
-  return (node.value as Identifier).name
+  return (node.key as Identifier).name
 }
 
 function getNodeSortValue(node: Property) {