@riebeckite/plugin-quality 0.0.32 → 0.0.33

package/README.md

@@ -8,7 +8,7 @@ Static quality and accessibility inspection for generated HTML in Riebeckite.
 
 ## Overview
 
-`qualityPlugin()` runs a small set of dependency-free, regex-based rules over
+`quality()` runs a small set of dependency-free, regex-based rules over
 the HTML produced by the build and reports the findings through the shared
 diagnostics channel. There is no DOM, no axe-core, and no headless browser.
 
@@ -20,11 +20,11 @@ exported `inspectGeneratedHtml` hook for final pages.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { qualityPlugin } from "@riebeckite/plugin-quality";
+import { quality } from "@riebeckite/plugin-quality";
 
 export default defineConfig({
   // ...
-  plugins: [qualityPlugin({ failOn: "error" })],
+  plugins: [quality({ failOn: "error" })],
 });
 ```
 
@@ -50,7 +50,7 @@ export default defineConfig({
 
 ## API
 
-- `qualityPlugin(options?)` — plugin factory.
+- `quality(options?)` — plugin factory.
 - `inspectHtml(html, options?)` — pure function returning `Diagnostic[]`.
 - `inspectGeneratedHtml(page, options?)` — pure function that inspects a final
   page and sets `filePath` to `page.path`.

package/README_ja.md

@@ -8,19 +8,19 @@ Riebeckite が生成する HTML を静的に検査し、品質とアクセシビ
 
 ## 概要
 
-`qualityPlugin()` は、ビルドで生成された HTML に対して依存パッケージなしの正規表現ベースのルールを実行し、結果を既存の diagnostics に流します。DOM も axe-core もヘッドレスブラウザも使いません。
+`quality()` は、ビルドで生成された HTML に対して依存パッケージなしの正規表現ベースのルールを実行し、結果を共通の診断チャネルへ流します。DOM も axe-core もヘッドレスブラウザも使いません。
 
-マニフェスト生成の段階では、公開エントリごとの記事 HTML を検査します。HTML 生成を完了する統合側は、公開ページ向けに公開 API の `inspectGeneratedHtml` を追加で呼び出せます。
+マニフェスト生成の段階では、公開エントリごとの記事 HTML を検査します。HTML 生成を完了する統合側は、最終ページに対して公開 API の `inspectGeneratedHtml` を追加で呼び出せます。
 
 ## 使い方
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { qualityPlugin } from "@riebeckite/plugin-quality";
+import { quality } from "@riebeckite/plugin-quality";
 
 export default defineConfig({
   // ...
-  plugins: [qualityPlugin({ failOn: "error" })],
+  plugins: [quality({ failOn: "error" })],
 });
 ```
 
@@ -28,9 +28,9 @@ export default defineConfig({
 
 | オプション | 型 | 説明 |
 | ---------- | -- | ---- |
-| `ignoreRules` | `string[]` | 抑制する diagnostic の code（例: `"quality:empty-link-text"`）。 |
+| `ignoreRules` | `string[]` | 抑制する診断コード（例: `"quality:empty-link-text"`）。 |
 | `a11y` | `{ enabled?: boolean }` | アクセシビリティ検査。既定は有効で、`enabled: false` で全ルールを止めます。 |
-| `failOn` | `"error" \| "never"` | マニフェスト段階で error の diagnostic があればビルドを失敗させます。既定は `"never"`。 |
+| `failOn` | `"error" \| "never"` | マニフェスト段階で error の診断があればビルドを失敗させます。既定は `"never"`。 |
 
 ## ルール一覧
 
@@ -46,7 +46,7 @@ export default defineConfig({
 
 ## API
 
-- `qualityPlugin(options?)`：プラグインファクトリ。
+- `quality(options?)`：プラグインファクトリ。
 - `inspectHtml(html, options?)`：`Diagnostic[]` を返す純粋関数。
 - `inspectGeneratedHtml(page, options?)`：最終ページを検査し、`filePath` に `page.path` を設定する純粋関数。
 - `RULE_CODES`：安定した code の一覧。
@@ -54,7 +54,7 @@ export default defineConfig({
 
 ## 制限事項
 
-スキャナは正規表現ベースであり、実際の DOM ではありません。不正なマークアップの検証やネストの深さの追跡は行わず、開始タグと終了タグの対応付けは整形式でネストのない要素だけを扱います。走査の前にコメントと `<script>`・`<style>` の中身はマスクします。そのため、文書構造に依存するルール（見出し順、テーブルヘッダー）は、特殊なマークアップでは検出漏れや誤検出が起こりえます。
+スキャナーは正規表現ベースであり、実際の DOM ではありません。不正なマークアップの検証やネストの深さの追跡は行わず、開始タグと終了タグの対応付けは整形式でネストのない要素だけを扱います。走査の前にコメントと `<script>`・`<style>` の中身はマスクします。そのため、文書構造に依存するルール（見出し順、テーブルヘッダー）は、特殊なマークアップでは検出漏れや誤検出が起こりえます。
 
 ## 関連
 

package/dist/index.d.ts

@@ -16,5 +16,4 @@ export declare function inspectGeneratedHtml(page: PluginGeneratedHtml, options?
  * field lets an SSG integration inspect final pages after the build, where no
  * manifest is available.
  */
-export declare function qualityPlugin(options?: QualityOptions): RiebeckitePlugin;
-export declare const quality: typeof qualityPlugin;
+export declare function quality(options?: QualityOptions): RiebeckitePlugin;

package/dist/index.js

@@ -364,7 +364,7 @@ function inspectGeneratedHtml(page, options = {}) {
     filePath: page.path
   }));
 }
-function qualityPlugin(options = {}) {
+function quality(options = {}) {
   const resolved = resolveQualityOptions(options);
   const inspectOptions = {
     ignoreRules: options.ignoreRules,
@@ -401,12 +401,10 @@ ${details}`
     }
   });
 }
-var quality = qualityPlugin;
 export {
   QUALITY_PLUGIN_NAME,
   RULE_CODES,
   inspectGeneratedHtml,
   inspectHtml,
-  quality,
-  qualityPlugin
+  quality
 };

package/dist/src/scanner.d.ts

@@ -32,13 +32,9 @@ export declare function maskIgnoredRegions(html: string): string;
  * removed by {@link maskIgnoredRegions}.
  */
 export declare function scanElements(document: string): HtmlElement[];
-/** Parses an attribute list into a lowercase-keyed map. */
-export declare function parseAttributes(text: string): Map<string, string>;
 /** Extracts text content, dropping tags and decoding common entities. */
 export declare function textContent(fragment: string): string;
 /** Returns the raw attribute value, or `undefined` when it is absent. */
 export declare function attribute(element: HtmlElement, name: string): string | undefined;
 /** True when the attribute is present and its value is not blank. */
 export declare function hasNonEmptyAttribute(element: HtmlElement, name: string): boolean;
-/** Decodes a small set of named and numeric HTML entities. */
-export declare function decodeHtmlEntities(value: string): string;

package/dist/src/types.d.ts

@@ -16,7 +16,7 @@ export type InspectOptions = {
     };
 };
 /**
- * Options for {@link qualityPlugin}. Extends the inspection options with a
+ * Options for {@link quality}. Extends the inspection options with a
  * build-failure policy.
  */
 export type QualityOptions = InspectOptions & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-quality",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33"
   },
   "devDependencies": {
     "tsx": "^4.22.4"