@pikacss/plugin-reset 0.0.46 → 0.0.48

package/README.md

@@ -0,0 +1,29 @@
+# @pikacss/plugin-reset
+
+CSS reset plugin for PikaCSS. Injects popular CSS reset stylesheets as preflight styles.
+
+## Installation
+
+```bash
+pnpm add -D @pikacss/plugin-reset
+```
+
+## Usage
+
+```ts
+import { defineEngineConfig } from '@pikacss/core'
+import { reset } from '@pikacss/plugin-reset'
+
+export default defineEngineConfig({
+  plugins: [reset()],
+  reset: 'modern-normalize', // default
+})
+```
+
+## Documentation
+
+See the [full documentation](https://pikacss.com/guide/plugins/reset).
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -8,17 +8,52 @@ declare const resetStyles: {
   normalize: string;
   'the-new-css-reset': string;
 };
+/**
+ * Union of built-in CSS reset stylesheet names supported by the reset plugin.
+ *
+ * @remarks
+ * Each value maps to a well-known CSS reset: Andy Bell's modern reset,
+ * Eric Meyer's classic reset, modern-normalize, normalize.css, and
+ * The New CSS Reset. The chosen name is passed to the `reset` engine
+ * config option to select which stylesheet is injected as a preflight.
+ *
+ * @example
+ * ```ts
+ * const style: ResetStyle = 'modern-normalize'
+ * ```
+ */
 type ResetStyle = keyof typeof resetStyles;
 declare module '@pikacss/core' {
   interface EngineConfig {
     /**
-     * Reset style to use.
+     * CSS reset stylesheet to inject as a preflight.
      *
-     * @default 'modern-normalize'
+     * @default `'modern-normalize'`
      */
     reset?: ResetStyle;
   }
 }
+/**
+ * Creates a PikaCSS engine plugin that injects a CSS reset stylesheet as a preflight.
+ *
+ * @returns An engine plugin that registers a reset preflight on the `reset` layer.
+ *
+ * @remarks
+ * The plugin reads the `reset` option from the engine config to select a
+ * stylesheet. If unset, it defaults to `'modern-normalize'`. A dedicated
+ * `reset` layer with order `-1` is created so the reset styles always
+ * appear before utility output.
+ *
+ * @example
+ * ```ts
+ * import { reset } from '@pikacss/plugin-reset'
+ *
+ * export default defineEngineConfig({
+ *   plugins: [reset()],
+ *   reset: 'eric-meyer',
+ * })
+ * ```
+ */
 declare function reset(): EnginePlugin;
 //#endregion
 export { ResetStyle, reset };

package/dist/index.mjs

@@ -1,6 +1,15 @@
 import { defineEnginePlugin } from "@pikacss/core";
-
 //#region src/resets/andy-bell.ts
+/**
+* Andy Bell's "A Modern CSS Reset" stylesheet as a raw CSS string.
+*
+* Provides opinionated defaults: border-box sizing, margin removal, smooth
+* scroll, reduced-motion media query, and inheritable fonts on form elements.
+*
+* @see {@link https://piccalil.li/blog/a-modern-css-reset/}
+*
+* @internal
+*/
 var andy_bell_default = `
 /* Box sizing rules */
 *,
@@ -77,9 +86,19 @@ select {
   }
 }
 `;
-
 //#endregion
 //#region src/resets/eric-meyer.ts
+/**
+* Eric Meyer's CSS Reset v5.0.2 stylesheet as a raw CSS string.
+*
+* A classic aggressive reset that zeroes out margin, padding, border, and
+* font-size on nearly all HTML elements, removes list styles, resets quotes,
+* and collapses table borders. Public domain.
+*
+* @see {@link https://meyerweb.com/eric/tools/css/reset/}
+*
+* @internal
+*/
 var eric_meyer_default = `
 /* http://meyerweb.com/eric/tools/css/reset/ 
    v5.0.2 | 20191019
@@ -134,9 +153,20 @@ table {
 	border-spacing: 0;
 }
 `;
-
 //#endregion
 //#region src/resets/modern-normalize.ts
+/**
+* modern-normalize v3.0.1 stylesheet as a raw CSS string.
+*
+* Normalizes browser defaults with modern sensibilities: border-box sizing,
+* system-ui font stack, consistent `hr`/`abbr`/`table`/`form` rendering,
+* and improved defaults for interactive and embedded elements.
+* This is the default reset variant used by the `reset()` plugin.
+*
+* @see {@link https://github.com/sindresorhus/modern-normalize}
+*
+* @internal
+*/
 var modern_normalize_default = `
 /*! modern-normalize v3.0.1 | MIT License | https://github.com/sindresorhus/modern-normalize */
 
@@ -377,9 +407,19 @@ summary {
 	display: list-item;
 }
 `;
-
 //#endregion
 //#region src/resets/normalize.ts
+/**
+* normalize.css v8.0.1 stylesheet as a raw CSS string.
+*
+* Preserves useful browser defaults while normalizing cross-browser
+* inconsistencies in line-height, font-size, margins, form elements, and
+* HTML5 display roles. MIT licensed.
+*
+* @see {@link https://github.com/necolas/normalize.css}
+*
+* @internal
+*/
 var normalize_default = `
 /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
 
@@ -731,9 +771,20 @@ template {
   display: none;
 }
 `;
-
 //#endregion
 //#region src/resets/the-new-css-reset.ts
+/**
+* The New CSS Reset v1.11.3 stylesheet as a raw CSS string.
+*
+* Uses `all: unset` with `display: revert` to strip all User-Agent styles
+* except `display`, then re-applies specific opinionated defaults for
+* box-sizing, text-size-adjust, cursors, list styles, tables, textareas,
+* and media elements.
+*
+* @see {@link https://github.com/elad2412/the-new-css-reset}
+*
+* @internal
+*/
 var the_new_css_reset_default = `
 /***
     The new CSS reset - version 1.11.3 (last updated 25.08.2024)
@@ -851,7 +902,6 @@ meter {
     display: none;
 }
 `;
-
 //#endregion
 //#region src/index.ts
 const resetStyles = {
@@ -861,6 +911,27 @@ const resetStyles = {
 	"normalize": normalize_default,
 	"the-new-css-reset": the_new_css_reset_default
 };
+/**
+* Creates a PikaCSS engine plugin that injects a CSS reset stylesheet as a preflight.
+*
+* @returns An engine plugin that registers a reset preflight on the `reset` layer.
+*
+* @remarks
+* The plugin reads the `reset` option from the engine config to select a
+* stylesheet. If unset, it defaults to `'modern-normalize'`. A dedicated
+* `reset` layer with order `-1` is created so the reset styles always
+* appear before utility output.
+*
+* @example
+* ```ts
+* import { reset } from '@pikacss/plugin-reset'
+*
+* export default defineEngineConfig({
+*   plugins: [reset()],
+*   reset: 'eric-meyer',
+* })
+* ```
+*/
 function reset() {
 	let style = "modern-normalize";
 	return defineEnginePlugin({
@@ -880,6 +951,5 @@ function reset() {
 		}
 	});
 }
-
 //#endregion
-export { reset };
+export { reset };

package/package.json

@@ -4,12 +4,13 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.46",
+  "version": "0.0.48",
   "author": "DevilTea <ch19980814@gmail.com>",
   "license": "MIT",
+  "homepage": "https://pikacss.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pikacss/pikacss.git",
+    "url": "git+https://github.com/pikacss/pikacss.git",
     "directory": "packages/plugin-reset"
   },
   "bugs": {
@@ -20,6 +21,7 @@
     "pikacss-plugin",
     "reset"
   ],
+  "sideEffects": false,
   "exports": {
     ".": {
       "import": {
@@ -33,20 +35,22 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=22"
+  },
   "peerDependencies": {
-    "@pikacss/core": "0.0.46"
+    "@pikacss/core": "0.0.48"
   },
   "devDependencies": {
-    "@pikacss/core": "0.0.46"
+    "@pikacss/core": "0.0.48"
   },
   "scripts": {
     "build": "tsdown",
     "build:watch": "tsdown --watch",
-    "build:pack": "pnpm build && pnpm pack",
     "typecheck": "pnpm typecheck:package && pnpm typecheck:test",
     "typecheck:package": "tsc --project ./tsconfig.package.json --noEmit",
     "typecheck:test": "tsc --project ./tsconfig.tests.json --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
+    "test": "vitest run --config ./vitest.config.ts",
+    "test:watch": "vitest --config ./vitest.config.ts"
   }
 }