@markuplint/alpine-spec 5.0.0-rc.2 → 5.0.0-rc.5

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0-rc.5](https://github.com/markuplint/markuplint/compare/v5.0.0-rc.4...v5.0.0-rc.5) (2026-08-28)
+
+**Note:** Version bump only for package @markuplint/alpine-spec
+
+# [5.0.0-rc.4](https://github.com/markuplint/markuplint/compare/v5.0.0-rc.3...v5.0.0-rc.4) (2026-04-19)
+
+**Note:** Version bump only for package @markuplint/alpine-spec
+
+# [5.0.0-rc.3](https://github.com/markuplint/markuplint/compare/v5.0.0-rc.2...v5.0.0-rc.3) (2026-04-19)
+
+**Note:** Version bump only for package @markuplint/alpine-spec
+
 # [5.0.0-rc.2](https://github.com/markuplint/markuplint/compare/v5.0.0-rc.1...v5.0.0-rc.2) (2026-04-15)
 
 **Note:** Version bump only for package @markuplint/alpine-spec

package/lib/index.d.ts

@@ -10,6 +10,12 @@
  * Alpine.js is a lightweight JavaScript framework that provides
  * reactive and declarative features directly in HTML markup.
  *
+ * This package is merged into the base HTML spec by `schemaToSpec`
+ * in `@markuplint/ml-spec`. It intentionally has no test suite:
+ * conformance is enforced at build time by the `ExtendedSpec` type,
+ * and the merged spec is exercised by the downstream
+ * `@markuplint/ml-spec` and `@markuplint/ml-core` tests.
+ *
  * @see https://alpinejs.dev/
  */
 import type { ExtendedSpec } from '@markuplint/ml-spec';

package/lib/index.js

@@ -10,6 +10,12 @@
  * Alpine.js is a lightweight JavaScript framework that provides
  * reactive and declarative features directly in HTML markup.
  *
+ * This package is merged into the base HTML spec by `schemaToSpec`
+ * in `@markuplint/ml-spec`. It intentionally has no test suite:
+ * conformance is enforced at build time by the `ExtendedSpec` type,
+ * and the merged spec is exercised by the downstream
+ * `@markuplint/ml-spec` and `@markuplint/ml-core` tests.
+ *
  * @see https://alpinejs.dev/
  */
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/alpine-spec",
-	"version": "5.0.0-rc.2",
+	"version": "5.0.0-rc.5",
 	"description": "Extended specification for tags and attributes in Alpine.js",
 	"repository": {
 		"type": "git",
@@ -10,7 +10,7 @@
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
 	"license": "MIT",
 	"engines": {
-		"node": ">=22"
+		"node": ">=24"
 	},
 	"type": "module",
 	"exports": {
@@ -28,7 +28,7 @@
 		"clean": "tsc --build --clean tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/ml-spec": "5.0.0-rc.2"
+		"@markuplint/ml-spec": "5.0.0-rc.5"
 	},
-	"gitHead": "e43763858d9234c417053becc73dbd088c1e7ea6"
+	"gitHead": "8d87463af2ff3f1b83fb28da20f1819362cf3555"
 }

package/ARCHITECTURE.md

@@ -1,123 +0,0 @@
-# @markuplint/alpine-spec
-
-## Overview
-
-`@markuplint/alpine-spec` is a spec extension package that provides Alpine.js-specific directive definitions for markuplint. It exports a single `ExtendedSpec` object that registers global Alpine.js directives (such as `x-data`, `x-show`, `x-bind`, `x-on`, `x-model`, `x-text`, `x-html`, `x-ref`, `x-if`, `x-for`, `x-transition`, `x-effect`, `x-ignore`, `x-cloak`, etc.) available on every HTML element.
-
-This package contains no parsing logic -- it is purely a data definition consumed by `@markuplint/ml-spec` to extend the base HTML specification with Alpine.js-specific attributes.
-
-## ExtendedSpec Content
-
-### Global Attributes
-
-Global attributes are defined under `def['#globalAttrs']['#extends']` and are available on every HTML element:
-
-#### Component Initialization
-
-| Attribute | Type  | Description                                                      |
-| --------- | ----- | ---------------------------------------------------------------- |
-| `x-data`  | `Any` | Declares an Alpine component and defines its reactive data scope |
-| `x-init`  | `Any` | Hooks into the initialization phase                              |
-
-#### Rendering & Visibility
-
-| Attribute | Type  | Description                                         |
-| --------- | ----- | --------------------------------------------------- |
-| `x-show`  | `Any` | Toggles element visibility via CSS display property |
-| `x-if`    | `Any` | Conditionally adds/removes elements from the DOM    |
-| `x-for`   | `Any` | Renders elements by iterating over collections      |
-
-#### Content Binding
-
-| Attribute | Type  | Description                         |
-| --------- | ----- | ----------------------------------- |
-| `x-text`  | `Any` | Sets the textContent of the element |
-| `x-html`  | `Any` | Sets the innerHTML of the element   |
-
-#### Data Binding
-
-| Attribute     | Type  | Description                                                 |
-| ------------- | ----- | ----------------------------------------------------------- |
-| `x-model`     | `Any` | Creates two-way data binding between form elements and data |
-| `x-modelable` | `Any` | Exposes a property as the target of an outer x-model        |
-
-#### Reactivity
-
-| Attribute  | Type  | Description                                                    |
-| ---------- | ----- | -------------------------------------------------------------- |
-| `x-effect` | `Any` | Reactively re-evaluates an expression when dependencies change |
-
-#### DOM Manipulation & References
-
-| Attribute    | Type  | Description                                       |
-| ------------ | ----- | ------------------------------------------------- |
-| `x-ref`      | `Any` | Marks an element for access via $refs             |
-| `x-teleport` | `Any` | Moves DOM content to another location in the page |
-| `x-id`       | `Any` | Declares a scope for auto-generated IDs via $id() |
-
-#### Transitions
-
-| Attribute                  | Type  | Description                           |
-| -------------------------- | ----- | ------------------------------------- |
-| `x-transition`             | `Any` | Applies CSS transition animations     |
-| `x-transition:enter`       | `Any` | CSS classes for the entering phase    |
-| `x-transition:enter-start` | `Any` | CSS classes before element insertion  |
-| `x-transition:enter-end`   | `Any` | CSS classes after element insertion   |
-| `x-transition:leave`       | `Any` | CSS classes for the leaving phase     |
-| `x-transition:leave-start` | `Any` | CSS classes when leaving is triggered |
-| `x-transition:leave-end`   | `Any` | CSS classes after leave starts        |
-
-#### Processing Control
-
-| Attribute  | Type      | Description                                                         |
-| ---------- | --------- | ------------------------------------------------------------------- |
-| `x-ignore` | `Boolean` | Prevents Alpine from initializing the element                       |
-| `x-cloak`  | `Boolean` | Hidden until Alpine initializes; prevents flash of unstyled content |
-
-## Directory Structure
-
-```
-src/
-└── index.ts    — Exports the ExtendedSpec object with Alpine.js-specific attributes
-```
-
-## Key Source Files
-
-| File       | Purpose                                                             |
-| ---------- | ------------------------------------------------------------------- |
-| `index.ts` | Defines and exports the `ExtendedSpec` object as the default export |
-
-## Integration Points
-
-```mermaid
-flowchart LR
-    subgraph upstream ["Upstream"]
-        htmlSpec["@markuplint/html-spec\n(Base HTML spec)"]
-    end
-
-    subgraph pkg ["@markuplint/alpine-spec"]
-        spec["ExtendedSpec\n(Alpine.js directives)"]
-    end
-
-    subgraph downstream ["Downstream"]
-        mlSpec["@markuplint/ml-spec\n(Spec resolution)"]
-        mlCore["@markuplint/ml-core\n(Linting engine)"]
-    end
-
-    htmlSpec -->|"Base spec"| mlSpec
-    spec -->|"Extends"| mlSpec
-    mlSpec -->|"Resolved spec"| mlCore
-```
-
-### Upstream
-
-- **`@markuplint/ml-spec`** -- Provides the `ExtendedSpec` type that this package implements
-
-### Downstream
-
-- **`@markuplint/ml-spec`** -- Consumes the `ExtendedSpec` object to merge Alpine.js-specific attributes into the resolved specification
-- **`@markuplint/ml-core`** -- Uses the resolved spec (including Alpine.js extensions) during linting
-
-## Documentation Map
-
-- [Maintenance Guide](docs/maintenance.md) -- Commands, recipes, and ExtendedSpec type reference

package/SKILL.md

@@ -1,64 +0,0 @@
----
-description: Maintenance tasks for @markuplint/alpine-spec
-globs:
-  - packages/@markuplint/alpine-spec/src/**/*.ts
-alwaysApply: false
----
-
-# alpine-spec-maintenance
-
-Perform maintenance tasks for `@markuplint/alpine-spec`: add global attributes
-and modify the ExtendedSpec object.
-
-## Input
-
-`$ARGUMENTS` specifies the task. Supported tasks:
-
-| Task                   | Description                                    |
-| ---------------------- | ---------------------------------------------- |
-| `add-global-attribute` | Add a new global attribute to the ExtendedSpec |
-
-If omitted, defaults to `add-global-attribute`.
-
-## Reference
-
-Before executing any task, read `docs/maintenance.md` (or `docs/maintenance.ja.md`)
-for the full guide. The recipes there are the source of truth for procedures.
-
-Also read:
-
-- `ARCHITECTURE.md` -- Package overview, ExtendedSpec content, and integration points
-- `src/index.ts` -- ExtendedSpec object definition (source of truth)
-
-## Task: add-global-attribute
-
-Add a new global Alpine.js directive available on every HTML element. Follow recipe #1 in `docs/maintenance.md`.
-
-### Step 1: Identify the attribute
-
-1. Determine the directive name, type (`Any`, `Boolean`, or a specific type), and description
-2. Check the Alpine.js documentation to confirm the directive is valid
-
-### Step 2: Add the attribute
-
-1. Read `src/index.ts`
-2. Add a new entry under `def['#globalAttrs']['#extends']`:
-   ```ts
-   'x-directiveName': {
-       type: 'Any', // or 'Boolean'
-   },
-   ```
-3. Add a JSDoc comment above the entry describing its purpose
-
-### Step 3: Verify
-
-1. Build: `yarn build --scope @markuplint/alpine-spec`
-2. Confirm the attribute appears in the exported spec object
-
-## Rules
-
-1. **Only export an ExtendedSpec object** -- this package contains no parsing logic.
-2. **All Alpine.js directives are global** -- they go under `def['#globalAttrs']['#extends']`.
-3. **Alpine.js directives are prefixed with `x-`** -- follow this naming convention.
-4. **Each attribute needs at minimum a `type` field** -- valid types include `Any`, `Boolean`, and specific type strings.
-5. **Add JSDoc comments** to all new attribute entries describing their purpose.

package/docs/maintenance.ja.md

@@ -1,76 +0,0 @@
-# メンテナンスガイド
-
-## コマンド
-
-| コマンド                                     | 説明                   |
-| -------------------------------------------- | ---------------------- |
-| `yarn build --scope @markuplint/alpine-spec` | このパッケージをビルド |
-| `yarn dev --scope @markuplint/alpine-spec`   | ウォッチモードでビルド |
-| `yarn clean --scope @markuplint/alpine-spec` | ビルド成果物を削除     |
-
-## テスト
-
-このパッケージには専用のテストスイートはありません。`ExtendedSpec` オブジェクトは、`@markuplint/ml-spec` の `ExtendedSpec` 型に対する TypeScript 型チェックにより、ビルド時に検証されます。エクスポートされたオブジェクトが型に適合しない場合、ビルドが失敗します。
-
-統合テストは下流で行われます:
-
-- `@markuplint/ml-spec` が拡張仕様を解決し、基本 HTML 仕様とマージ
-- `@markuplint/ml-core` がリント時に解決済み仕様を使用し、属性定義を実行
-
-変更を検証するには、パッケージをビルドして下流のテストを実行します:
-
-```shell
-yarn build --scope @markuplint/alpine-spec
-yarn test --scope @markuplint/ml-spec --scope @markuplint/ml-core
-```
-
-## レシピ
-
-### 1. グローバル属性の追加
-
-Alpine.js のディレクティブはすべてグローバルです -- すべての HTML 要素で利用可能です。
-
-1. `src/index.ts` を開く
-2. `def['#globalAttrs']['#extends']` の下に新しいエントリを追加:
-   ```ts
-   /** ディレクティブの説明 */
-   'x-directiveName': {
-       type: 'Any', // または 'Boolean'
-   },
-   ```
-3. 適切な型を選択:
-   - `'Any'` -- 任意の値を受け付ける（文字列、式など）
-   - `'Boolean'` -- ブール属性（存在が `true` を意味する）
-4. ビルド: `yarn build --scope @markuplint/alpine-spec`
-
-## ExtendedSpec 型リファレンス
-
-`ExtendedSpec` 型（`@markuplint/ml-spec` から）は、このパッケージに関連する以下の構造を持ちます:
-
-```ts
-interface ExtendedSpec {
-  cites?: string[];
-  def?: {
-    '#globalAttrs'?: {
-      '#extends': Record<string, AttributeSpec>;
-    };
-  };
-  specs?: Array<{
-    name: string;
-    attributes: Record<string, AttributeSpec>;
-  }>;
-}
-```
-
-### AttributeSpec のフィールド
-
-| フィールド      | 型         | 必須   | 説明                                    |
-| --------------- | ---------- | ------ | --------------------------------------- |
-| `type`          | `string`   | はい   | 属性値の型（`'Any'`、`'Boolean'` など） |
-| `caseSensitive` | `boolean`  | いいえ | 属性名の大文字小文字を区別するかどうか  |
-| `condition`     | `string[]` | いいえ | 属性が適用される CSS セレクタ条件       |
-
-### 型の値
-
-- `'Any'` -- 属性は任意の値を受け付ける
-- `'Boolean'` -- 属性はブール値（存在が `true` を示す）

package/docs/maintenance.md

@@ -1,76 +0,0 @@
-# Maintenance Guide
-
-## Commands
-
-| Command                                      | Description            |
-| -------------------------------------------- | ---------------------- |
-| `yarn build --scope @markuplint/alpine-spec` | Build this package     |
-| `yarn dev --scope @markuplint/alpine-spec`   | Watch mode build       |
-| `yarn clean --scope @markuplint/alpine-spec` | Remove build artifacts |
-
-## Testing
-
-This package has no dedicated test suite. The `ExtendedSpec` object is validated at build time through TypeScript type checking against the `ExtendedSpec` type from `@markuplint/ml-spec`. If the exported object does not conform to the type, the build will fail.
-
-Integration testing occurs downstream:
-
-- `@markuplint/ml-spec` resolves the extended spec and merges it with the base HTML spec
-- `@markuplint/ml-core` uses the resolved spec during linting, which exercises the attribute definitions
-
-To verify changes, build the package and run downstream tests:
-
-```shell
-yarn build --scope @markuplint/alpine-spec
-yarn test --scope @markuplint/ml-spec --scope @markuplint/ml-core
-```
-
-## Recipes
-
-### 1. Adding a Global Attribute
-
-All Alpine.js directives are global -- they are available on every HTML element.
-
-1. Open `src/index.ts`
-2. Add a new entry under `def['#globalAttrs']['#extends']`:
-   ```ts
-   /** Description of the directive */
-   'x-directiveName': {
-       type: 'Any', // or 'Boolean'
-   },
-   ```
-3. Choose the appropriate type:
-   - `'Any'` -- accepts any value (strings, expressions, etc.)
-   - `'Boolean'` -- boolean attribute (presence indicates `true`)
-4. Build: `yarn build --scope @markuplint/alpine-spec`
-
-## ExtendedSpec Type Reference
-
-The `ExtendedSpec` type (from `@markuplint/ml-spec`) has the following structure relevant to this package:
-
-```ts
-interface ExtendedSpec {
-  cites?: string[];
-  def?: {
-    '#globalAttrs'?: {
-      '#extends': Record<string, AttributeSpec>;
-    };
-  };
-  specs?: Array<{
-    name: string;
-    attributes: Record<string, AttributeSpec>;
-  }>;
-}
-```
-
-### AttributeSpec Fields
-
-| Field           | Type       | Required | Description                                            |
-| --------------- | ---------- | -------- | ------------------------------------------------------ |
-| `type`          | `string`   | Yes      | The attribute value type (`'Any'`, `'Boolean'`, etc.)  |
-| `caseSensitive` | `boolean`  | No       | Whether the attribute name is case-sensitive           |
-| `condition`     | `string[]` | No       | CSS selector conditions for when the attribute applies |
-
-### Type Values
-
-- `'Any'` -- The attribute accepts any value
-- `'Boolean'` -- The attribute is a boolean (presence indicates `true`)