working draft

Author: infctr

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+quote_type = single

.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  parserOptions: {
+    sourceType: 'script',
+  },
+  extends: [
+    'airbnb-base',
+    'prettier/standard',
+    'plugin:prettier/recommended',
+    'plugin:node/recommended',
+  ],
+  rules: {
+    'object-shorthand': 0,
+  },
+};

.gitignore

@@ -0,0 +1,80 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/

.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  trailingComma: 'all',
+};

README.md

@@ -0,0 +1,43 @@
+# eslint-plugin-typescript-sort-keys
+
+Sort interface keys
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-typescript-sort-keys`:
+
+```
+$ npm install eslint-plugin-typescript-sort-keys --save-dev
+```
+
+**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-typescript-sort-keys` globally.
+
+## Usage
+
+Add `typescript-sort-keys` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+  "plugins": ["typescript-sort-keys"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "typescript-sort-keys/rule-name": 2
+  }
+}
+```
+
+## Supported Rules
+
+- Fill in provided rules here

lib/index.js

@@ -0,0 +1,20 @@
+/**
+ * @fileoverview Sort interface keys
+ * @author infctr
+ */
+
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require('requireindex');
+const path = require('path');
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(path.join(__dirname, 'rules'));

lib/rules/interface.js

@@ -0,0 +1,149 @@
+'use strict';
+
+const naturalCompare = require('natural-compare-lite');
+const astUtils = require('../utils/ast');
+
+/**
+ * Gets the property name of the given `Property` node.
+ *
+ * - If the property's key is an `Identifier` node, this returns the key's name
+ *   whether it's a computed property or not.
+ * - If the property has a static name, this returns the static name.
+ * - Otherwise, this returns null.
+ *
+ * @param {ASTNode} node - The `Property` node to get.
+ * @returns {string|null} The property name or null.
+ * @private
+ */
+function getPropertyName(node) {
+  return astUtils.getStaticPropertyName(node) || node.key.name || null;
+}
+
+/**
+ * Functions which check that the given 2 names are in specific order.
+ *
+ * Postfix `I` is meant insensitive.
+ * Postfix `N` is meant natural.
+ *
+ * @private
+ */
+const isValidOrders = {
+  asc(a, b) {
+    return a <= b;
+  },
+  ascI(a, b) {
+    return a.toLowerCase() <= b.toLowerCase();
+  },
+  ascN(a, b) {
+    return naturalCompare(a, b) <= 0;
+  },
+  ascIN(a, b) {
+    return naturalCompare(a.toLowerCase(), b.toLowerCase()) <= 0;
+  },
+  desc(a, b) {
+    return isValidOrders.asc(b, a);
+  },
+  descI(a, b) {
+    return isValidOrders.ascI(b, a);
+  },
+  descN(a, b) {
+    return isValidOrders.ascN(b, a);
+  },
+  descIN(a, b) {
+    return isValidOrders.ascIN(b, a);
+  },
+};
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+
+    docs: {
+      description: 'require interface keys to be sorted',
+      category: 'Stylistic Issues',
+      recommended: false,
+      url: 'https://eslint.org/docs/rules/sort-keys', // TODO
+    },
+    // fixable: 'code',
+
+    schema: [
+      {
+        enum: ['asc', 'desc'],
+      },
+      {
+        type: 'object',
+        properties: {
+          caseSensitive: {
+            type: 'boolean',
+          },
+          natural: {
+            type: 'boolean',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create: function create(context) {
+    // Parse options.
+    const order = context.options[0] || 'asc';
+    const options = context.options[1];
+    const insensitive = (options && options.caseSensitive) === false;
+    const natural = Boolean(options && options.natural);
+    const computedOrder = [order, insensitive && 'I', natural && 'N']
+      .filter(Boolean)
+      .join('');
+    const isValidOrder = isValidOrders[computedOrder];
+
+    // The stack to save the previous property's name for each object literals.
+    let stack = null;
+
+    const visitor = node => {
+      const { prevName } = stack;
+      const thisName = getPropertyName(node);
+
+      stack.prevName = thisName || prevName;
+
+      if (!prevName || !thisName) {
+        return;
+      }
+
+      if (!isValidOrder(prevName, thisName)) {
+        context.report({
+          node,
+          loc: node.key.loc,
+          message:
+            "Expected interface keys to be in {{natural}}{{insensitive}}{{order}}ending order. '{{thisName}}' should be before '{{prevName}}'.",
+          data: {
+            thisName,
+            prevName,
+            order,
+            insensitive: insensitive ? 'insensitive ' : '',
+            natural: natural ? 'natural ' : '',
+          },
+        });
+      }
+    };
+
+    return {
+      TSInterfaceDeclaration() {
+        stack = {
+          upper: stack,
+          prevName: null,
+        };
+      },
+
+      'TSInterfaceDeclaration:exit'() {
+        stack = stack.upper;
+      },
+
+      TSPropertySignature(node) {
+        return visitor(node);
+      },
+
+      TSMethodSignature(node) {
+        return visitor(node);
+      },
+    };
+  },
+};