@cocopalm/oxc-formatter-config 0.0.21 → 0.0.23

package/README.ko.md

@@ -0,0 +1,81 @@
+# oxc-formatter-config
+
+[English](./README.md) | [한국어](./README.ko.md)
+
+이 패키지는 [oxfmt](https://oxc.rs/docs/guide/usage/formatter)를 사용한 코드 포맷팅 설정을 제공합니다.
+
+## Installation
+
+```bash
+pnpm add -D oxfmt @cocopalm/oxc-formatter-config
+```
+
+## How to use
+
+### oxfmt.config.ts 설정하기
+
+프로젝트 루트 디렉토리에 `oxfmt.config.ts` 파일을 생성합니다.
+
+```bash
+touch oxfmt.config.ts
+```
+
+설정 파일에서 `@cocopalm/oxc-formatter-config`를 불러옵니다.
+
+```js
+// oxfmt.config.ts
+
+import config from '@cocopalm/oxc-formatter-config'
+
+export default config
+```
+
+`package.json` 에 포맷팅 스크립트를 추가해주세요.
+
+```json
+// package.json
+
+{
+  "scripts": {
+    "format": "oxfmt .",
+    "format:check": "oxfmt . --check"
+  }
+}
+```
+
+### Config Override
+
+기본 설정을 오버라이드하고 싶다면 다음과 같이 설정을 확장할 수 있습니다.
+
+```ts
+// oxfmt.config.ts
+
+import { defineConfig } from 'oxfmt'
+import baseConfig from '@cocopalm/oxc-formatter-config'
+
+export default defineConfig({
+  ...baseConfig,
+  // 여기에 오버라이딩 설정을 작성할 수 있습니다.
+  printWidth: 100,
+  semi: true,
+})
+```
+
+
+<br />
+
+## Formatter Options
+
+이 패키지에 적용된 기본 포맷팅 옵션은 다음과 같습니다:
+
+| 옵션          | 값       | 설명                                          |
+| ------------- | -------- | --------------------------------------------- |
+| printWidth    | 80       | 한 줄의 최대 길이                             |
+| tabWidth      | 2        | 들여쓰기 공백 수                              |
+| useTabs       | false    | 탭 대신 공백 사용                             |
+| semi          | false    | 문장 끝 세미콜론 제거                         |
+| singleQuote   | true     | 작은따옴표 사용                               |
+| trailingComma | 'all'    | 가능한 모든 곳에 trailing comma 추가          |
+| arrowParens   | 'always' | 화살표 함수 매개변수에 항상 괄호 사용         |
+
+<br />

package/README.md

@@ -1,67 +1,64 @@
 # oxc-formatter-config
 
-이 패키지는 Prettier와 oxc 플러그인(`@prettier/plugin-oxc`)을 사용한 코드 포맷팅 설정을 제공합니다.
+[English](./README.md) | [한국어](./README.ko.md)
+
+This package provides code formatting configuration using [oxfmt](https://oxc.rs/docs/guide/usage/formatter).
 
 ## Installation
 
 ```bash
-pnpm add -D prettier @prettier/plugin-oxc @cocopalm/oxc-formatter-config
+pnpm add -D oxfmt @cocopalm/oxc-formatter-config
 ```
 
 ## How to use
 
-### .prettierrc.mjs 설정하기
+### Setting up oxfmt.config.ts
 
-프로젝트 루트 디렉토리에 `.prettierrc.mjs` 파일을 생성합니다.
+Create an `oxfmt.config.ts` file in your project root directory.
 
 ```bash
-touch .prettierrc.mjs
+touch oxfmt.config.ts
 ```
 
-설정 파일에서 `@cocopalm/oxc-formatter-config`를 불러옵니다.
+Import `@cocopalm/oxc-formatter-config` in your configuration file.
 
 ```js
-// .prettierrc.mjs
+// oxfmt.config.ts
 
 import config from '@cocopalm/oxc-formatter-config'
 
 export default config
 ```
 
-`package.json` 에 포맷팅 스크립트를 추가해주세요.
+Add formatting scripts to your `package.json`.
 
 ```json
 // package.json
 
 {
   "scripts": {
-    "format": "prettier . --write",
-    "format:check": "prettier . --check"
+    "format": "oxfmt .",
+    "format:check": "oxfmt . --check"
   }
 }
 ```
 
 ### Config Override
 
-기본 설정을 오버라이드하고 싶다면 다음과 같이 설정을 확장할 수 있습니다.
+If you want to override the default settings, you can extend the configuration as follows.
 
-```js
-// .prettierrc.mjs
+```ts
+// oxfmt.config.ts
 
+import { defineConfig } from 'oxfmt'
 import baseConfig from '@cocopalm/oxc-formatter-config'
 
-/**
- * @see https://prettier.io/docs/configuration
- * @type {import("prettier").Config}
- */
-const config = {
+export default defineConfig({
   ...baseConfig,
-  // 여기에 오버라이딩 설정을 작성할 수 있습니다.
+  // Add your custom overrides here.
   printWidth: 100,
   semi: true,
-}
-
-export default config
+})
 ```
 
 
@@ -69,17 +66,16 @@ export default config
 
 ## Formatter Options
 
-이 패키지에 적용된 기본 포맷팅 옵션은 다음과 같습니다:
-
-| 옵션            | 값       | 설명                                   |
-| --------------- | -------- | -------------------------------------- |
-| printWidth      | 80       | 한 줄의 최대 길이                      |
-| tabWidth        | 2        | 들여쓰기 공백 수                       |
-| useTabs         | false    | 탭 대신 공백 사용                      |
-| semi            | false    | 문장 끝 세미콜론 제거                  |
-| singleQuote     | true     | 작은따옴표 사용                        |
-| trailingComma   | 'all'    | 가능한 모든 곳에 trailing comma 추가   |
-| arrowParens     | 'always' | 화살표 함수 매개변수에 항상 괄호 사용  |
-| plugins         | [@prettier/plugin-oxc] | OXC 플러그인 사용 |
+The default formatting options applied in this package are as follows:
+
+| Option        | Value   | Description                                                  |
+| ------------- | ------- | ------------------------------------------------------------ |
+| printWidth    | 80      | Maximum line length                                          |
+| tabWidth      | 2       | Number of spaces for indentation                             |
+| useTabs       | false   | Use spaces instead of tabs                                   |
+| semi          | false   | Omit semicolons at the end of statements                     |
+| singleQuote   | true    | Use single quotes                                            |
+| trailingComma | 'all'   | Add trailing commas wherever possible                        |
+| arrowParens   | 'always'| Always wrap arrow function parameters in parentheses         |
 
 <br />

package/oxfmt.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'oxfmt'
+
+export default defineConfig({
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  arrowParens: 'always',
+})

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@cocopalm/oxc-formatter-config",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "oxc formatter configuration",
   "author": "puffcocos",
   "license": "MIT",
   "type": "module",
-  "main": "./prettier.config.js",
+  "main": "./oxfmt.config.ts",
   "files": [
-    "prettier.config.js"
+    "oxfmt.config.ts"
   ],
   "keywords": [
     "oxc",
-    "prettier",
+    "oxfmt",
     "formatter",
     "config"
   ],
@@ -24,11 +24,9 @@
     "provenance": true
   },
   "devDependencies": {
-    "prettier": "^3.7.4",
-    "@prettier/plugin-oxc": "^0.1.3"
+    "oxfmt": "^0.42.0"
   },
   "peerDependencies": {
-    "prettier": "^3.7.4",
-    "@prettier/plugin-oxc": "^0.1.3"
+    "oxfmt": ">=0.42.0"
   }
 }

package/prettier.config.js

@@ -1,16 +0,0 @@
-/**
- * @see https://prettier.io/docs/configuration
- * @type {import("prettier").Config}
- */
-const config = {
-  printWidth: 80,
-  tabWidth: 2,
-  useTabs: false,
-  semi: false,
-  singleQuote: true,
-  trailingComma: 'all',
-  arrowParens: 'always',
-  plugins: ['@prettier/plugin-oxc'],
-}
-
-export default config