Refactor imports and update ESLint rules (#67)

.changeset/ninety-turtles-invite.md

@@ -0,0 +1,10 @@
+---
+'@modular-rocks/traverse-files': patch
+'@modular-rocks/workspace-node': patch
+'@modular-rocks/slimfast-node': patch
+'eslint-config-custom': patch
+'@modular-rocks/workspace': patch
+'@modular-rocks/slimfast': patch
+---
+
+Internal: Refactored imports across all packages and modified eslint rules for better code consistency.

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf 

.github/workflows/ci.yml

@@ -43,3 +43,6 @@ jobs:
 
       - name: Linting
         run: pnpm lint
+
+      - name: Format
+        run: pnpm check:format

.prettierrc

@@ -1,4 +1,5 @@
 {
   "trailingComma": "es5",
-  "singleQuote": true
+  "singleQuote": true,
+  "endOfLine": "lf"
 }

config/eslint-config/.eslintrc.cjs

@@ -1,30 +1,22 @@
+/**
+ * @type {import("eslint").Linter.Config}
+ */
 module.exports = {
   env: {
     commonjs: true,
     es2021: true,
     node: true,
   },
-  extends: [
-    'airbnb-base',
-    'airbnb-typescript/base',
-    'plugin:prettier/recommended',
-  ],
+  extends: ['airbnb-base', 'airbnb-typescript/base', 'prettier'],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaVersion: 2021,
     sourceType: 'module',
     project: './tsconfig.json',
   },
-  plugins: ['@typescript-eslint', 'prettier'],
+  plugins: ['@typescript-eslint', 'unused-imports'],
   rules: {
     '@typescript-eslint/no-require-imports': 'error',
-    'prettier/prettier': [
-      'error',
-      {
-        usePrettierrc: true,
-        endOfLine: 'auto',
-      },
-    ],
     'import/extensions': [
       'error',
       'ignorePackages',
@@ -42,10 +34,33 @@ module.exports = {
     'no-await-in-loop': 'off',
     'no-async-promise-executor': 'off',
     '@typescript-eslint/no-useless-constructor': 'off',
-    'import/no-cycle': 'off',
     'import/no-extraneous-dependencies': 'off', // needed for the monorepo
     'import/prefer-default-export': 'off',
     '@typescript-eslint/no-floating-promises': 'error',
+    'arrow-body-style': 'off',
+    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/consistent-type-exports': 'error',
+    'import/order': [
+      'error',
+      {
+        groups: [
+          ['builtin', 'internal'],
+          'external',
+          ['index', 'parent', 'sibling'],
+          'object',
+          'type',
+        ],
+        distinctGroup: true,
+        'newlines-between': 'always',
+        alphabetize: {
+          order: 'asc',
+          orderImportKind: 'asc',
+          caseInsensitive: true,
+        },
+        warnOnUnassignedImports: true,
+      },
+    ],
+    'unused-imports/no-unused-imports': 'error',
   },
 
   ignorePatterns: ['.eslintrc.cjs', 'dist', 'turbo', 'coverage'],

config/eslint-config/package.json

@@ -11,6 +11,6 @@
     "eslint-config-airbnb-typescript": "17.1.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-prettier": "5.0.0"
+    "eslint-plugin-unused-imports": "3.0.0"
   }
 }

package.json

@@ -15,6 +15,8 @@
     "coverage": "turbo run coverage",
     "dev": "turbo run dev --parallel",
     "lint": "turbo run lint",
+    "check:format": "prettier --check \"**/*.{ts,tsx,md}\"",
+    "check": "pnpm lint && pnpm check:format",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "release": "changeset publish"
   },

packages/slimfast-node/src/slimfast/index.test.ts

@@ -1,8 +1,8 @@
 import { describe, expect, test } from 'vitest';
 
 import { SlimFast } from '.';
-import before from '../../test-results/basic/before';
 import after from '../../test-results/basic/after';
+import before from '../../test-results/basic/before';
 
 import type { SlimFastOpts } from '../types';
 

packages/slimfast-node/src/slimfast/index.ts

@@ -1,12 +1,12 @@
-import { Codebase } from '@modular-rocks/workspace-node';
 import { SlimFast as SlimFastBase } from '@modular-rocks/slimfast';
+import { Codebase } from '@modular-rocks/workspace-node';
 
-import { ExpressionVisitor } from './visitors/expression';
-import { defaultFunctionNameGenerator } from './pipeline/name/default-function-name-generator';
+import { build } from './pipeline/build';
 import { builder as pipelineBuilder } from './pipeline/build/builder';
 import { extract } from './pipeline/extract';
-import { build } from './pipeline/build';
 import { name } from './pipeline/name';
+import { defaultFunctionNameGenerator } from './pipeline/name/default-function-name-generator';
+import { ExpressionVisitor } from './visitors/expression';
 
 import type { SlimFastOpts } from '../types';
 

packages/slimfast-node/src/slimfast/pipeline/build/builder/combine-imports/index.test.ts

@@ -1,14 +1,15 @@
-import unique from 'array-unique';
+import traverse from '@babel/traverse';
 import { program } from '@babel/types';
-import traverse, { Binding, NodePath } from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
+import unique from 'array-unique';
 import { describe, expect, test } from 'vitest';
 
 import { combineImports } from '.';
-import { parser } from '../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../visitors/utils/parser';
 
 import type { RandomObject, SlimFastOpts } from '../../../../../types';
