chore: tweak lint config to allow for eslint --fix to fix import or…

…der (#1827)

lint-configs/.eslintrc.js

@@ -247,6 +247,23 @@ module.exports = {
           },
         ],
 
+        // Rules about import ordering/sorting
+        'import/order': ['error', {
+          'groups': [
+            'builtin',
+            'external',
+            'internal',
+            ['parent', 'sibling', 'index'],
+            'object',
+            'type'
+          ],
+          'newlines-between': 'always',
+          'alphabetize': {
+            'order': 'asc',
+            'caseInsensitive': true
+          }
+        }],
+        'sort-imports': ['error', { 'ignoreDeclarationSort': true }],
         // Allow cyclical imports. Turning this rule on is mainly a way to manage the performance concern for linting
         // time. Our projects are not large enough to warrant this. Overrides AirBnB styles.
         'import/no-cycle': 'off',

packages/cli-test/package.json

@@ -21,7 +21,7 @@
     "url": "https://github.com/slackapi/node-slack-sdk/issues"
   },
   "scripts": {
-    "lint": "eslint --ext .ts src",
+    "lint": "eslint --fix --ext .ts src",
     "build": "npm run build:clean && tsc",
     "build:clean": "shx rm -rf ./dist ./coverage",
     "prepare": "npm run build",

packages/cli-test/src/cli/cli-process.spec.ts

@@ -1,7 +1,8 @@
 import { assert } from 'chai';
 import sinon from 'sinon';
-import { shell } from './shell';
+
 import { SlackCLIProcess } from './cli-process';
+import { shell } from './shell';
 
 describe('SlackCLIProcess class', () => {
   const sandbox = sinon.createSandbox();

packages/cli-test/src/cli/cli-process.ts

@@ -1,6 +1,7 @@
-import type { SpawnOptionsWithoutStdio } from 'node:child_process';
 import { shell } from './shell';
+
 import type { ShellProcess } from '../utils/types';
+import type { SpawnOptionsWithoutStdio } from 'node:child_process';
 /*
  * some parameters used in the 'shell' calls that are CLI-specific and probably should not exist there:
   * @param skipUpdate skip auto update notification

packages/cli-test/src/cli/commands/auth.ts

@@ -1,7 +1,8 @@
-import type { ShellProcess } from '../../utils/types';
-import { SlackCLIProcess, SlackCLIGlobalOptions, SlackCLICommandOptions } from '../cli-process';
+import { SlackCLICommandOptions, SlackCLIGlobalOptions, SlackCLIProcess } from '../cli-process';
 import commandError from '../command-error';
 
+import type { ShellProcess } from '../../utils/types';
+
 export default {
   /**
    *  `slack login --no-prompt`

packages/cli-test/src/cli/commands/create.ts

@@ -1,5 +1,6 @@
 import { SpawnOptionsWithoutStdio } from 'node:child_process';
-import { SlackCLIProcess, SlackCLICommandOptions, SlackCLIGlobalOptions } from '../cli-process';
+
+import { SlackCLICommandOptions, SlackCLIGlobalOptions, SlackCLIProcess } from '../cli-process';
 import commandError from '../command-error';
 
 /**

packages/cli-test/src/cli/commands/platform.ts

@@ -1,9 +1,10 @@
+import { SlackTracerId } from '../../utils/constants';
 import logger from '../../utils/logger';
 import { SlackCLIProcess } from '../cli-process';
+import commandError from '../command-error';
 import { shell } from '../shell';
+
 import type { ShellProcess } from '../../utils/types';
-import commandError from '../command-error';
-import { SlackTracerId } from '../../utils/constants';
 
 // TODO: the options for these methods could be DRYed up
 

packages/cli-test/src/cli/index.spec.ts

@@ -1,6 +1,7 @@
 import sinon from 'sinon';
-import logger from '../utils/logger';
+
 import { SlackCLI } from './index';
+import logger from '../utils/logger';
 
 describe('cli module', () => {
   const sandbox = sinon.createSandbox();

packages/cli-test/src/cli/index.ts

@@ -1,6 +1,6 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-import logger from '../utils/logger';
+
 import appCommands from './commands/app';
 import authCommands from './commands/auth';
 import collaboratorCommands from './commands/collaborator';
@@ -11,6 +11,7 @@ import functionCommands from './commands/function';
 import manifestCommands from './commands/manifest';
 import platformCommands from './commands/platform';
 import triggerCommands from './commands/trigger';
+import logger from '../utils/logger';
 
 /**
  * Set of functions to spawn and interact with Slack Platform CLI processes and commands

packages/cli-test/src/cli/shell.spec.ts

@@ -1,9 +1,12 @@
-import { assert } from 'chai';
-import sinon from 'sinon';
 import child from 'child_process';
-import stream from 'stream';
 import EventEmitter from 'events';
+import stream from 'stream';
+
+import { assert } from 'chai';
+import sinon from 'sinon';
+
 import { shell } from './shell';
+
 import type { ShellProcess } from '../utils/types';
 
 describe('shell module', () => {

packages/cli-test/src/cli/shell.ts

@@ -1,7 +1,10 @@
 import child from 'child_process';
+
 import treekill from 'tree-kill';
-import logger from '../utils/logger';
+
 import { timeouts } from '../utils/constants';
+import logger from '../utils/logger';
+
 import type { ShellProcess } from '../utils/types';
 
 export const shell = {

packages/cli-test/src/index.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from 'chai';
 import sinon from 'sinon';
+
 import { SlackCLI, SlackTracerId } from '.';
 
 describe('main module', () => {

packages/cli-test/src/utils/logger.ts

@@ -1,4 +1,4 @@
-import { createLogger, format, transports, Logger } from 'winston';
+import { Logger, createLogger, format, transports } from 'winston';
 
 // Configure CLI log level
 // Winston logging levels, see: https://github.com/winstonjs/winston#logging

packages/logger/package.json

@@ -29,7 +29,7 @@
     "prepare": "npm run build",
     "build": "npm run build:clean && tsc",
     "build:clean": "shx rm -rf ./dist ./coverage",
-    "lint": "eslint --ext .ts src",
+    "lint": "eslint --fix --ext .ts src",
     "mocha": "mocha --config .mocharc.json src/*.spec.js",
     "test:unit": "npm run build && npm run mocha",
     "test": "npm run lint && npm run coverage",

packages/oauth/src/callback-options.spec.ts

@@ -1,7 +1,8 @@
+import { IncomingMessage, ServerResponse } from 'http';
+
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
 import sinon from 'sinon';
-import { IncomingMessage, ServerResponse } from 'http';
 
 import { CallbackOptions, escapeHtml } from './callback-options';
 import { MissingStateError } from './errors';

packages/oauth/src/callback-options.ts

@@ -1,4 +1,5 @@
 import { IncomingMessage, ServerResponse } from 'http';
+
 import { CodedError, ErrorCode } from './errors';
 import { InstallURLOptions } from './install-url-options';
 import { Installation, OrgInstallation } from './installation';

packages/oauth/src/install-path-options.spec.ts

@@ -1,7 +1,8 @@
+import { IncomingMessage, ServerResponse } from 'http';
+
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
 import sinon from 'sinon';
-import { IncomingMessage, ServerResponse } from 'http';
 
 import { InstallPathOptions } from './install-path-options';
 

packages/oauth/src/install-path-options.ts

@@ -1,4 +1,5 @@
 import { IncomingMessage, ServerResponse } from 'http';
+
 import { InstallURLOptions } from './install-url-options';
 
 /**

packages/oauth/src/install-provider-options.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
+
 import { InstallProviderOptions } from './install-provider-options';
 
 describe('InstallProviderOptions', async () => {

packages/oauth/src/install-provider-options.ts

@@ -1,8 +1,9 @@
-import { Logger, LogLevel } from '@slack/logger';
+import { LogLevel, Logger } from '@slack/logger';
 import { WebClientOptions } from '@slack/web-api';
-import { StateStore } from './state-stores';
-import { InstallationStore } from './installation-stores';
+
 import { InstallURLOptions } from './install-url-options';
+import { InstallationStore } from './installation-stores';
+import { StateStore } from './state-stores';
 
 export interface InstallProviderOptions {
 

packages/oauth/src/install-provider.ts

@@ -1,30 +1,30 @@
 import { IncomingMessage, ServerResponse } from 'http';
-import { URLSearchParams, URL } from 'url';
+import { URL, URLSearchParams } from 'url';
 
 import { WebAPICallResult, WebClient, WebClientOptions } from '@slack/web-api';
 
 import { AuthorizeResult } from './authorize-result';
 import { CallbackOptions, defaultCallbackFailure, defaultCallbackSuccess } from './callback-options';
+import defaultRenderHtmlForInstallPath from './default-render-html-for-install-path';
 import {
-  InstallerInitializationError,
-  UnknownError,
-  MissingStateError,
-  InvalidStateError,
-  MissingCodeError,
-  GenerateInstallUrlError,
   AuthorizationError,
   CodedError,
   ErrorCode,
+  GenerateInstallUrlError,
+  InstallerInitializationError,
+  InvalidStateError,
+  MissingCodeError,
+  MissingStateError,
+  UnknownError,
 } from './errors';
+import { InstallPathOptions } from './install-path-options';
+import { InstallProviderOptions } from './install-provider-options';
+import { InstallURLOptions } from './install-url-options';
 import { Installation } from './installation';
 import { InstallationQuery } from './installation-query';
-import { InstallURLOptions } from './install-url-options';
-import { InstallProviderOptions } from './install-provider-options';
-import { Logger, LogLevel, getLogger } from './logger';
-import { ClearStateStore, StateStore } from './state-stores';
 import { InstallationStore, MemoryInstallationStore } from './installation-stores';
-import defaultRenderHtmlForInstallPath from './default-render-html-for-install-path';
-import { InstallPathOptions } from './install-path-options';
+import { LogLevel, Logger, getLogger } from './logger';
+import { ClearStateStore, StateStore } from './state-stores';
 
 /**
  * InstallProvider Class. Refer to InsallProviderOptions interface for the details of constructor arguments.

packages/oauth/src/install-url-options.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
+
 import { InstallURLOptions } from './install-url-options';
 
 describe('InstallURLOptions', async () => {

packages/oauth/src/installation-query.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
+
 import { InstallationQuery } from './installation-query';
 
 describe('InstallationQuery', async () => {

packages/oauth/src/installation-stores/file-store.ts

@@ -1,7 +1,8 @@
 import fs from 'fs';
-import path from 'path';
 import { homedir } from 'os';
-import { Installation, InstallationStore, InstallationQuery } from '../index';
+import path from 'path';
+
+import { Installation, InstallationQuery, InstallationStore } from '../index';
 import { Logger } from '../logger';
 
 export interface FileInstallationOptions {

packages/oauth/src/installation-stores/interface.ts

@@ -1,4 +1,5 @@
 import { Logger } from '@slack/logger';
+
 import { Installation, InstallationQuery } from '..';
 
 export interface InstallationStore {

packages/oauth/src/installation-stores/memory-store.ts

@@ -1,4 +1,4 @@
-import { Installation, InstallationStore, InstallationQuery, OrgInstallation } from '../index';
+import { Installation, InstallationQuery, InstallationStore, OrgInstallation } from '../index';
 import { Logger } from '../logger';
 
 // using a javascript object as a makeshift database for development

packages/oauth/src/installation.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from 'chai';
 import { describe, it } from 'mocha';
+
 import { Installation } from './installation';
 
 describe('Installation', async () => {

packages/oauth/src/logger.ts

@@ -1,4 +1,4 @@
-import { Logger, LogLevel, ConsoleLogger } from '@slack/logger';
+import { ConsoleLogger, LogLevel, Logger } from '@slack/logger';
 
 export { Logger, LogLevel } from '@slack/logger';
 

packages/oauth/src/state-stores/clear-state-store.ts

@@ -1,7 +1,8 @@
 import { sign, verify } from 'jsonwebtoken';
-import { InstallURLOptions } from '../install-url-options';
-import { StateStore, StateObj } from './interface';
+
+import { StateObj, StateStore } from './interface';
 import { InvalidStateError } from '../errors';
+import { InstallURLOptions } from '../install-url-options';
 
 // default implementation of StateStore
 export default class ClearStateStore implements StateStore {

packages/oauth/src/state-stores/file-state-store.spec.ts

@@ -1,4 +1,5 @@
 import os from 'os';
+
 import { FileStateStore } from './file-state-store';
 import { StateStoreChaiTestRunner } from './spec-utils';
 

packages/oauth/src/state-stores/file-state-store.ts

@@ -1,10 +1,12 @@
-import { homedir } from 'os';
 import fs from 'fs';
+import { homedir } from 'os';
 import path from 'path';
+
 import { ConsoleLogger, Logger } from '@slack/logger';
-import { StateStore, StateObj } from './interface';
-import { InstallURLOptions } from '../install-url-options';
+
+import { StateObj, StateStore } from './interface';
 import { InvalidStateError } from '../errors';
+import { InstallURLOptions } from '../install-url-options';
 
 export interface FileStateStoreArgs {
   stateExpirationSeconds?: number;

packages/oauth/src/state-stores/spec-utils.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable import/no-extraneous-dependencies */
 import { assert } from 'chai';
+
 import { StateStore } from './interface';
 import { InstallURLOptions } from '../install-url-options';
 

packages/rtm-api/src/KeepAlive.ts

@@ -1,7 +1,8 @@
 import { EventEmitter } from 'eventemitter3';
-import { RTMClient } from './RTMClient';
+
+import { CodedError, ErrorCode } from './errors';
 import { LogLevel, Logger, getLogger } from './logger';
-import { ErrorCode, CodedError } from './errors';
+import { RTMClient } from './RTMClient';
 
 export interface KeepAliveOptions {
   logger?: Logger;