feat simplyfy exports

Author: rrd108

dist/vue-mess-detector.es.js

@@ -1,65 +1,19 @@
 import type { GroupBy, OutputFormat, OutputLevel, SortBy } from './src/types'
+import type { AnalyzeOutput } from './src/types/AnalyzeOutput'
 
-// Declare the analyze function
+// Exports from analyze.ts
 export const analyze: (options: {
   dir: string
-  apply: string[]
-  ignore: string[]
+  apply?: string[]
+  ignore?: string[]
   exclude?: string
-  groupBy: GroupBy
-  level: OutputLevel
-  sortBy: SortBy
-}) => Promise<{
-  output: { info: string }[]
-  reportOutput: Record<string, Array<{
-    id: string
-    description: string
-    message: string
-  }>>
-  codeHealthOutput: { info: string }[]
-}>
+  groupBy?: GroupBy
+  level?: OutputLevel
+  sortBy?: SortBy
+}) => Promise<AnalyzeOutput>
 
-// Declare types for configuration
-export interface Config {
-  path: string
-  apply: string
-  ignore?: string
-  exclude?: string
-  group: GroupBy
-  level: OutputLevel
-  sort: SortBy
-  output: OutputFormat
-}
-
-// Declare types for conflicting flags
-export interface ConflictingFlags {
-  applyFromCLI: boolean
-  ignoreFromCLI: boolean
-  applyFromFile: boolean
-  ignoreFromFile: boolean
-}
-
-// Declare the main yargs command
-export const command: (
-  command: string,
-  description: string,
-  builder: (yargs: any) => any,
-  handler: (argv: any) => void
-) => void
-
-// Declare utility functions
-export const isNuxtProject: (path?: string) => Promise<boolean>
-export const isVueProject: (path?: string) => Promise<boolean>
-export const getProjectRoot: (path?: string) => Promise<string>
-export const getPackageJson: () => Promise<{ version: string }>
-export const validateOption: <T>(value: any, optionType: string) => T
-export const wasOptionPassed: (option: string) => boolean
-export const coerceRules: (type: 'apply' | 'ignore') => (value: string) => string[]
+// Exports from cli.ts
+export const FLAT_RULES: string[]
 
-// Declare constants
-export const FLAT_RULESETS_RULES: string[]
-export const RULESETS: Record<string, string>
-export const GROUP_BY: readonly GroupBy[]
-export const OUTPUT_FORMATS: readonly OutputFormat[]
-export const OUTPUT_LEVELS: readonly OutputLevel[]
-export const SORT_BY: readonly SortBy[]
+// Types used in the exported functions
+export type { AnalyzeOutput, GroupBy, OutputFormat, OutputLevel, SortBy }

index.d.ts

@@ -6,7 +6,7 @@ import yargs from 'yargs'
 import { hideBin } from 'yargs/helpers'
 import { analyze } from './analyzer'
 import coerceRules from './helpers/coerceRules'
-import { FLAT_RULESETS_RULES } from './helpers/constants'
+import { FLAT_RULES, FLAT_RULESETS_RULES } from './helpers/constants'
 import { getConfig } from './helpers/getConfig'
 import { getPackageJson } from './helpers/getPackageJson'
 import getProjectRoot from './helpers/getProjectRoot'
@@ -173,4 +173,4 @@ getProjectRoot(pathArg || './src').then(async (projectRoot) => {
   )
 })
 
-export { analyze, FLAT_RULESETS_RULES }
+export { analyze, FLAT_RULES }

src/cli.ts

@@ -0,0 +1,42 @@
+import { describe, expect, it, vi } from 'vitest'
+import { RULES } from '../rules/rules'
+import coerceRules from './coerceRules'
+
+describe('coerceRules', () => {
+  const applyCoerceRules = coerceRules('apply')
+
+  it('returns all rules when no argument is provided', () => {
+    const result = applyCoerceRules()
+    expect(result).toEqual(Object.keys(RULES))
+  })
+
+  it('correctly applies individual rules', () => {
+    const result = applyCoerceRules('implicitParentChildCommunication,bigVif')
+    expect(result).toEqual(expect.arrayContaining(['implicitParentChildCommunication', 'bigVif']))
+  })
+
+  it('correctly applies rulesets', () => {
+    const result = applyCoerceRules('vue-caution')
+    expect(result).toEqual(expect.arrayContaining(['implicitParentChildCommunication', 'implicitParentChildCommunication']))
+  })
+
+  it('correctly applies a mix of rulesets and individual rules', () => {
+    const result = applyCoerceRules('vue-caution,bigVif')
+    expect(result).toEqual(expect.arrayContaining(['implicitParentChildCommunication', 'elementSelectorsWithScoped', 'bigVif']))
+  })
+
+  it('logs an error and exits for invalid rules', () => {
+    const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
+    const processSpy = vi.spyOn(process, 'exit').mockImplementation(() => undefined as never)
+
+    applyCoerceRules('gauranga')
+
+    expect(consoleSpy).toHaveBeenCalledWith(
+      expect.stringContaining('Invalid apply values: gauranga'),
+    )
+    expect(processSpy).toHaveBeenCalledWith(1)
+
+    consoleSpy.mockRestore()
+    processSpy.mockRestore()
+  })
+})

src/helpers/coerceRules.test.ts

@@ -7,7 +7,8 @@ export const MEDIUM_HEALTH_THRESHOLD = 85
 export const OK_HEALTH_THRESHOLD = 95
 
 // In case you need to display all allowed rules/rulesets ⬇️
-export const FLAT_RULESETS_RULES: string[] = [...RULESETS, ...Object.values(RULES).flat()]
+export const FLAT_RULES = [...Object.values(RULES).flat()]
+export const FLAT_RULESETS_RULES: string[] = [...RULESETS, ...FLAT_RULES]
 
 // Override Config ~ Default
 export const DEFAULT_OVERRIDE_CONFIG: OverrideConfig = {

src/helpers/constants.ts

@@ -81,7 +81,7 @@ export const checkRules = (descriptor: SFCDescriptor, filePath: string, apply: s
         }
       })
     }
-    else if (item in ruleChecks) {
+    if (item in ruleChecks) {
       // If it's an individual rule, apply it directly
       ruleChecks[item]()
     }

src/rulesCheck.ts

@@ -98,7 +98,6 @@ export const reportRules = (groupBy: GroupBy, sortBy: SortBy, level: OutputLevel
 
   sortedKeys.forEach((key) => {
     output[key] = []
-
     offensesGrouped[key].forEach((offense, i) => {
       const isError = offense.message.includes('<bg_err>')
       // if health already has the file, push the error