load-oxfmt-config 0.0.1 → 0.0.2

package/README.md

@@ -26,7 +26,7 @@ pnpm add load-oxfmt-config
 ```ts
 import { loadOxfmtConfig } from 'load-oxfmt-config'
 
-const config = loadOxfmtConfig({
+const config = await loadOxfmtConfig({
   cwd: '/configs',
 })
 
@@ -35,9 +35,29 @@ console.log({ config })
 
 ## Options
 
-- `configPath?: string` Path to the oxfmt config file, resolved relative to `cwd`.
-- `cwd?: string` Current working directory used when searching for config files. Defaults to `process.cwd()`.
-- `useCache?: boolean` Enable in-memory caching for path resolution and parsed config contents. Defaults to `true`.
+### configPath
+
+**Type**: `string`\
+**Required**: `false`\
+**Default**: `undefined`
+
+Path to the oxfmt config file, resolved relative to `cwd`.
+
+### cwd
+
+**Type**: `string`\
+**Required**: `false`\
+**Default**: `process.cwd()`
+
+Current working directory used when searching for config files.
+
+### useCache
+
+**Type**: `boolean`\
+**Required**: `false`\
+**Default**: `true`
+
+Enable in-memory caching for path resolution and parsed config contents.
 
 ## License
 

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { FormatOptions } from "oxfmt";
+
 //#region src/types.d.ts
 interface Options {
   /**
@@ -13,154 +15,16 @@ interface Options {
    */
   useCache?: boolean;
 }
-/**
- * Oxfmt configuration interface
- */
-interface OxfmtConfig {
-  /**
-   * Include parentheses around a sole arrow function parameter.
-   * @default `always`
-   */
-  arrowParens?: 'always' | 'avoid';
-  /**
-   * Put the `>` of a multi-line JSX element at the end of the last line\ninstead of being alone on the next line.
-   * @default false
-   */
-  bracketSameLine?: boolean;
-  /**
-   * Print spaces between brackets in object literals.
-   * @default true
-   */
-  bracketSpacing?: boolean;
-  /**
-   * Control whether to format embedded parts in the file.
-   * @default `off`
-   */
-  embeddedLanguageFormatting?: 'auto' | 'off';
-  /**
-   * Which end of line characters to apply.
-   * @default `lf`
-   */
-  endOfLine?: 'cr' | 'crlf' | 'lf';
-  /**
-   * Experimental: Sort `package.json` keys.
-   * @default true
-   */
-  experimentalSortPackageJson?: boolean;
-  /**
-   * Ignore files matching these glob patterns. Current working directory is used as the root.
-   */
-  ignorePatterns?: string[];
-  /**
-   * Whether to insert a final newline at the end of the file.
-   * @default true
-   */
-  insertFinalNewline?: boolean;
-  /**
-   * Use single quotes instead of double quotes in JSX.
-   * @default false
-   */
-  jsxSingleQuote?: boolean;
-  /**
-   * How to wrap object literals when they could fit on one line or span multiple lines.
-   * @default `preserve`
-   * NOTE: In addition to Prettier's `preserve` and `collapse`, we also support `always`
-   */
-  objectWrap?: 'always' | 'never' | 'preserve';
-  /**
-   * The line length that the printer will wrap on.
-   * @default 100
-   */
-  printWidth?: number;
-  /**
-   * Change when properties in objects are quoted.
-   * @default `as-needed`
-   */
-  quoteProps?: 'as-needed' | 'consistent' | 'preserve';
-  /**
-   * Print semicolons at the ends of statements.
-   * @default true
-   */
-  semi?: boolean;
-  /**
-   * Put each attribute on a new line in JSX.
-   * @default false
-   */
-  singleAttributePerLine?: boolean;
-  /**
-   * Use single quotes instead of double quotes.
-   * @default false
-   */
-  singleQuote?: boolean;
-  /**
-   * Number of spaces per indentation level.
-   * @default 2
-   */
-  tabWidth?: number;
-  /**
-   * Print trailing commas wherever possible.
-   * @default `all`
-   */
-  trailingComma?: 'all' | 'es5' | 'none';
-  /**
-   * Use tabs for indentation or spaces.
-   * @default false
-   */
-  useTabs?: boolean;
-  /**
-   * Experimental: Sort import statements. Disabled by default.
-   */
-  experimentalSortImports?: {
-    /**
-     * Custom groups configuration for organizing imports.\nEach array element represents a group, and multiple group names in the same array are treated as one.\nAccepts both `string` and `string[]` as group elements.
-     */
-    groups?: Array<string | string[]>;
-    /**
-     * Ignore case when sorting.
-     * @default true
-     */
-    ignoreCase?: boolean;
-    /**
-     * Glob patterns to identify internal imports.
-     */
-    internalPattern?: string[];
-    /**
-     * Add newlines between import groups.
-     * @default true
-     */
-    newlinesBetween?: boolean;
-    /**
-     * Sort order. (Default: `asc`)
-     * @default `asc`
-     */
-    order?: 'asc' | 'desc';
-    /**
-     * Partition imports by comments.
-     * @default false
-     */
-    partitionByComment?: boolean;
-    /**
-     * Partition imports by newlines.
-     * @default false
-     */
-    partitionByNewline?: boolean;
-    /**
-     * Sort side-effect imports.
-     * @default false
-     */
-    sortSideEffects?: boolean;
-  };
-}
 //#endregion
 //#region src/core.d.ts
 /**
  * Load oxfmt configuration by resolving the config file path and parsing its contents.
  * Uses in-memory caches by default; set `useCache` to false to force re-read.
  */
-declare function loadOxfmtConfig(options?: Options): Promise<OxfmtConfig>;
+declare function loadOxfmtConfig(options?: Options): Promise<FormatOptions>;
 /**
  * Resolve the oxfmt config file path, searching upward from the provided cwd when no explicit path is given.
  */
 declare function resolveOxfmtrcPath(cwd: string, configPath?: string): Promise<string | undefined>;
 //#endregion
-export { Options, OxfmtConfig, loadOxfmtConfig, resolveOxfmtrcPath };
+export { Options, loadOxfmtConfig, resolveOxfmtrcPath };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "load-oxfmt-config",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Load .oxfmtrc.json(c) for oxfmt.",
   "keywords": [
     "jsonc-parser",
@@ -37,6 +37,9 @@
     "access": "public"
   },
   "sideEffects": false,
+  "peerDependencies": {
+    "oxfmt": "^0.20.0"
+  },
   "dependencies": {
     "jsonc-parser": "^3.3.1"
   },
@@ -50,6 +53,7 @@
     "husky": "^9.1.7",
     "nano-staged": "^0.9.0",
     "npm-run-all2": "^8.0.4",
+    "oxfmt": "^0.20.0",
     "prettier": "^3.7.4",
     "tsdown": "^0.18.2",
     "typescript": "^5.9.3",