@markuplint/ml-config 4.4.0 → 4.5.1

package/lib/types.d.ts

@@ -34,6 +34,10 @@ export type ParserConfig = {
 export type SpecConfig = {
     readonly [extensionPattern: string]: string;
 };
+export type PretenderFileData = {
+    readonly version: string;
+    readonly data: readonly Pretender[];
+};
 export type Pretender = {
     /**
      * Target node selectors
@@ -47,12 +51,81 @@ export type Pretender = {
      * If it is an Object, It creates the element by that.
      */
     readonly as: string | OriginalNode;
+    /**
+     * If it is a string, it is resolved as an element name.
+     * An element regards as having the same attributes
+     * as the pretended custom element because these are inherited.
+     * If it is an Object, It can specify in detail the element's attributes.
+     *
+     * @experimental
+     */
+    readonly filePath?: string;
+    /**
+     * Dynamic scaning
+     *
+     * @experimental
+     */
+    readonly scan?: readonly PretenderScanConfig[];
 };
 export type OriginalNode = {
     /**
      * Element name
      */
     readonly element: string;
+    /**
+     * It should specify slots if the component can define a slot element or children.
+     *
+     * For example, the following:
+     *
+     * ```jsx
+     * const Component = ({children}) => (
+     *   <div>
+     *     <h2>lorem ipsum</h2>
+     *     <p>{children}</p>
+     *   </div>
+     * );
+     * ```
+     *
+     * In the above case, the `p` element has the `children`,
+     * so it specifies the element to this field.
+     *
+     * Or:
+     *
+     * ```html
+     * <template>
+     *   <h2>lorem ipsum</h2>
+     *   <p><span slot="my-text">{children}</span></p>
+     * </template>
+     * ```
+     *
+     * It notes that what needs to be specified
+     * in this field is not the element with the slot attribute
+     * but the element that wraps it.
+     *
+     * This field accepts an array
+     * because a component and a custom element can have multiple slots.
+     *
+     * If `null`,
+     * it means the component **doesn't accept children or doesn't have slots**.
+     *
+     * ```jsx
+     * const Component = (props) => (
+     *   <img {...props} />
+     * );
+     * ```
+     *
+     * If true, it means the component accepts children or has slots,
+     * and **the wrapper element and the outermost element are the same**.
+     *
+     * ```jsx
+     * const Component = ({children}) => (
+     *   <button>{children}</button>
+     * );
+     * ```
+     *
+     * @experimental
+     */
+    readonly slots?: null | true | readonly Slot[];
     /**
      * Namespace
      *
@@ -63,18 +136,7 @@ export type OriginalNode = {
     /**
      * Attributes
      */
-    readonly attrs?: readonly {
-        /**
-         * Attribute name
-         */
-        readonly name: string;
-        /**
-         * If it omits this property, the attribute is resolved as a boolean.
-         */
-        readonly value?: string | {
-            readonly fromAttr: string;
-        };
-    }[];
+    readonly attrs?: readonly PretenderAttr[];
     /**
      * To have attributes the defined element has.
      */
@@ -84,6 +146,22 @@ export type OriginalNode = {
      */
     readonly aria?: PretenderARIA;
 };
+/**
+ * @experimental
+ */
+export type Slot = Omit<OriginalNode, 'slot'>;
+export type PretenderAttr = {
+    /**
+     * Attribute name
+     */
+    readonly name: string;
+    /**
+     * If it omits this property, the attribute is resolved as a boolean.
+     */
+    readonly value?: string | {
+        readonly fromAttr: string;
+    };
+};
 /**
  * Pretender Node ARIA properties
  */
@@ -98,6 +176,24 @@ export type PretenderARIA = {
         readonly fromAttr: string;
     };
 };
+/**
+ * @experimental
+ */
+export type PretenderScanConfig = {
+    /**
+     * Supporting for Glob format
+     */
+    readonly files: string;
+    readonly type: string;
+    readonly options: PretenderScanOptions;
+};
+/**
+ * @experimental
+ */
+export interface PretenderScanOptions {
+    readonly cwd?: string;
+    readonly ignoreComponentNames?: readonly string[];
+}
 export type Rule<T extends RuleConfigValue, O extends PlainData = undefined> = RuleConfig<T, O> | Readonly<T> | boolean;
 /**
  * @deprecated

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-config",
-	"version": "4.4.0",
+	"version": "4.5.1",
 	"description": "JSON Schema and TypeScript types of markuplint configure JSON",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -25,13 +25,13 @@
 	},
 	"dependencies": {
 		"@markuplint/ml-ast": "4.2.0",
-		"@markuplint/selector": "4.4.0",
+		"@markuplint/selector": "4.5.1",
 		"@markuplint/shared": "4.2.0",
 		"@types/mustache": "4.2.5",
 		"deepmerge": "4.3.1",
 		"is-plain-object": "5.0.0",
 		"mustache": "4.2.0",
-		"type-fest": "4.14.0"
+		"type-fest": "4.15.0"
 	},
-	"gitHead": "ad3db077e96bea0666c9105b250f895263907a87"
+	"gitHead": "b029c86a6b3a9ea8189d2e5535e3023aaea753fd"
 }