posthtml-component 1.0.0-beta.8 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthtml-component",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "description": "PostHTML Components Blade-like with slots, attributes as props and custom tag",
   "license": "MIT",
   "repository": "thewebartisan7/posthtml-components",
@@ -13,7 +13,7 @@
     "version": "conventional-changelog -i changelog.md -s -r 0 && git add changelog.md",
     "test": "c8 ava",
     "pretest": "clinton && xo",
-    "build-examples": "node ./examples"
+    "build": "node ./docs-src"
   },
   "keywords": [
     "posthtml",

package/readme.md

@@ -17,10 +17,10 @@ npm i -D posthtml-component
 ## Introduction
 
 This PostHTML plugin provides an HTML-friendly syntax for write components in your templates.
-If you are familiar with Blade, you will find similar syntax as this plugin was inspired by it.
+If you are familiar with Blade, React, Vue or similar, you will find familiar syntax as this plugin is inspired by them.
 See below a basic example, as code is worth a thousand words.
 
-> This plugin is still in early stage of development and the current API may change.
+**See also the first [PostHTML Bootstrap UI](https://github.com/thewebartisan7/posthtml-bootstrap-ui) using this plugin and check also the [starter template here](https://github.com/thewebartisan7/posthtml-bootstrap-ui-starter).**
 
 ## Basic example
 
@@ -69,13 +69,11 @@ Result:
 </html>
 ```
 
-You may ask yourself many questions about this basic examples, and you will find most if not all answers in this readme. In case is missing something, feel free to ask via discussions.
+You may notice that the `src/button.html` component has a `type` and `class` attribute, and when we use the component in `src/index.html` we pass `type` and `class` attribute.
+The result is that `type` is override, and `class` is merged.
 
-But I want to explain a few things now.
-
-First you may notice that our `src/button.html` component has a `type` and `class` attribute, and when we use the component in `src/index.html` we add type and class attribute. The result is that `type` is override, and `class` is merged. 
-
-By default `class` and `style` attributes are merged, while all others attribute are override. You can also override class and style attribute by prepending `override:` to the class attribute. Example:
+By default `class` and `style` attributes are merged, while all others attribute are override.
+You can also override `class` and `style` attributes by prepending `override:` to the class attribute. Example:
 
 ```html
 <x-button override:class="btn-custom">Submit</x-button>
@@ -84,41 +82,50 @@ By default `class` and `style` attributes are merged, while all others attribute
 <button type="button" class="btn-custom">Submit</button>
 ```
 
-All attributes you pass to the component will be added to the first root element of your component, and only if they are not defined as `props` via `<script props>`. More details on this later.
-
-Second you may notice a `<yield>` tag.
+All attributes you pass to the component will be added to the first node of your component or to the node with an attribute names `attributes`,
+and only if they are not defined as `props` via `<script props>` or if they are not in the following file
+[valid-attributes.js](https://github.com/thewebartisan7/posthtml-components/blob/main/src/valid-attributes.js). 
+You can also manage valid attributes via options.
+More details on this in [Attributes](#attributes) section.
 
-This is where your content will be injected.
+The `<yield>` tag is where your content will be injected.
+In next section you can find all available options and then examples for each feature.
 
-In next section you can find all available options and then more examples.
-
-See also the `examples` folder. You can run `npm run build-examples` to compile them.
+See also the `docs-src` folder where you can find more examples. 
+You can run `npm run build` to compile them.
 
 ## Options
 
-|         Option         |           Default            | Description                                                                                                                        |
-|:----------------------:|:----------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------|
-|        **root**        |            `'./'`            | String value as root path for components lookup.                                                                                   |
-|      **folders**       |            `['']`            | Array of additional multi folders path from `options.root` or any defined namespaces root, fallback or custom.                     |
-|     **tagPrefix**      |             `x-`             | String for tag prefix. The plugin will use RegExp with this string.                                                                |
-|        **tag**         |           `false`            | String or boolean value for component tag. Use this with `options.attribute`. Boolean only false.                                  |
-|     **attribute**      |            `src`             | String value for component attribute for set path.                                                                                 |
-|     **namespaces**     |             `[]`             | Array of namespace's root path, fallback path and custom path for override.                                                        |
-| **namespaceSeparator** |             `::`             | String value for namespace separator to be used with tag name. Example `<x-namespace::button>`                                     |
-|   **fileExtension**    |            `html`            | String value for file extension of the components used for retrieve x-tag file.                                                    |
-|       **yield**        |           `yield`            | String value for `<yield>` tag name. Where main content of component is injected.                                                  |
-|        **slot**        |            `slot`            | String value for `<slot>` tag name. Used with RegExp by appending `:` (example `<slot:slot-name>`).                                |
-|        **fill**        |            `fill`            | String value for `<fill>` tag name. Used with RegExp by appending `:` (example `<fill:slot-name>`).                                |
-|   **slotSeparator**    |             `:`              | String value used for separate `<slot>` and `<fill>` tag from their names.                                                         |
-|        **push**        |            `push`            | String value for `<push>` tag name.                                                                                                |
-|       **stack**        |           `stack`            | String value for `<stack>` tag name.                                                                                               |
-|     **localsAttr**     |           `props`            | String value used in `<script props>` parsed by the plugin to retrieve locals in the components.                                   |
-|    **expressions**     |             `{}`             | Object to configure `posthtml-expressions`. You can pre-set locals or customize the delimiters for example.                        |
-|      **plugins**       |             `[]`             | PostHTML plugins to apply for every parsed components.                                                                             |
-|      **matcher**       | `[{tag: options.tagPrefix}]` | Array of object used to match the tags.                                                                                            |
-|  **attrsParserRules**  |             `{}`             | Additional rules for attributes parser plugin.                                                                                     |
-|       **strict**       |            `true`            | Boolean value for enable or disable throw an exception.                                                                            |
-|  **mergeCustomizer**   |          `function`          | Function callback passed to lodash `mergeWith` for attribute `locals` and `merge:attribute`. By default it's used to concat array. |
+|          Option          |                    Default                    | Description                                                                                                                   |
+|:------------------------:|:---------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------|
+|         **root**         |                    `'./'`                     | String value as root path for components lookup.                                                                              |
+|       **folders**        |                    `['']`                     | Array of additional multi folders path from `options.root` or any defined namespaces root, fallback or custom.                |
+|      **tagPrefix**       |                     `x-`                      | String for tag prefix. The plugin will use RegExp with this string.                                                           |
+|         **tag**          |                    `false`                    | String or boolean value for component tag. Use this with `options.attribute`. Boolean only false.                             |
+|      **attribute**       |                     `src`                     | String value for component attribute for set path.                                                                            |
+|      **namespaces**      |                     `[]`                      | Array of namespace's root path, fallback path and custom path for override.                                                   |
+|  **namespaceSeparator**  |                     `::`                      | String value for namespace separator to be used with tag name. Example `<x-namespace::button>`                                |
+|    **fileExtension**     |                    `html`                     | String value for file extension of the components used for retrieve x-tag file.                                               |
+|        **yield**         |                    `yield`                    | String value for `<yield>` tag name. Where main content of component is injected.                                             |
+|         **slot**         |                    `slot`                     | String value for `<slot>` tag name. Used with RegExp by appending `:` (example `<slot:slot-name>`).                           |
+|         **fill**         |                    `fill`                     | String value for `<fill>` tag name. Used with RegExp by appending `:` (example `<fill:slot-name>`).                           |
+|    **slotSeparator**     |                      `:`                      | String value used for separate `<slot>` and `<fill>` tag from their names.                                                    |
+|         **push**         |                    `push`                     | String value for `<push>` tag name.                                                                                           |
+|        **stack**         |                    `stack`                    | String value for `<stack>` tag name.                                                                                          |
+| **propsScriptAttribute** |                    `props`                    | String value used as attribute in `<script props>` parsed by the plugin to retrieve props of the component.                   |
+|     **propsContext**     |                    `props`                    | String value used as object name inside the script to process process before passed to the component.                         |
+|    **propsAttribute**    |                    `props`                    | String value for props attribute to define props as JSON.                                                                     |
+|      **propsSlot**       |                    `props`                    | String value used to retrieve the props passed to slot via `$slots.slotName.props`.                                           |
+|     **expressions**      |                     `{}`                      | Object to configure `posthtml-expressions`. You can pre-set locals or customize the delimiters for example.                   |
+|       **plugins**        |                     `[]`                      | PostHTML plugins to apply for every parsed components.                                                                        |
+|       **matcher**        |         `[{tag: options.tagPrefix}]`          | Array of object used to match the tags.                                                                                       |
+|   **attrsParserRules**   |                     `{}`                      | Additional rules for attributes parser plugin.                                                                                |
+|        **strict**        |                    `true`                     | Boolean value for enable or disable throw an exception.                                                                       |
+|   **mergeCustomizer**    |                  `function`                   | Function callback passed to lodash `mergeWith` for merge `options.expressions.locals` and props passed via attribute `props`. |
+|      **utilities**       | `{merge: _.mergeWith, template: _.template}`  | Object of utilities methods to be passed to `<script props>`. By default lodash `mergeWith` and `template`.                   |
+|  **elementAttributes**   |                     `{}`                      | An object with tag name and a function modifier of valid-attributes.js.                                                       |
+|  **safelistAttributes**  |         `['data-*']`                          | An array of attributes name to be added to default valid attributes.                                                          |
+| **blacklistAttributes**  |                     `[]`                      | An array of attributes name to be removed from default valid attributes.                                                      |
 
 ## Features
 
@@ -213,7 +220,7 @@ Please see below example to understand better.
 
 You have full control where to place your components. Once you set the base root path of your components, you can then set multiple folders.
 For example let's suppose your main root is `./src` and then you have several folders where you have your components, for example `./src/components` and `./src/layouts`.
-You can setup the plugin like below:
+You can set up the plugin like below:
 
 ```js
 // index.js
@@ -229,7 +236,7 @@ require('posthtml')(require('posthtml-components')(options))
 
 ### Namespaces
 
-With namespaces you can define a top level root path to your components like shown in below example.
+With namespaces, you can define a top level root path to your components like shown in below example.
 It can be useful for handle custom theme, where you define a specific top level root, with fallback root when component it's not found,
 and a custom root for override, something like a child theme.
 
@@ -346,7 +353,7 @@ Result:
 </div>
 ```
 
-By default the content is replaced, but you can also prepend or append the content, or keep the default content by not filling the slot.
+By default, the content is replaced, but you can also prepend or append the content, or keep the default content by not filling the slot.
 
 Add some default content in the component:
 
@@ -486,7 +493,7 @@ Example.
 </push>
 ```
 
-By default the content is pushed in the stack in the given order.
+By default, the content is pushed in the stack in the given order.
 If you would like to prepend content onto the beginning of a stack, you should use the `prepend` attribute:
 
 ```html
@@ -505,7 +512,7 @@ If you would like to prepend content onto the beginning of a stack, you should u
 
 ### Props
 
-Behind the `props` there is powerful [posthtml-expressions](https://github.com/posthtml/posthtml-expressions) plugin, with feature to pass `props` (locals) via attributes, define default via `<script props>`, merge with default and use `<script props>` as computed.
+Behind the `props` there is powerful [posthtml-expressions](https://github.com/posthtml/posthtml-expressions) plugin, with feature to pass `props` (locals) via attributes and manipulate them via `<script props>`.
 
 Let's see how it works with a few examples starting with a basic one.
 
@@ -515,7 +522,7 @@ Create the component:
 <!-- src/my-component.html -->
 <script props>
   module.exports = {
-    prop: 'Default prop value'
+    prop: props.prop || 'Default prop value'
   }
 </script>
 <div>
@@ -553,11 +560,7 @@ The output will be:
 </div>
 ```
 
-If you don't add the props in `<script props>` inside your component, all props will be added as attributes to the first node of your component or to the node with attribute `attributes`. 
-More details on this in the next section.
-
-So by default `<script props>` act as default value, like the `@props` you define with Laravel Blade.
-You can change this behaviour by prepending `computed` or `merge` to the attribute name like shown below.
+In the `<script props>` you have access to passed props via object `props`, and you can add any logic you need inside it.
 
 Create the component:
 
@@ -565,9 +568,9 @@ Create the component:
 <!-- src/modal.html -->
 <script props>
   module.exports = {
-    title: 'Default title', // This will be the default value
-    size: locals.size ? `modal-${locals.size}` : '', // This will be a computed value, so it's always used
-    items: ['first', 'second'] // This will be merged
+    title: props.title || 'Default title', 
+    size: props.size ? `modal-${props.size}` : '', 
+    items: Array.isArray(props.items) ? props.items.concat(['first', 'second']) : ['first', 'second']
   }
 </script>
 <div class="modal {{ size }}">
@@ -583,7 +586,7 @@ Create the component:
 Use:
 
 ```html
-<x-modal computed:size="xl" title="My modal title" merge:items='["third", "fourth"]' class="modal-custom"></x-modal>
+<x-modal size="xl" title="My modal title" items='["third", "fourth"]' class="modal-custom"></x-modal>
 ```
 
 The output will be:
@@ -602,19 +605,89 @@ The output will be:
 </div>
 ```
 
-So the prop `size` is not override since we prepend `computed:` to the attribute, while the prop `title` is override.
-And the prop `items` is merged and not override. 
-You can also notice how the `class` attribute is merged with `class` attribute of the first node. Let's see in next section more about this.
+You can also notice how the `class` attribute is merged with `class` attribute of the first node. In the next section you will know more about this.
+
+You can change how attributes are merged with global props defined via options by passing a callback function used by lodash method [mergeWith](https://lodash.com/docs/4.17.15#mergeWith).
+
+By default, all props are scoped to the component, and are not available to nested components. You can however change this accordingly to your need.
+Let's see below example.
+
+Create a component:
+
+```html
+<!-- src/child.html -->
+<script props>
+  module.exports = {
+    prop: props.prop || 'Default prop value'
+  }
+</script>
+<div>
+  Prop in child: {{ prop }}
+</div>
+```
+
+Create another component that use the first one:
+
+
+```html
+<!-- src/parent.html -->
+<script props>
+  module.exports = {
+    prop: props.prop || 'Default prop value'
+  }
+</script>
+<div>
+  Prop in parent: {{ prop }}
+  <x-child></x-child>
+</div>
+```
+
+Use:
+
+```html
+<x-parent prop="My prop"></x-parent>
+```
+
+The output will be:
+
+```html
+<div>
+  Prop in parent: My prop
+  <div>
+    Prop in child: Default prop value
+  </div>
+</div>
+```
+
+As you can see `prop` in `x-child` component are default value and not the one set via `x-parent`. Prepend `aware:` to the attribute name to pass the props to nested components.
+
+
+```html
+<x-parent aware:prop="My prop"></x-parent>
+```
+
+The output now will be:
 
-You can change how attributes are merged by passing via options a callback function used by lodash method [mergeWith](https://lodash.com/docs/4.17.15#mergeWith).
-By default, it's used to concat array.
+```html
+<div>
+  Prop in parent: My prop
+  <div>
+    Prop in child: My prop
+  </div>
+</div>
+```
 
 ### Attributes
 
-Your can pass any attributes to your components and this will be added to the first node of your component, or to the node with an attribute named `attributes`.
+You can pass any attributes to your components and this will be added to the first node of your component,
+or to the node with an attribute named `attributes`. If you are familiar with VueJS this is the same as so called
+[fallthrough attribute](https://vuejs.org/guide/components/attrs.html), or with Laravel Blade is
+[component-attributes](https://laravel.com/docs/10.x/blade#component-attributes).
+
 By default `class` and `style` are merged with existing `class` and `style` attribute.
 All others attributes are override by default.
-Only attribute not defined as `props` will be used.
+Only attributes defined in [valid-attributes.js](https://github.com/thewebartisan7/posthtml-components/blob/main/src/valid-attributes.js)
+or not defined as `props` in the `<script props>`.
 
 As already seen in basic example:
 
@@ -622,7 +695,7 @@ As already seen in basic example:
 <!-- src/button.html -->
 <script props>
   module.exports = {
-    label: 'A button'
+    label: props.label || 'A button'
   }
 </script>
 <button type="button" class="btn">
@@ -646,8 +719,6 @@ Result:
 
 As you may notice the `label` attribute is not added as attribute, since it's defined as a `props`.
 
-If you are familiar with Laravel Blade, this is also how Blade handle this.
-
 As said early, `class` and `style` are merged by default, if you want to override them, just prepend `override:` to the attribute name:
 
 ```html
@@ -662,7 +733,7 @@ Result:
 <button type="submit" class="btn-custom">My button</button>
 ```
 
-If you want to use another node for add such attributes, then you can add the attribute `attributes` like shown below.
+If you want to use another node and not the first one, then you can add the attribute `attributes` like shown below.
 
 ```html
 <!-- src/my-component.html -->
@@ -693,10 +764,57 @@ Result:
 
 You can add custom rules how attributes are parsed, as behind the scene it's used [posthtml-attrs-parser](https://github.com/posthtml/posthtml-attrs-parser) plugin.
 
+### Advanced attributes configurations
+
+If default configurations for valid attributes are not right for you, then you can configure them as explained below.
+
+```js
+// index.js
+const { readFileSync, writeFileSync } = require('fs')
+
+const posthtml = require('posthtml')
+const components = require('posthtml-components')
+
+const options = {
+  root: './src',
+  
+  // Add attributes to specific tag or override defaults
+  elementAttributes: {
+    DIV: (defaultAttributes) => {
+      /* Add new one */
+      defaultAttributes.push('custom-attribute-name');
+
+      return defaultAttributes;
+    },
+    DIV: (defaultAttributes) => {
+      /* Override all */
+      defaultAttributes = ['custom-attribute-name', 'another-one'];
+
+      return defaultAttributes;
+    },
+  },
+  
+  // Add attributes to all tags, use '*' as wildcard for attribute name that starts with
+  safelistAttributes: [
+    'custom-attribute-name',
+    'attribute-name-start-with-*'
+  ],
+
+  // Remove attributes from all tags that support it
+  blacklistAttributes: [
+    'role'
+  ]
+}
+
+posthtml(components(options))
+  .process(readFileSync('src/index.html', 'utf8'))
+  .then((result) => writeFileSync('dist/index.html', result.html, 'utf8'))
+```
+
 ## Examples
 
-You can work with `<slot>` and `<fill>` or you can create component for each "block" of your component, and you can also support both of them.
-You can find an example of this inside `examples/components/modal`. Below is a short explanation about the both approach.
+You can work with `<slot>` and `<fill>` or you can create component for each block of your component, and you can also support both of them.
+You can find an example of this inside `docs-src/components/modal`. Below is a short explanation about the both approach.
 
 ### Using slots
 
@@ -855,7 +973,7 @@ You can also combine both way, and then use them with slots or with small compon
           </x-modal.body>
       </if>
       <if condition="$slots.footer?.filled">
-          <x-modal.footer close="{{ $slots.footer?.locals.close }}">
+          <x-modal.footer close="{{ $slots.footer?.props.close }}">
               <slot:footer></slot:footer>
           </x-modal.footer>
       </if>
@@ -871,53 +989,9 @@ via `$slots` which has all the `props` passed via slot, and as well check if slo
 
 ## Migration
 
-If you are migrating from `posthtml-extend` and/or `posthtml-modules` then you can continue to keep them until you migrate all of your components.
-For continue to use current code with this plugin without changing it, see below examples. Any more updates on this will be added in this issue:
+If you are migrating from `posthtml-extend` and/or `posthtml-modules` please to follow updates here:
 [posthtml-components/issues/16](https://github.com/thewebartisan7/posthtml-components/issues/16).
 
-### PostHTML Include
-
-PostHTML Include plugin can work when passed via `options.plugins` like below example:
-
-```js
-require("posthtml-component")({
-  root: "./src",
-  folders: ["components", "layouts"],
-  plugins: [
-    require("posthtml-include")({
-      encoding: "utf8",
-      root: "./src"
-    }),
-  ]
-})
-```
-
-### PostHTML Modules
-
-At the moment doesn't work when nested inside PostHTML Components plugin since it use `tree.match` and even trying with something like PostHTML Include is doing here https://github.com/posthtml/posthtml-include/blob/master/lib/index.js#L16 doesn't work. But a workaround is to use PostHTML Components custom tag and attributes like below:
-
-```js
-require("posthtml-component")({
-  root: "./src",
-  folders: ["components", "layouts"],
-  tag: 'module',
-  attribute: 'href',
-  yield: 'content',
-  plugins: [
-    require("posthtml-include")({
-      encoding: "utf8",
-      root: "./src/www/posthtml-templates/"
-    }),
-  ]
-})
-```
-
-NOTE: If you change `<yield>` tag to `<content>` to support your existing code, then you need to use it always. Maybe you can just replace all `<content>` with `<yield>` and it should works fine.
-
-### PostHTML Extends
-
-Not yet tested.
-
 ## Contributing
 
 See [PostHTML Guidelines](https://github.com/posthtml/posthtml/tree/master/docs) and [contribution guide](CONTRIBUTING.md).

package/src/find-path.js

@@ -44,7 +44,7 @@ function searchInFolders(tag, fileNameFromTag, options) {
   const componentPath = search(options.root, options.folders, fileNameFromTag, options.fileExtension);
 
   if (!componentPath) {
-    throw new Error(`[components] For the tag ${tag} was not found any template in defined root path ${options.folders.join(', ')}`);
+    throw new Error(`[components] <${tag}> could not find ${fileNameFromTag} in the defined root paths (${options.folders.join(', ')})`);
   }
 
   return componentPath;
@@ -63,7 +63,7 @@ function searchInNamespaces(tag, [namespace, fileNameFromTag], options) {
   const namespaceOption = options.namespaces.find(n => n.name === namespace.replace(options.tagPrefix, ''));
 
   if (!namespaceOption) {
-    throw new Error(`[components] Unknown component namespace ${namespace}.`);
+    throw new Error(`[components] Unknown component namespace: ${namespace}.`);
   }
 
   let componentPath;
@@ -84,7 +84,7 @@ function searchInNamespaces(tag, [namespace, fileNameFromTag], options) {
   }
 
   if (!componentPath && options.strict) {
-    throw new Error(`[components] For the tag ${tag} was not found any template in the defined namespace's base path ${namespaceOption.root}.`);
+    throw new Error(`[components] <${tag}> could not find ${fileNameFromTag} in the defined namespace base path ${namespaceOption.root}`);
   }
 
   return componentPath;