@daracl/form 0.0.20 → 0.0.22

package/README.md

@@ -20,23 +20,41 @@ Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
 </p>
 
 
-1. Install
-
-```sh
-yarn install
-# OR
-npm install
-```
-
-2. Run
-
-```sh
-npm start
-```
-
-3. Open `http://localhost:8889` in your browser
-
-
+## Development
+
+Install Node.js 24 LTS and npm. With nvm, run `nvm use` first.
+
+```sh
+git clone https://github.com/daracl/ui-form.git
+cd ui-form
+npm ci
+npm run dev
+```
+
+Open the address printed by Vite at `/uitest/index.html`. `npm start` starts the same server.
+
+- `npm run typecheck`: TypeScript checks
+- `npm test`: shared utility regression tests
+- `npm run build`: ES/CJS, UMD, CSS and declarations
+- `npm run verify`: type checks, Node tests, builds and package smoke tests
+
+Browser regression tests cover the six examples and form interactions. Run `npx playwright install chromium` once, then `npm run verify` followed by `npm run pwtest` (the browser suite also checks the generated dist bundles). To use an already installed Edge instead, set `PLAYWRIGHT_CHANNEL=msedge` in your shell. CI runs both `verify` and browser tests. Browser tests start and stop their own server; no manually running dev server is needed.
+
+Build configuration is ESM (`vite.config.mjs`). `npm run build` uses one Node process for Vite, generates declarations in parallel, cleans `dist` once and copies public assets once. ES/CJS, UMD, CSS and sourcemap filenames stay unchanged. `npm run build:escjs` and `npm run build:umd` only refresh their own bundles; use the full build for packaging.
+
+The dev/preview server binds to the local machine by default and restricts file access to this checkout. Use `npm run dev -- --host` only when LAN access is intentional. Host validation and Vite's default CORS restrictions remain enabled.
+
+`npm run audit:security` checks production dependencies; `npm run audit:security:all` includes development tools. esbuild is overridden to the patched version for toast's unused build-tool dependency too. Removed unused Webpack loaders, cpx, TSLint, Jest and legacy documentation dependencies. Tests use Node's built-in test runner; file operations use Node's filesystem APIs.
+
+See [build verification results](BUILD.md) for timing, security checks and compatibility limits.
+
+Shared utilities use the public npm package `@daracl/core@0.0.10`. No sibling corejs checkout, absolute path, npm link or private server is required. Commit package.json and package-lock.json together; teammates install with `npm ci`. Publish corejs changes before updating this dependency. Utilities import the public `@daracl/core/utils` entry point, which avoids loading the core root module and its styles.
+
+The npm override unifies core at 0.0.10 because the current toast and datetimepicker packages declare older core peer ranges. Recheck their compatibility when upgrading. Overrides apply to this repository; consumers of the published form package may need the same override until those peer ranges are updated upstream.
+
+Type checks, blank checks, own-property checks, deep merges, HTML escaping, template-to-element conversion and CSS class whitespace normalization delegate to core. `replaceXss` and `unReplace` alias core's `xss` and `unXss`; form-specific field-name transformations stay here. `isEmpty` still means null/undefined only; numeric checks preserve existing coercion. Merge returns a new object and follows core array merging rules while excluding prototype pollution keys.
+
+
 # 사용방법
 ```
 const form = new DaraForm("#loginForm", {
@@ -142,5 +160,20 @@ type: {
 | identical | field 값이 같은지 비교 | field: field name <br> message: 메시지   |  |
 
 
+# 테마
+
+색상 값은 [`@daracl/ui-style`](https://www.npmjs.com/package/@daracl/ui-style) 의 테마 변수(`--dui-*`)를 사용합니다.
+light 값이 기본값으로 들어 있어 별도 설정 없이도 표시되지만, **dark 테마를 쓰려면 테마 변수 CSS 를 함께 로드**해야 합니다.
+(`daracl.form.umd` 와 함께 쓰는 CSS 에는 이미 포함되어 있습니다.)
+
+```js
+import '@daracl/ui-style/theme-vars.css';
+
+// dark 로 전환
+document.documentElement.setAttribute('data-daracl-theme', 'dark');
+```
+
+> 이전 버전의 `body.dark` / `.daracl-form.dark` 클래스 방식은 지원하지 않습니다. `data-daracl-theme` 속성만 사용합니다.
+
 ## License
-Darainfo is under [MIT License](./LICENSE).
+Darainfo is under [MIT License](./LICENSE).