feat: add types

README.md

@@ -107,6 +107,8 @@ The `<yield></yield>` tag is where content that you pass to a component will be
 
 The plugin configures the PostHTML parser to recognize self-closing tags, so you can also just write is as `<yield />`.
 
+For brevity, we will use self-closing tags in the examples.
+
 ### More examples
 
 See also the `docs-src` folder where you can find more examples. 

src/index.d.ts

@@ -0,0 +1,214 @@
+import type { PostHTMLExpressions } from 'posthtml-expressions';
+import type { Options as PostHTMLParserOptions } from 'posthtml-parser';
+
+interface AnyObject {
+  [key: string]: string | AnyObject;
+}
+
+export type PostHTMLComponents = {
+  /**
+   * Root path where to look for folders containing component files.
+   *
+   * @default './'
+   */
+  root?: string;
+
+  /**
+   * Paths where to look for component files. Must be relative to `root`.
+   *
+   * @default ['']
+   */
+  folders?: string[];
+
+  /**
+   * Prefix to use for component tags.
+   *
+   * @default 'x-'
+   */
+  tagPrefix?: string;
+
+  /**
+   * Tag name to be used in HTML when using a component.
+   *
+   * @default false
+   */
+  tag?: string|false;
+
+  /**
+   * Attribute name to be used when referencing a component via its path.
+   *
+   * @default 'src'
+   */
+  attribute?: string;
+
+  /**
+   * Array of namespace root paths, fallback paths and custom override paths.
+   *
+   * @default []
+   */
+  namespaces?: string[];
+
+  /**
+   * Separator to use between namespace and component name.
+   *
+   * @default '::'
+   */
+  namespaceSeparator?: string;
+
+  /**
+   * File extension that component files must use.
+   *
+   * @default 'html'
+   */
+  fileExtension?: string;
+
+  /**
+   * Name of the tag that will be replaced with the content that is passed to the component.
+   *
+   * @default 'yield'
+   */
+  yield?: string;
+
+  /**
+  * Name of the slot tag, where the content will be injected.
+  *
+  * @default 'slot'
+  */
+  slot?: string;
+
+  /**
+   * Name of the fill tag, where the content to be injected is defined.
+   *
+   * @default 'fill'
+   */
+  fill?: string;
+
+  /**
+   * String to use as a separator between the slot tag and its name.
+   *
+   * @default ':'
+   */
+  slotSeparator?: string;
+
+  /**
+   * Tag name for pushing content to a stack.
+   *
+   * @default 'push'
+   */
+  push?: string;
+
+  /**
+   * Tag name for popping (rendering) content from a stack.
+   *
+   * @default 'stack'
+   */
+  stack?: string;
+
+  /**
+   * Name of the props attribute to use in the `<script>` tag of a component.
+   *
+   * @default 'props'
+   */
+  propsScriptAttribute?: string;
+
+  /**
+   * Name of the object that will be used to store the props of a component.
+   *
+   * @default 'props'
+   */
+  propsContext?: string;
+
+  /**
+   * Name of the attribute that will be used to pass props to a component as JSON.
+   *
+   * @default 'locals'
+   */
+  propsAttribute?: string;
+
+  /**
+   * Name of the key to use when retrieving props passed to a slot via `$slots.slotName.props`.
+   *
+   * @default 'props'
+   */
+  propsSlot?: string;
+
+  /**
+   * Configure [`posthtml-parser`](https://github.com/posthtml/posthtml-parser).
+   *
+   * @default
+   * {
+   *  recognizeSelfClosing: true
+   * }
+   */
+  parserOptions?: PostHTMLParserOptions;
+
+  /**
+   * Configure [`posthtml-expressions`](https://github.com/posthtml/posthtml-expressions).
+   *
+   * @default {}
+   */
+  expressions?: PostHTMLExpressions;
+
+  /**
+   * PostHTML plugins to apply to each parsed component.
+   *
+   * @default []
+   */
+  plugins?: Array<() => void>;
+
+  /**
+   * Array of objects used to match tags.
+   *
+   * @default [{tag: options.tagPrefix}]
+   */
+  matcher?: object;
+
+  /**
+   * Extra rules for the PostHTML plugin that is used by components to parse attributes.
+   *
+   * @default {}
+   */
+  attrsParserRules?: Record<string, AnyObject>;
+
+  /**
+   * In strict mode, an error will be thrown if a component cannot be rendered.
+   *
+   * @default true
+   */
+  strict?: boolean;
+
+  /**
+   * Callback for lodash `mergeWith` to merge `options.expressions.locals` and props.
+   *
+   *
+   */
+  mergeCustomizer?: (objValue: any, srcValue: any) => any;
+
+  /**
+   * Utility methods to be passed to `<script props>` in a component.
+   *
+   * @default {merge: _.mergeWith, template: _.template}
+   */
+  utilities?: Record<string, unknown>;
+
+  /**
+   * Define additional attributes that should be preserved for specific HTML elements.
+   *
+   * @default {}
+   */
+  elementAttributes?: Record<string, void>;
+
+  /**
+   * Attributes that should be preserved on all elements in components.
+   *
+   * @default ['data-*']
+   */
+  safelistAttributes?: string[];
+
+  /**
+   * Attributes that should be removed from all elements in components.
+   *
+   * @default []
+   */
+  blocklistAttributes?: string[];
+}