@borela-tech/eslint-config 2.1.1 → 2.2.0

package/src/rules/multilineUnionTypes/isMultiline.ts

@@ -0,0 +1,6 @@
+import type {TSESTree} from '@typescript-eslint/types'
+
+export function isMultiline(unionType: TSESTree.TSUnionType) {
+  const {start, end} = unionType.loc ?? {}
+  return start?.line !== end?.line
+}

package/src/rules/singleLineImports/createFix.ts

@@ -0,0 +1,23 @@
+import {formatAttributes} from './formatAttributes'
+import {formatSpecifiers} from './formatSpecifiers'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
+
+export function createFix(
+  fixer: TSESLint.RuleFixer,
+  declaration: TSESTree.ImportDeclaration,
+  sourceCode: TSESLint.SourceCode,
+): TSESLint.RuleFix {
+  const source = declaration.source.value
+  const prefix = declaration.importKind === 'type' ? 'import type ' : 'import '
+  const specifiers = formatSpecifiers(declaration, sourceCode)
+  const attributes = formatAttributes(declaration.attributes)
+
+  if (specifiers === '') {
+    const result = `${prefix}'${source}'${attributes}`
+    return fixer.replaceText(declaration, result)
+  }
+
+  const result = `${prefix}${specifiers} from '${source}'${attributes}`
+  return fixer.replaceText(declaration, result)
+}

package/src/rules/singleLineImports/formatAttributes.ts

@@ -0,0 +1,20 @@
+import type {TSESTree} from '@typescript-eslint/types'
+
+export function formatAttributes(
+  attributes: readonly TSESTree.ImportAttribute[],
+): string {
+  if (attributes.length === 0)
+    return ''
+
+  const formatted = attributes.map(
+    attr => {
+      const key = attr.key.type === 'Identifier'
+        ? attr.key.name
+        : attr.key.value
+      const value = attr.value.value
+      return `${key}: '${value}'`
+    },
+  ).join(', ')
+
+  return ` with {${formatted}}`
+}

package/src/rules/singleLineImports/formatNamed.ts

@@ -0,0 +1,9 @@
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
+
+export function formatNamed(
+  specifiers: TSESTree.ImportSpecifier[],
+  sourceCode: TSESLint.SourceCode,
+): string {
+  return specifiers.map(s => sourceCode.getText(s)).join(', ')
+}

package/src/rules/singleLineImports/formatSpecifiers.ts

@@ -0,0 +1,32 @@
+import {formatNamed} from './formatNamed'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
+
+export function formatSpecifiers(
+  declaration: TSESTree.ImportDeclaration,
+  sourceCode: TSESLint.SourceCode,
+): string {
+  const defaultSpecifier = declaration.specifiers.find(
+    (s): s is TSESTree.ImportDefaultSpecifier => s.type === 'ImportDefaultSpecifier',
+  )
+  const namespaceSpecifier = declaration.specifiers.find(
+    (s): s is TSESTree.ImportNamespaceSpecifier => s.type === 'ImportNamespaceSpecifier',
+  )
+  const namedSpecifiers = declaration.specifiers.filter(
+    (s): s is TSESTree.ImportSpecifier => s.type === 'ImportSpecifier',
+  )
+
+  if (namespaceSpecifier)
+    return `* as ${namespaceSpecifier.local.name}`
+
+  if (defaultSpecifier && namedSpecifiers.length > 0)
+    return `${defaultSpecifier.local.name}, {${formatNamed(namedSpecifiers, sourceCode)}}`
+
+  if (defaultSpecifier)
+    return defaultSpecifier.local.name
+
+  if (namedSpecifiers.length === 0)
+    return ''
+
+  return `{${formatNamed(namedSpecifiers, sourceCode)}}`
+}

package/src/rules/singleLineImports/index.ts

