feat(eslint): add import order rule (#334)

This requires imports to be sorted, and can automatically be fixed by eslint

Co-authored-by: ismay <ismay@ismaywolff.nl>

config/js/eslint.config.js

@@ -42,5 +42,15 @@ module.exports = {
         ],
         'no-mixed-spaces-and-tabs': [SEVERITY],
         'prettier/prettier': [SEVERITY],
+        'import/order': [
+            SEVERITY,
+            {
+                'newlines-between': 'never',
+                alphabetize: {
+                    order: 'asc',
+                    caseInsensitive: true,
+                },
+            },
+        ],
     },
 }

index.js

@@ -1,5 +1,5 @@
-const { bundledConfigPaths } = require('./src/utils/groups.js')
 const command = require('./src/index.js')
+const { bundledConfigPaths } = require('./src/utils/groups.js')
 
 exports.config = bundledConfigPaths()
 exports.command = command

src/commands/commit.js

@@ -1,6 +1,5 @@
 const log = require('@dhis2/cli-helpers-engine').reporter
 const { namespace } = require('@dhis2/cli-helpers-engine')
-
 const { commitlint } = require('../tools/commitlint.js')
 
 const commitCmd = yargs => {

src/commands/install.js

@@ -1,7 +1,4 @@
 const { reporter, prompt } = require('@dhis2/cli-helpers-engine')
-
-const { log } = reporter
-
 const { configure } = require('../utils/config.js')
 const { printGroups, projects } = require('../utils/groups.js')
 
@@ -36,7 +33,7 @@ exports.builder = {
 
 exports.handler = async argv => {
     if (argv.listGroups) {
-        log.print(printGroups())
+        reporter.print(printGroups())
         process.exit(0)
     }
 

src/commands/javascript.js

@@ -1,6 +1,5 @@
 const { namespace } = require('@dhis2/cli-helpers-engine')
 const log = require('@dhis2/cli-helpers-engine').reporter
-
 const { eslint } = require('../tools/eslint.js')
 const { selectFiles } = require('../utils/files.js')
 const { sayFilesChecked, sayNoFiles } = require('../utils/std-log-messages.js')

src/commands/structured-text.js

@@ -1,6 +1,5 @@
 const { namespace } = require('@dhis2/cli-helpers-engine')
 const log = require('@dhis2/cli-helpers-engine').reporter
-
 const { prettier } = require('../tools/prettier.js')
 const { selectFiles } = require('../utils/files.js')
 const { sayFilesChecked, sayNoFiles } = require('../utils/std-log-messages.js')

src/tools/commitlint.js

@@ -1,5 +1,5 @@
-const { bin } = require('../utils/run.js')
 const { COMMITLINT_CONFIG } = require('../utils/paths.js')
+const { bin } = require('../utils/run.js')
 
 exports.commitlint = ({ config = COMMITLINT_CONFIG, file }) => {
     const cmd = 'commitlint'

src/tools/eslint.js

@@ -1,6 +1,6 @@
-const { bin } = require('../utils/run.js')
 const { resolveIgnoreFile } = require('../utils/files.js')
 const { PACKAGE_ROOT } = require('../utils/paths.js')
+const { bin } = require('../utils/run.js')
 
 exports.eslint = ({ files = [], apply = false, config }) => {
     const ignoreFile = resolveIgnoreFile(['.eslintignore'])

src/tools/prettier.js

@@ -1,7 +1,6 @@
 const log = require('@dhis2/cli-helpers-engine').reporter
-
-const { bin } = require('../utils/run.js')
 const { resolveIgnoreFile } = require('../utils/files.js')
+const { bin } = require('../utils/run.js')
 
 exports.prettier = ({ files = [], apply = false, config }) => {
     const ignoreFile = resolveIgnoreFile(['.prettierignore'])

src/utils/config.js

@@ -1,8 +1,6 @@
 const path = require('path')
-
-const fs = require('fs-extra')
-
 const log = require('@dhis2/cli-helpers-engine').reporter
+const fs = require('fs-extra')
 
 function copy(from, to, overwrite = true) {
     try {

src/utils/files.js

@@ -1,11 +1,9 @@
-const fg = require('fast-glob')
-const fs = require('fs-extra')
 const path = require('path')
-
 const log = require('@dhis2/cli-helpers-engine').reporter
-
-const { spawn } = require('./run.js')
+const fg = require('fast-glob')
+const fs = require('fs-extra')
 const { CONSUMING_ROOT } = require('./paths.js')
+const { spawn } = require('./run.js')
 
 // blacklists for files
 const blacklist = [

src/utils/groups.js

@@ -1,5 +1,4 @@
 const path = require('path')
-
 const {
     BROWSERSLIST_CONFIG,
     ESLINT_CONFIG,
@@ -10,7 +9,6 @@ const {
     DEPENDABOT_CONFIG,
     EDITORCONFIG_CONFIG,
     SEMANTIC_PR_CONFIG,
-
     LOCAL_ESLINT_REACT_CONFIG,
     LOCAL_PRETTIER_CONFIG,
     LOCAL_ESLINT_CONFIG,

tests/configs.js

@@ -1,6 +1,5 @@
-const test = require('tape')
 const path = require('path')
-
+const test = require('tape')
 const { config } = require('../index.js')
 
 test('prettier config resolves to non-empty object', t => {

tests/group-resolution.js

@@ -1,5 +1,4 @@
 const test = require('tape')
-
 const {
     groups,
     projects,
@@ -9,7 +8,6 @@ const {
     expandGroupAll,
     bundledConfigPaths,
 } = require('../src/utils/groups.js')
-
 const {
     BROWSERSLIST_CONFIG,
     HUSKY_CONFIG,

tests/main.js

@@ -1,5 +1,4 @@
 const test = require('tape')
-
 const { command, config } = require('../index.js')
 
 test('base exports are objects', t => {