Merge pull request #1764 from maizzle/chore/remove-format-default

chore: remove default html.format from config

Author: cossssmin

src/config/defaults.ts

@@ -23,7 +23,6 @@ export const defaults: MaizzleConfig = {
   },
   html: {
     decodeEntities: true,
-    format: true,
   },
   useTransformers: true,
 }

src/index.ts

@@ -64,6 +64,6 @@ export type { PurgeCssOptions } from './transformers/purgeCss.ts'
 export { filters } from './transformers/filters/index.ts'
 export { replaceStrings } from './transformers/replaceStrings.ts'
 export { format } from './transformers/format.ts'
-export type { FormatOptions } from './transformers/format.ts'
+export type { FormatConfig } from './transformers/format.ts'
 export { minify } from './transformers/minify.ts'
 export type { MinifyOptions } from './transformers/minify.ts'

src/tests/render/basic.test.ts

@@ -95,7 +95,6 @@ describe('render', () => {
       expect(result.config.css?.inline).toBe(true)
       expect(result.config.css?.purge).toBe(true)
       expect(result.config.css?.shorthand).toBe(true)
-      expect(result.config.html?.format).toBe(true)
     })
   })
 

src/tests/transformers/format.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect } from 'vitest'
-import { format, type FormatOptions } from '../../transformers/format.ts'
+import { format, type FormatConfig } from '../../transformers/format.ts'
 
-async function run(html: string, option?: boolean | FormatOptions): Promise<string> {
+async function run(html: string, option?: boolean | FormatConfig): Promise<string> {
   if (option === false) return html
   const opts = (option === true || option == null) ? {} : option
   return format(html, opts)

src/transformers/format.ts

@@ -1,10 +1,10 @@
 import { format as oxfmt } from 'oxfmt'
 import { defu as merge } from 'defu'
-import type { FormatOptions } from 'oxfmt'
+import type { FormatConfig } from 'oxfmt'
 
-export type { FormatOptions } from 'oxfmt'
+export type { FormatConfig } from 'oxfmt'
 
-const DEFAULT_OPTIONS: FormatOptions = {
+const DEFAULT_OPTIONS: FormatConfig = {
   printWidth: 320,
   htmlWhitespaceSensitivity: 'ignore',
   embeddedLanguageFormatting: 'off',
@@ -17,15 +17,15 @@ const DEFAULT_OPTIONS: FormatOptions = {
  * you pass.
  *
  * @param html    HTML string to format.
- * @param options [oxfmt `FormatOptions`](https://github.com/oxc-project/oxfmt).
+ * @param options [oxfmt `FormatConfig`](https://github.com/oxc-project/oxfmt).
  * @returns       The formatted HTML string.
  *
  * @example
  * import { format } from '@maizzle/framework'
  *
  * const pretty = await format(html, { useTabs: true, tabWidth: 4 })
  */
-export async function format(html: string, options: FormatOptions = {}): Promise<string> {
+export async function format(html: string, options: FormatConfig = {}): Promise<string> {
   const merged = merge(options, DEFAULT_OPTIONS)
   const result = await oxfmt('input.html', html, merged)
   return result.code

src/types/config.ts

@@ -360,7 +360,7 @@ export interface HtmlConfig {
    *
    * Set to `true` to enable with defaults, or pass options.
    */
-  format?: boolean | import('oxfmt').FormatOptions
+  format?: boolean | import('oxfmt').FormatConfig
   /**
    * Minify the HTML output.
    *