@@ -0,0 +1,34 @@
+import {createFix} from './createFix'
+import {isMultiline} from './isMultiline'
+import type {TSESLint} from '@typescript-eslint/utils'
+
+type MessageIds = 'multiline'
+
+export const singleLineImports: TSESLint.RuleModule<MessageIds, []> = {
+  meta: {
+    docs: {
+      description: 'Enforce imports to be on a single line',
+    },
+    fixable: 'code',
+    messages: {
+      multiline: 'Import should be on a single line',
+    },
+    schema: [],
+    type: 'layout',
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (!isMultiline(node))
+          return
+
+        context.report({
+          node,
+          messageId: 'multiline',
+          fix: fixer => createFix(fixer, node, context.sourceCode),
+        })
+      },
+    }
+  },
+}

package/src/rules/singleLineImports/isMultiline.ts

@@ -0,0 +1,6 @@
+import type {TSESTree} from '@typescript-eslint/types'
+
+export function isMultiline(declaration: TSESTree.ImportDeclaration) {
+  const {start, end} = declaration.loc ?? {}
+  return start?.line !== end?.line
+}

package/src/rules/singleLineReExports/createFix.ts

@@ -0,0 +1,29 @@
+import {formatAttributes} from '../singleLineImports/formatAttributes'
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
+import type {TSESLint} from '@typescript-eslint/utils'
+
+export function createFix(
+  fixer: TSESLint.RuleFixer,
+  declaration: ReExportDeclaration,
+  sourceCode: TSESLint.SourceCode,
+): TSESLint.RuleFix {
+  const source = declaration.source!.value
+
+  if (declaration.type === 'ExportAllDeclaration') {
+    const exported = declaration.exported
+      ? `* as ${sourceCode.getText(declaration.exported)}`
+      : '*'
+    const attributes = formatAttributes(declaration.attributes)
+    const result = `export ${exported} from '${source}'${attributes}`
+    return fixer.replaceText(declaration, result)
+  }
+
+  const prefix = declaration.exportKind === 'type' ? 'export type ' : 'export '
+  const specifiers = declaration.specifiers.map(
+    s => sourceCode.getText(s),
+  ).join(', ')
+  const attributes = formatAttributes(declaration.attributes)
+  const result = `${prefix}{${specifiers}} from '${source}'${attributes}`
+
+  return fixer.replaceText(declaration, result)
+}

package/src/rules/singleLineReExports/index.ts

@@ -0,0 +1,48 @@
+import {createFix} from './createFix'
+import {isMultiline} from './isMultiline'
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
+
+type MessageIds = 'multiline'
+
+export const singleLineReExports: TSESLint.RuleModule<MessageIds, []> = {
+  meta: {
+    docs: {
+      description: 'Enforce re-exports to be on a single line',
+    },
+    fixable: 'code',
+    messages: {
+      multiline: 'Re-export should be on a single line',
+    },
+    schema: [],
+    type: 'layout',
+  },
+
+  create(context) {
+    const checkDeclaration = (
+      node: TSESTree.Node,
+      declaration: ReExportDeclaration,
+    ) => {
+      // Skip local exports (only process re-exports with a source)
+      if (!declaration.source)
+        return
+
+      if (!isMultiline(declaration))
+        return
+
+      context.report({
+        node,
+        messageId: 'multiline',
+        fix: fixer => createFix(fixer, declaration, context.sourceCode),
+      })
+    }
+
+    return {
+      ExportNamedDeclaration: node =>
+        checkDeclaration(node, node),
+      ExportAllDeclaration: node =>
+        checkDeclaration(node, node),
+    }
+  },
+}

package/src/rules/singleLineReExports/isMultiline.ts

@@ -0,0 +1,6 @@
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
+
+export function isMultiline(declaration: ReExportDeclaration) {
+  const {start, end} = declaration.loc ?? {}
+  return start?.line !== end?.line
+}

package/src/rules/sortedImports/ImportError.ts

@@ -2,5 +2,8 @@ import type {TSESTree} from '@typescript-eslint/types'
 
 export interface ImportError {
   node: TSESTree.ImportDeclaration
-  messageId: 'sortedImports' | 'sortedNames' | 'wrongGroup'
+  messageId:
+    | 'sortedImports'
+    | 'sortedNames'
+    | 'wrongGroup'
 }

