build: add eslint sort import rule (#767)

.eslintrc.js

@@ -264,6 +264,17 @@ module.exports = {
     'wrap-iife': 'off',
     'wrap-regex': 'off',
     'yield-star-spacing': 'off',
+    'import/order': [
+      'error',
+      {
+        alphabetize: {
+          order: 'asc',
+          caseInsensitive: false,
+        },
+        groups: ['builtin', 'external', 'parent', 'index', 'sibling'],
+        'newlines-between': 'always',
+      },
+    ],
   },
   env: {
     browser: false,

__tests__/functional/delta.nut.ts

@@ -1,8 +1,9 @@
 'use strict'
-import { expect } from '@salesforce/command/lib/test'
-import { execCmd } from '@salesforce/cli-plugins-testkit'
-import readline from 'readline'
 import fs from 'fs'
+import readline from 'readline'
+
+import { execCmd } from '@salesforce/cli-plugins-testkit'
+import { expect } from '@salesforce/command/lib/test'
 
 describe('sgd:source:delta NUTS', () => {
   it('run help', () => {

__tests__/functional/main.test.ts

@@ -1,7 +1,8 @@
 ;`use strict`
+import { expect, jest, describe, it } from '@jest/globals'
+
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const sgd = require('../../src/main')
-import { expect, jest, describe, it } from '@jest/globals'
 
 const mockValidateConfig = jest.fn()
 jest.mock('../../src/utils/cliHelper', () => {

__tests__/integration/services.test.ts

@@ -1,15 +1,16 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata } from '../__utils__/globalTestHelper'
+
 import {
   ADDITION,
   DELETION,
   MODIFICATION,
 } from '../../src/constant/gitConstants'
-import { readPathFromGit } from '../../src/utils/fsHelper'
-import { Work } from '../../src/types/work'
-import TypeHandlerFactory from '../../src/service/typeHandlerFactory'
 import { MetadataRepository } from '../../src/metadata/MetadataRepository'
+import TypeHandlerFactory from '../../src/service/typeHandlerFactory'
+import { Work } from '../../src/types/work'
+import { readPathFromGit } from '../../src/utils/fsHelper'
+import { getGlobalMetadata } from '../__utils__/globalTestHelper'
 
 jest.mock('../../src/utils/fsHelper')
 

__tests__/unit/lib/adapter/GitAdapter.test.ts

@@ -1,19 +1,20 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getWork } from '../../../__utils__/globalTestHelper'
-import { Config } from '../../../../src/types/config'
+import { readFile } from 'fs-extra'
+import { WalkerEntry, WalkerIterateCallback } from 'isomorphic-git'
+
 import GitAdapter, {
   contentWalker,
   diffLineWalker,
   filePathWalker,
   iterate,
 } from '../../../../src/adapter/GitAdapter'
+import { Config } from '../../../../src/types/config'
 import {
   getLFSObjectContentPath,
   isLFS,
 } from '../../../../src/utils/gitLfsHelper'
-import { readFile } from 'fs-extra'
-import { WalkerEntry, WalkerIterateCallback } from 'isomorphic-git'
+import { getWork } from '../../../__utils__/globalTestHelper'
 
 const mockedDirExists = jest.fn()
 const mockedFileExists = jest.fn()

__tests__/unit/lib/metadata/MetadataRepositoryImpl.test.ts

@@ -1,7 +1,8 @@
 'use strict'
 import { expect, describe, it } from '@jest/globals'
-import { MetadataRepositoryImpl } from '../../../../src/metadata/MetadataRepositoryImpl'
+
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { MetadataRepositoryImpl } from '../../../../src/metadata/MetadataRepositoryImpl'
 import { Metadata } from '../../../../src/types/metadata'
 
 describe('MetadataRepositoryImpl', () => {

__tests__/unit/lib/metadata/metadataManager.test.ts

@@ -1,5 +1,7 @@
 'use strict'
 import { expect, describe, it } from '@jest/globals'
+
+import { MetadataRepositoryImpl } from '../../../../src/metadata/MetadataRepositoryImpl'
 import {
   getDefinition,
   getInFileAttributes,
@@ -8,7 +10,6 @@ import {
   isVersionSupported,
 } from '../../../../src/metadata/metadataManager'
 import { Metadata } from '../../../../src/types/metadata'
-import { MetadataRepositoryImpl } from '../../../../src/metadata/MetadataRepositoryImpl'
 
 describe(`test if metadata`, () => {
   it('provide latest when apiVersion does not exist', async () => {

__tests__/unit/lib/post-processor/baseProcessor.test.ts

@@ -1,9 +1,10 @@
 'use strict'
 import { beforeAll, expect, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import BaseProcessor from '../../../../src/post-processor/baseProcessor'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 describe('BaseProcessor', () => {
   let work: Work, metadata: MetadataRepository

__tests__/unit/lib/post-processor/flowTranslationProcessor.test.ts

@@ -1,17 +1,18 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 import { pathExists } from 'fs-extra'
-import FlowTranslationProcessor from '../../../../src/post-processor/flowTranslationProcessor'
-import { parseXmlFileToJson } from '../../../../src/utils/fxpHelper'
+
 import {
   FLOW_XML_NAME,
   TRANSLATION_TYPE,
 } from '../../../../src/constant/metadataConstants'
-import { isSubDir, readFile, treatPathSep } from '../../../../src/utils/fsUtils'
-import { writeFile, readDir } from '../../../../src/utils/fsHelper'
-import { Work } from '../../../../src/types/work'
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import FlowTranslationProcessor from '../../../../src/post-processor/flowTranslationProcessor'
+import { Work } from '../../../../src/types/work'
+import { writeFile, readDir } from '../../../../src/utils/fsHelper'
+import { isSubDir, readFile, treatPathSep } from '../../../../src/utils/fsUtils'
+import { parseXmlFileToJson } from '../../../../src/utils/fxpHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('fs-extra')
 jest.mock('../../../../src/utils/fsHelper')

__tests__/unit/lib/post-processor/includeProcessor.test.ts

@@ -1,13 +1,14 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import IncludeProcessor from '../../../../src/post-processor/includeProcessor'
+import { Work } from '../../../../src/types/work'
 import {
   IgnoreHelper,
   buildIncludeHelper,
 } from '../../../../src/utils/ignoreHelper'
-import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const mockProcess = jest.fn()
 jest.mock('../../../../src/service/diffLineInterpreter', () => {

__tests__/unit/lib/post-processor/packageGenerator.test.ts

@@ -1,10 +1,11 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import PackageGenerator from '../../../../src/post-processor/packageGenerator'
 import fse from 'fs-extra'
-import { Work } from '../../../../src/types/work'
+
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import PackageGenerator from '../../../../src/post-processor/packageGenerator'
+import { Work } from '../../../../src/types/work'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('fs-extra')
 

__tests__/unit/lib/post-processor/postProcessorManager.test.ts

@@ -1,12 +1,13 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import BaseProcessor from '../../../../src/post-processor/baseProcessor'
 import PostProcessorManager, {
   getPostProcessors,
 } from '../../../../src/post-processor/postProcessorManager'
-import BaseProcessor from '../../../../src/post-processor/baseProcessor'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const processSpy = jest.fn()
 

__tests__/unit/lib/service/botHandler.test.ts

@@ -1,10 +1,11 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import BotHandler from '../../../../src/service/botHandler'
-import { copyFiles } from '../../../../src/utils/fsHelper'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { copyFiles } from '../../../../src/utils/fsHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')
 

__tests__/unit/lib/service/customObjectHandler.test.ts

@@ -1,16 +1,17 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import CustomObjectHandler from '../../../../src/service/customObjectHandler'
+
 import { MASTER_DETAIL_TAG } from '../../../../src/constant/metadataConstants'
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import CustomObjectHandler from '../../../../src/service/customObjectHandler'
+import { Work } from '../../../../src/types/work'
 import {
   copyFiles,
   pathExists,
   readDir,
   readPathFromGit,
 } from '../../../../src/utils/fsHelper'
-import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')
 

__tests__/unit/lib/service/diffLineInterpreter-compatibility.test.ts

@@ -1,10 +1,11 @@
 'use strict'
 
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import DiffLineInterpreter from '../../../../src/service/diffLineInterpreter'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('os', () => ({
   availableParallelism: null,

__tests__/unit/lib/service/diffLineInterpreter.test.ts

@@ -1,9 +1,10 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import DiffLineInterpreter from '../../../../src/service/diffLineInterpreter'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const mockHandle = jest.fn()
 jest.mock('../../../../src/service/typeHandlerFactory', () => {

__tests__/unit/lib/service/inBundleHandler.test.ts

@@ -1,9 +1,10 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import InBundleHandler from '../../../../src/service/inBundleHandler'
 import { Work } from '../../../../src/types/work'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const objectType = 'digitalExperiences'
 const entityPath =

__tests__/unit/lib/service/inFileHandler.test.ts

@@ -1,10 +1,11 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import { writeFile } from '../../../../src/utils/fsHelper'
-import { Work } from '../../../../src/types/work'
-import InFileHandler from '../../../../src/service/inFileHandler'
+
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import InFileHandler from '../../../../src/service/inFileHandler'
+import { Work } from '../../../../src/types/work'
+import { writeFile } from '../../../../src/utils/fsHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const mockCompare = jest.fn()
 const mockPrune = jest.fn()

__tests__/unit/lib/service/inFolderHandler.test.ts

@@ -1,11 +1,12 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import InFolder from '../../../../src/service/inFolderHandler'
-import { copyFiles, readDir } from '../../../../src/utils/fsHelper'
+
 import { METAFILE_SUFFIX } from '../../../../src/constant/metadataConstants'
-import { Work } from '../../../../src/types/work'
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import InFolder from '../../../../src/service/inFolderHandler'
+import { Work } from '../../../../src/types/work'
+import { copyFiles, readDir } from '../../../../src/utils/fsHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')
 const mockedReadDir = jest.mocked(readDir)

__tests__/unit/lib/service/inResourceHandler.test.ts

@@ -1,11 +1,12 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
+
+import { METAFILE_SUFFIX } from '../../../../src/constant/metadataConstants'
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import InResourceHandler from '../../../../src/service/inResourceHandler'
 import { Work } from '../../../../src/types/work'
 import { copyFiles, pathExists, readDir } from '../../../../src/utils/fsHelper'
-import { METAFILE_SUFFIX } from '../../../../src/constant/metadataConstants'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')
 

__tests__/unit/lib/service/lwcHandler.test.ts

@@ -1,15 +1,16 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import LwcHandler from '../../../../src/service/lwcHandler'
-import { copyFiles } from '../../../../src/utils/fsHelper'
-import { Work } from '../../../../src/types/work'
+
 import {
   ADDITION,
   DELETION,
   MODIFICATION,
 } from '../../../../src/constant/gitConstants'
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import LwcHandler from '../../../../src/service/lwcHandler'
+import { Work } from '../../../../src/types/work'
+import { copyFiles } from '../../../../src/utils/fsHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')
 

__tests__/unit/lib/service/objectTranslationHandler.test.ts

@@ -1,10 +1,11 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import { Work } from '../../../../src/types/work'
+
+import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
 import ObjectTranslation from '../../../../src/service/objectTranslationHandler'
+import { Work } from '../../../../src/types/work'
 import { writeFile, copyFiles } from '../../../../src/utils/fsHelper'
-import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 const mockCompare = jest.fn()
 const mockprune = jest.fn()

__tests__/unit/lib/service/sharedFolderHandler.test.ts

@@ -1,11 +1,12 @@
 'use strict'
 import { expect, jest, describe, it } from '@jest/globals'
-import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
-import SharedFolderHandler from '../../../../src/service/sharedFolderHandler'
-import { copyFiles } from '../../../../src/utils/fsHelper'
+
 import { METAFILE_SUFFIX } from '../../../../src/constant/metadataConstants'
-import { Work } from '../../../../src/types/work'
 import { MetadataRepository } from '../../../../src/metadata/MetadataRepository'
+import SharedFolderHandler from '../../../../src/service/sharedFolderHandler'
+import { Work } from '../../../../src/types/work'
+import { copyFiles } from '../../../../src/utils/fsHelper'
+import { getGlobalMetadata, getWork } from '../../../__utils__/globalTestHelper'
 
 jest.mock('../../../../src/utils/fsHelper')