@markuplint/alpine-parser 4.6.22 → 4.6.23

package/CHANGELOG.md

@@ -3,13 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.6.22](https://github.com/markuplint/markuplint/compare/@markuplint/alpine-parser@4.6.21...@markuplint/alpine-parser@4.6.22) (2025-11-05)
+## [4.6.23](https://github.com/markuplint/markuplint/compare/@markuplint/alpine-parser@4.6.22...@markuplint/alpine-parser@4.6.23) (2026-02-10)
 
 **Note:** Version bump only for package @markuplint/alpine-parser
 
+## [4.6.22](https://github.com/markuplint/markuplint/compare/@markuplint/alpine-parser@4.6.21...@markuplint/alpine-parser@4.6.22) (2025-11-05)
 
-
-
+**Note:** Version bump only for package @markuplint/alpine-parser
 
 ## [4.6.21](https://github.com/markuplint/markuplint/compare/@markuplint/alpine-parser@4.6.20...@markuplint/alpine-parser@4.6.21) (2025-08-24)
 

package/lib/index.d.ts

@@ -1 +1,7 @@
+/**
+ * @module @markuplint/alpine-parser
+ * Markuplint parser plugin for Alpine.js templates. Extends the standard HTML parser
+ * to recognize Alpine.js directives (e.g., x-data, x-bind, x-on) and treat them
+ * appropriately during linting.
+ */
 export { parser } from './parser.js';

package/lib/index.js

@@ -1 +1,7 @@
+/**
+ * @module @markuplint/alpine-parser
+ * Markuplint parser plugin for Alpine.js templates. Extends the standard HTML parser
+ * to recognize Alpine.js directives (e.g., x-data, x-bind, x-on) and treat them
+ * appropriately during linting.
+ */
 export { parser } from './parser.js';

package/lib/parser.d.ts

@@ -1,11 +1,34 @@
 import type { Token } from '@markuplint/parser-utils';
 import { HtmlParser } from '@markuplint/html-parser';
+/**
+ * Parser for Alpine.js templates that extends the standard HTML parser.
+ *
+ * Recognizes Alpine.js directives such as `x-data`, `x-bind`, `x-on`, and
+ * `x-transition`, and classifies them as either directives (opaque to linting)
+ * or attribute bindings (with potential standard attribute names for validation).
+ */
 declare class AlpineParser extends HtmlParser {
+    /**
+     * Visits an attribute token and applies Alpine.js-specific classification.
+     *
+     * Determines whether the attribute is an Alpine.js directive, a dynamic
+     * binding (e.g., `:class`, `x-bind:href`), or an event listener shorthand
+     * (e.g., `@click`, `x-on:submit`), and returns the attribute with
+     * appropriate metadata such as `potentialName`, `isDirective`, and
+     * `isDynamicValue`.
+     *
+     * @param token - The raw attribute token containing text and position information
+     * @param options - Controls quoting behavior, value types, and the initial parser state
+     * @returns The attribute AST node enriched with Alpine.js directive metadata
+     */
     visitAttr(token: Token, options: Parameters<HtmlParser['visitAttr']>[1]): (import("packages/@markuplint/ml-ast/lib/types.js").MLASTHTMLAttr & {
         __rightText?: string;
     }) | (import("packages/@markuplint/ml-ast/lib/types.js").MLASTSpreadAttr & {
         __rightText?: string;
     });
 }
+/**
+ * Singleton Alpine.js parser instance for use by the markuplint engine.
+ */
 export declare const parser: AlpineParser;
 export {};

package/lib/parser.js

@@ -1,5 +1,25 @@
 import { HtmlParser } from '@markuplint/html-parser';
+/**
+ * Parser for Alpine.js templates that extends the standard HTML parser.
+ *
+ * Recognizes Alpine.js directives such as `x-data`, `x-bind`, `x-on`, and
+ * `x-transition`, and classifies them as either directives (opaque to linting)
+ * or attribute bindings (with potential standard attribute names for validation).
+ */
 class AlpineParser extends HtmlParser {
+    /**
+     * Visits an attribute token and applies Alpine.js-specific classification.
+     *
+     * Determines whether the attribute is an Alpine.js directive, a dynamic
+     * binding (e.g., `:class`, `x-bind:href`), or an event listener shorthand
+     * (e.g., `@click`, `x-on:submit`), and returns the attribute with
+     * appropriate metadata such as `potentialName`, `isDirective`, and
+     * `isDynamicValue`.
+     *
+     * @param token - The raw attribute token containing text and position information
+     * @param options - Controls quoting behavior, value types, and the initial parser state
+     * @returns The attribute AST node enriched with Alpine.js directive metadata
+     */
     visitAttr(token, options) {
         const attr = super.visitAttr(token, options);
         if (attr.type === 'spread') {
@@ -185,4 +205,7 @@ class AlpineParser extends HtmlParser {
         return attr;
     }
 }
+/**
+ * Singleton Alpine.js parser instance for use by the markuplint engine.
+ */
 export const parser = new AlpineParser();

package/lib/spec.d.ts

@@ -1,3 +1,11 @@
 import type { ExtendedSpec } from '@markuplint/ml-spec';
+/**
+ * Extended specification for Alpine.js directive attributes.
+ *
+ * Defines which Alpine.js-specific attributes are allowed on which HTML elements,
+ * their expected value types, and any element-level conditions. This enables
+ * markuplint to validate Alpine.js attributes as if they were part of the
+ * standard HTML spec.
+ */
 declare const spec: ExtendedSpec;
 export default spec;

package/lib/spec.js

@@ -1,4 +1,6 @@
 /**
+ * Attribute specification for the Alpine.js `x-model` directive.
+ *
  * > `x-model` works with the following input elements:
  * > - `<input type="text">`
  * > - `<textarea>`
@@ -13,6 +15,14 @@ const xModel = {
     type: 'NoEmptyAny',
     description: 'The x-model directive is used to bind a variable to a form input.',
 };
+/**
+ * Extended specification for Alpine.js directive attributes.
+ *
+ * Defines which Alpine.js-specific attributes are allowed on which HTML elements,
+ * their expected value types, and any element-level conditions. This enables
+ * markuplint to validate Alpine.js attributes as if they were part of the
+ * standard HTML spec.
+ */
 const spec = {
     specs: [
         {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/alpine-parser",
-	"version": "4.6.22",
+	"version": "4.6.23",
 	"description": "Alpine.js parser for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -25,11 +25,11 @@
 		"clean": "tsc --build --clean tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/html-parser": "4.6.22"
+		"@markuplint/html-parser": "4.6.23"
 	},
 	"devDependencies": {
-		"@markuplint/ml-spec": "4.10.1",
-		"@markuplint/parser-utils": "4.8.10"
+		"@markuplint/ml-spec": "4.10.2",
+		"@markuplint/parser-utils": "4.8.11"
 	},
-	"gitHead": "6213ea30269ef404f030e67bbcc7fc7443ec1060"
+	"gitHead": "193ee7c1262bbed95424e38efdf1a8e56ff049f4"
 }