+import type { Binding, NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/combine-imports/index.ts

@@ -1,10 +1,6 @@
 import { dirname, relative, resolve } from 'path/posix';
 
-import { Binding } from '@babel/traverse';
 import {
-  ImportDefaultSpecifier,
-  ImportNamespaceSpecifier,
-  ImportSpecifier,
   identifier,
   importDeclaration,
   importDefaultSpecifier,
@@ -15,6 +11,12 @@ import {
 import unique from 'array-unique';
 
 import type { RandomObject } from '../../../../../types';
+import type { Binding } from '@babel/traverse';
+import type {
+  ImportDefaultSpecifier,
+  ImportNamespaceSpecifier,
+  ImportSpecifier,
+} from '@babel/types';
 
 interface Entry {
   default?: string | null;

packages/slimfast-node/src/slimfast/pipeline/build/builder/import-statement/index.test.ts

@@ -1,13 +1,12 @@
-import unique from 'array-unique';
-import { program } from '@babel/types';
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { generateImportDeclaration } from '.';
 import { parser } from '../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/index.ts

@@ -1,6 +1,5 @@
 import { dirname, extname, resolve } from 'path/posix';
 
-import { NodePath } from '@babel/traverse';
 import { program } from '@babel/types';
 import unique from 'array-unique';
 
@@ -10,6 +9,7 @@ import { replace as replaceInOriginalFile } from './replace';
 import { wrap } from './wrap';
 
 import type { RandomObject, SlimFastOpts } from '../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 /**
  * Builds the AST for a module, manages its imports, and optionally replaces nodes in the original file.

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/index.test.ts

@@ -1,10 +1,10 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { replace } from '.';
-import { parser } from '../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../types';
 

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/index.ts

@@ -1,9 +1,8 @@
-import { NodePath } from '@babel/traverse';
-
 import { generateJSXElement } from './jsx-function';
 import { generateFunction as generateCalleeFunction } from './normal-function';
 
 import type { RandomObject, SlimFastOpts } from '../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 /**
  * Replaces a `node path` with a newly generated AST node, which could be a JSX element

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/jsx-function/index.test.ts

@@ -1,12 +1,13 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { generateJSXElement } from '.';
-import { parser } from '../../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/jsx-function/index.ts

@@ -1,4 +1,3 @@
-import unique from 'array-unique';
 import {
   jsxIdentifier,
   jsxOpeningElement,
@@ -8,6 +7,7 @@ import {
   identifier,
   jsxClosingElement,
 } from '@babel/types';
+import unique from 'array-unique';
 
 import type { RandomObject } from '../../../../../../types';
 

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/normal-function/index.test.ts

@@ -1,12 +1,13 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { generateFunction } from '.';
-import { parser } from '../../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/replace/normal-function/index.ts

@@ -1,5 +1,5 @@
-import unique from 'array-unique';
 import { identifier, callExpression } from '@babel/types';
+import unique from 'array-unique';
 
 import type { RandomObject } from '../../../../../../types';
 

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/has-await/index.test.ts

@@ -1,13 +1,12 @@
-import unique from 'array-unique';
-import { program } from '@babel/types';
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { hasAwait } from '.';
 import { parser } from '../../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/has-await/index.ts

@@ -1,4 +1,6 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
+
+import type { NodePath } from '@babel/traverse';
 
 /**
  * Checks if the provided AST node path contains an `await` expression.

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/index.test.ts

@@ -1,12 +1,13 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { wrap } from '.';
-import { parser } from '../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/index.ts

@@ -1,9 +1,8 @@
-import { NodePath } from '@babel/traverse';
-
 import { generateExportedJSXComponent } from './jsx-function';
 import { generateExportedFunction } from './normal-function';
 
 import type { RandomObject, SlimFastOpts } from '../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 /**
  * Wraps the provided AST node path into an exported default function or JSX component.

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/jsx-function/index.test.ts

@@ -1,12 +1,13 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { generateExportedJSXComponent } from '.';
-import { parser } from '../../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/jsx-function/index.ts

@@ -1,5 +1,3 @@
-import unique from 'array-unique';
-import { NodePath } from '@babel/traverse';
 import {
   exportDefaultDeclaration,
   functionDeclaration,
@@ -10,11 +8,14 @@ import {
   variableDeclarator,
   objectProperty,
   objectPattern,
-  Statement,
 } from '@babel/types';
+import unique from 'array-unique';
+
 import { hasAwait } from '../has-await';
 
 import type { RandomObject } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
+import type { Statement } from '@babel/types';
 
 /**
  * Generates an exported JSX component declaration from a given AST node path and associated data.

packages/slimfast-node/src/slimfast/pipeline/build/builder/wrap/normal-function/index.test.ts

@@ -1,12 +1,13 @@
-import traverse, { NodePath } from '@babel/traverse';
+import traverse from '@babel/traverse';
 import { Codebase, FileContainer } from '@modular-rocks/workspace-node';
 import { describe, expect, test } from 'vitest';
 
 import { generateExportedFunction } from '.';
-import { parser } from '../../../../../visitors/utils/parser';
 import { extractIdentifiers } from '../../../../../visitors/utils/extract-identifiers';
+import { parser } from '../../../../../visitors/utils/parser';
 
 import type { SlimFastOpts } from '../../../../../../types';
+import type { NodePath } from '@babel/traverse';
 
 const files: [string, string][] = [[`/path`, '']];
 const opts: SlimFastOpts = {