package/src/rules/sortedImports/ImportGroup.ts

@@ -1,5 +1,6 @@
 export type ImportGroup =
-  | 'side-effect'
   | 'default'
   | 'named'
+  | 'namespace'
+  | 'side-effect'
   | 'type'

package/src/rules/sortedImports/ImportGroupOrder.ts

@@ -1,7 +1,8 @@
-import {ImportGroup} from './ImportGroup'
+import type {ImportGroup} from './ImportGroup'
 
 export const importGroupOrder: ImportGroup[] = [
   'side-effect',
+  'namespace',
   'default',
   'named',
   'type',

package/src/rules/sortedImports/areSpecifiersSorted.ts

@@ -1,4 +1,4 @@
-import {compare} from '../../lib/compare'
+import {compare} from '@lib/compare'
 import {getSpecifierName} from './getSpecifierName'
 import type {TSESTree} from '@typescript-eslint/types'
 

package/src/rules/sortedImports/categorizeImport.ts

@@ -10,6 +10,10 @@ export function categorizeImport(declaration: TSESTree.ImportDeclaration): Impor
   if (declaration.specifiers.length === 0)
     return 'side-effect'
 
+  // Example: import * as fs from 'module'
+  if (declaration.specifiers.some(s => s.type === 'ImportNamespaceSpecifier'))
+    return 'namespace'
+
   // Example: import value from 'module'
   if (declaration.specifiers.some(s => s.type === 'ImportDefaultSpecifier'))
     return 'default'

package/src/rules/sortedImports/checkAlphabeticalSorting.ts

@@ -1,4 +1,4 @@
-import {compare} from '../../lib/compare'
+import {compare} from '@lib/compare'
 import {importGroupOrder} from './ImportGroupOrder'
 import type {CategorizedImport} from './CategorizedImport'
 import type {ImportError} from './ImportError'

package/src/rules/sortedImports/createFix/buildSortedCode.ts

@@ -2,10 +2,11 @@ import {formatNamedImport} from './formatNamedImport'
 import {importGroupOrder} from '../ImportGroupOrder'
 import type {CategorizedImport} from '../CategorizedImport'
 import type {ImportGroup} from '../ImportGroup'
+import type {TSESLint} from '@typescript-eslint/utils'
 
 export function buildSortedCode(
   grouped: Record<ImportGroup, CategorizedImport[]>,
-  sourceCode: {getText: (node?: unknown) => string},
+  sourceCode: TSESLint.SourceCode,
 ): string[] {
   const sortedCode: string[] = []
 

package/src/rules/sortedImports/createFix/formatNamedImport.ts

@@ -1,11 +1,12 @@
 import {areSpecifiersSorted} from '../areSpecifiersSorted'
 import {getNamedSpecifiers} from '../getNamedSpecifiers'
 import {sortSpecifiersText} from '../sortSpecifiersText'
-import type {TSESTree} from '@typescript-eslint/types'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
 
 export function formatNamedImport(
   declaration: TSESTree.ImportDeclaration,
-  sourceCode: {getText: (node?: unknown) => string},
+  sourceCode: TSESLint.SourceCode,
 ): string {
   const specifiers = getNamedSpecifiers(declaration)
 

package/src/rules/sortedImports/createFix/getReplacementRange.ts

@@ -1,13 +1,13 @@
 import {findLastImportIndex} from './findLastImportIndex'
-import type {ReplacementRange} from '../../../lib/ReplacementRange'
+import type {ReplacementRange} from '@lib/ReplacementRange'
 import type {TSESTree} from '@typescript-eslint/types'
 
 export function getReplacementRange(
   programBody: TSESTree.ProgramStatement[],
 ): ReplacementRange {
   const lastIndex = findLastImportIndex(programBody)
-  const firstImport = programBody[0] as TSESTree.ImportDeclaration
-  const lastImport = programBody[lastIndex] as TSESTree.ImportDeclaration
+  const firstImport = programBody[0]
+  const lastImport = programBody[lastIndex]
   const start = firstImport.range![0]
   const end = lastImport.range![1]
   return {start, end}

package/src/rules/sortedImports/createFix/groupImportsByType.ts

@@ -6,6 +6,7 @@ export function groupImportsByType(
 ): Record<ImportGroup, CategorizedImport[]> {
   const grouped: Record<ImportGroup, CategorizedImport[]> = {
     'side-effect': [],
+    namespace: [],
     default: [],
     named: [],
     type: [],

package/src/rules/sortedImports/createFix/index.ts

@@ -2,17 +2,16 @@ import {buildSortedCode} from './buildSortedCode'
 import {categorizeImports} from '../categorizeImports'
 import {groupImportsByType} from './groupImportsByType'
 import {sortImportGroups} from './sortImportGroups'
-import type {Rule} from 'eslint'
-import type {TSESTree} from '@typescript-eslint/types'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
 
 function createFixForGroup(
-  fixer: Rule.RuleFixer,
+  fixer: TSESLint.RuleFixer,
   importDeclarations: TSESTree.ImportDeclaration[],
-  sourceCode: {getText: (node?: unknown) => string},
-): Rule.Fix | null {
-  if (importDeclarations.length === 0) {
+  sourceCode: TSESLint.SourceCode,
+) {
+  if (importDeclarations.length === 0)
     return null
-  }
 
   const categorized = categorizeImports(importDeclarations)
   const grouped = groupImportsByType(categorized)
@@ -32,11 +31,11 @@ function createFixForGroup(
 }
 
 export function createFix(
-  fixer: Rule.RuleFixer,
+  fixer: TSESLint.RuleFixer,
   importGroups: TSESTree.ImportDeclaration[][],
-  sourceCode: {getText: (node?: unknown) => string},
-): Rule.Fix[] {
-  const fixes: Rule.Fix[] = []
+  sourceCode: TSESLint.SourceCode,
+): TSESLint.RuleFix[] {
+  const fixes: TSESLint.RuleFix[] = []
 
   for (const group of importGroups) {
     const fix = createFixForGroup(fixer, group, sourceCode)

package/src/rules/sortedImports/createFix/sortImportGroups.ts

@@ -1,4 +1,4 @@
-import {compare} from '../../../lib/compare'
+import {compare} from '@lib/compare'
 import type {CategorizedImport} from '../CategorizedImport'
 import type {ImportGroup} from '../ImportGroup'
 
@@ -6,6 +6,7 @@ export function sortImportGroups(
   grouped: Record<ImportGroup, CategorizedImport[]>,
 ): void {
   grouped['side-effect'].sort((a, b) => compare(a.sortKey, b.sortKey))
+  grouped['namespace'].sort((a, b) => compare(a.sortKey, b.sortKey))
   grouped['default'].sort((a, b) => compare(a.sortKey, b.sortKey))
   grouped['named'].sort((a, b) => compare(a.sortKey, b.sortKey))
   grouped['type'].sort((a, b) => compare(a.sortKey, b.sortKey))

package/src/rules/sortedImports/getSortKey.ts

@@ -7,11 +7,17 @@ export function getSortKey(declaration: TSESTree.ImportDeclaration): string {
   if (group === 'side-effect')
     return declaration.source.value
 
+  if (group === 'namespace') {
+    const namespaceSpecifier = declaration.specifiers.find(
+      s => s.type === 'ImportNamespaceSpecifier',
+    )
+    return `*${namespaceSpecifier?.local.name ?? ''}`
+  }
+
   if (group === 'default') {
     const defaultSpecifier = declaration.specifiers.find(
       s => s.type === 'ImportDefaultSpecifier',
-    ) as TSESTree.ImportDefaultSpecifier | undefined
-
+    )
     return defaultSpecifier?.local.name ?? ''
   }
 

package/src/rules/sortedImports/index.ts

@@ -5,14 +5,17 @@ import {checkSpecifiersSorting} from './checkSpecifiersSorting'
 import {createFix} from './createFix'
 import {getImportGroups} from './getImportGroups'
 import type {ImportError} from './ImportError'
-import type {Rule} from 'eslint'
-import type {TSESTree} from '@typescript-eslint/types'
+import type {TSESLint} from '@typescript-eslint/utils'
 
-export const sortedImports: Rule.RuleModule = {
+type MessageIds =
+  | 'sortedImports'
+  | 'sortedNames'
+  | 'wrongGroup'
+
+export const sortedImports: TSESLint.RuleModule<MessageIds, []> = {
   meta: {
     docs: {
       description: 'Enforce sorted imports alphabetically',
-      recommended: true,
     },
     fixable: 'code',
     messages: {
@@ -26,7 +29,7 @@ export const sortedImports: Rule.RuleModule = {
   create(context) {
     return {
       Program(node) {
-        const body = node.body as TSESTree.ProgramStatement[]
+        const body = node.body
         const importGroups = getImportGroups(body)
         if (importGroups.length === 0)
           return

package/src/rules/sortedImports/sortSpecifiersText.ts

@@ -1,10 +1,11 @@
-import {compare} from '../../lib/compare'
+import {compare} from '@lib/compare'
 import {getSpecifierName} from './getSpecifierName'
-import type {TSESTree} from '@typescript-eslint/types'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
 
 export function sortSpecifiersText(
   specifiers: TSESTree.ImportSpecifier[],
-  sourceCode: {getText: (node: TSESTree.ImportSpecifier) => string},
+  sourceCode: TSESLint.SourceCode,
 ): string {
   const sorted = [...specifiers].sort((a, b) => {
     const nameA = getSpecifierName(a)

package/src/rules/sortedReExports/CategorizedReExport.ts

@@ -1,8 +1,10 @@
-import {TSESTree} from '@typescript-eslint/types'
+import type {TSESTree} from '@typescript-eslint/types'
 
 interface NamedReExport {
   declaration: TSESTree.ExportNamedDeclaration
-  group: 're-export-named' | 're-export-type'
+  group:
+    | 're-export-named'
+    | 're-export-type'
   sortKey: string
 }
 
@@ -12,4 +14,13 @@ interface ReExportAll {
   sortKey: string
 }
 
-export type CategorizedReExport = NamedReExport | ReExportAll
+interface ReExportNamespace {
+  declaration: TSESTree.ExportAllDeclaration
+  group: 're-export-namespace'
+  sortKey: string
+}
+
+export type CategorizedReExport =
+  | NamedReExport
+  | ReExportAll
+  | ReExportNamespace

package/src/rules/sortedReExports/ReExportError.ts

@@ -1,6 +1,9 @@
-import type {ReExportDeclaration} from './ReExportDeclaration'
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
 
 export interface ReExportError {
   node: ReExportDeclaration
-  messageId: 'sortedReExports' | 'sortedNames' | 'wrongGroup'
+  messageId:
+    | 'sortedReExports'
+    | 'sortedNames'
+    | 'wrongGroup'
 }

package/src/rules/sortedReExports/ReExportGroup.ts

@@ -1,4 +1,5 @@
 export type ReExportGroup =
   | 're-export-all'
+  | 're-export-namespace'
   | 're-export-named'
   | 're-export-type'

package/src/rules/sortedReExports/ReExportGroupOrder.ts

@@ -1,7 +1,8 @@
-import {ReExportGroup} from './ReExportGroup'
+import type {ReExportGroup} from './ReExportGroup'
 
 export const reExportGroupOrder: ReExportGroup[] = [
   're-export-all',
+  're-export-namespace',
   're-export-named',
   're-export-type',
 ]

package/src/rules/sortedReExports/areSpecifiersSorted.ts

@@ -1,4 +1,4 @@
-import {compare} from '../../lib/compare'
+import {compare} from '@lib/compare'
 import {getSpecifierName} from './getSpecifierName'
 import type {TSESTree} from '@typescript-eslint/types'
 

package/src/rules/sortedReExports/categorizeReExport.ts

@@ -1,12 +1,16 @@
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
 import type {ReExportGroup} from './ReExportGroup'
-import type {TSESTree} from '@typescript-eslint/types'
 
 export function categorizeReExport(
-  declaration: TSESTree.ExportNamedDeclaration | TSESTree.ExportAllDeclaration,
+  declaration: ReExportDeclaration,
 ): ReExportGroup {
-  // Example: export * from 'module'
-  if (declaration.type === 'ExportAllDeclaration')
+  // Example: export * from 'module' or export * as ns from 'module'
+  if (declaration.type === 'ExportAllDeclaration') {
+    // Export * as ns from 'module' has an 'exported' property
+    if (declaration.exported)
+      return 're-export-namespace'
     return 're-export-all'
+  }
 
   // Example: export type {Type} from 'module'
   if (declaration.exportKind === 'type')

package/src/rules/sortedReExports/categorizeReExports.ts

@@ -1,7 +1,7 @@
 import {categorizeReExport} from './categorizeReExport'
 import {getSortKey} from './getSortKey'
-import {ReExportDeclaration} from './ReExportDeclaration'
 import type {CategorizedReExport} from './CategorizedReExport'
+import type {ReExportDeclaration} from '@lib/ReExportDeclaration'
 
 export function categorizeReExports(declarations: ReExportDeclaration[]): CategorizedReExport[] {
   return declarations.map(declaration => {

package/src/rules/sortedReExports/checkAlphabeticalSorting.ts

@@ -1,4 +1,4 @@
-import {compare} from '../../lib/compare'
+import {compare} from '@lib/compare'
 import {reExportGroupOrder} from './ReExportGroupOrder'
 import type {CategorizedReExport} from './CategorizedReExport'
 import type {ReExportError} from './ReExportError'

package/src/rules/sortedReExports/createFix/buildSortedCode.ts

@@ -3,10 +3,11 @@ import {isNamedReExport} from '../isNamedReExport'
 import {reExportGroupOrder} from '../ReExportGroupOrder'
 import type {CategorizedReExport} from '../CategorizedReExport'
 import type {ReExportGroup} from '../ReExportGroup'
+import type {TSESLint} from '@typescript-eslint/utils'
 
 export function buildSortedCode(
   grouped: Record<ReExportGroup, CategorizedReExport[]>,
-  sourceCode: {getText: (node?: unknown) => string},
+  sourceCode: TSESLint.SourceCode,
 ): string[] {
   const sortedCode: string[] = []
 

package/src/rules/sortedReExports/createFix/formatNamedReExport.ts

@@ -1,11 +1,12 @@
 import {areSpecifiersSorted} from '../areSpecifiersSorted'
 import {getNamedSpecifiers} from '../getNamedSpecifiers'
 import {sortSpecifiersText} from '../sortSpecifiersText'
-import type {TSESTree} from '@typescript-eslint/types'
+import type {TSESLint} from '@typescript-eslint/utils'
+import type {TSESTree} from '@typescript-eslint/utils'
 
 export function formatNamedReExport(
   declaration: TSESTree.ExportNamedDeclaration,
-  sourceCode: {getText: (node?: unknown) => string},
+  sourceCode: TSESLint.SourceCode,
 ): string {
   const specifiers = getNamedSpecifiers(declaration)
 

package/src/rules/sortedReExports/createFix/getReplacementRange.ts

@@ -1,6 +1,6 @@
 import {findFirstExportIndex} from './findFirstExportIndex'
 import {findLastExportIndex} from './findLastExportIndex'
-import type {ReplacementRange} from '../../../lib/ReplacementRange'
+import type {ReplacementRange} from '@lib/ReplacementRange'
 import type {TSESTree} from '@typescript-eslint/types'
 
 export function getReplacementRange(

package/src/rules/sortedReExports/createFix/groupReExportsByType.ts

@@ -6,6 +6,7 @@ export function groupReExportsByType(
 ): Record<ReExportGroup, CategorizedReExport[]> {
   const grouped: Record<ReExportGroup, CategorizedReExport[]> = {
     're-export-all': [],
+    're-export-namespace': [],
     're-export-named': [],
     're-export-type': [],
   }