Merge pull request #125 from posthtml/milestone-1.0.3

Milestone 1.0.3

Author: Scrum

.travis.yml

@@ -3,7 +3,7 @@ language: node_js
 node_js:
   - stable
   - lts/*
-  - 8
+  - 10
 
 after_success:
 - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"

README.md

@@ -57,7 +57,11 @@ module: {
 |:--:|:--:|:-----:|:----------|
 |**[`config`](#config)**|`{Object}`|`undefined`|PostHTML Config|
 |**[`parser`](#parser)**|`{String/Function}`|`undefined`|PostHTML Parser|
+|**[`skipParse`](#skipParse)**|`{Boolean}`|`false`|PostHTML Options SkipParse|
+|**[`render`](#render)**|`{String/Function}`|`undefined`|PostHTML Render|
 |**[`plugins`](#plugins)**|`{Array/Function}`|`[]`|PostHTML Plugins|
+|**[`sync`](#sync)**|`{boolean}`|`false`|PostHTML Options Sync|
+|**[`directives`](#directives)**|`{Array<Object>}`|`[]`|PostHTML Options custom [Directives](https://github.com/posthtml/posthtml-parser#directives)|
 
 ### `Config`
 
@@ -66,6 +70,7 @@ module: {
 |**[`path`](#path)**|`{String}`|`loader.resourcePath`|PostHTML Config Path|
 |**[`ctx`](#context)**|`{Object}`|`{}`|PostHTML Config Context|
 
+
 If you want to use are shareable config file instead of inline options in your `webpack.config.js` create a `posthtml.config.js` file and place it somewhere down the file tree in your project. The nearest config relative to `dirname(file)` currently processed by the loader applies. This enables **Config Cascading**. Despite some edge cases the config file will be loaded automatically and **no** additional setup is required. If you don't intend to use Config Cascading, it's recommended to place `posthtml.config.js` in the **root** `./` of your project
 
 ```
@@ -157,6 +162,50 @@ If you want to use a custom parser e.g [SugarML](https://github.com/posthtml/sug
 }
 ```
 
+### `skipParse`
+
+If you want to use disable parsing, you can pass it in under the `skipParse` key in the loader options
+
+#### `{Boolean}`
+
+**webpack.config.js**
+```js
+{
+  loader: 'posthtml-loader',
+  options: {
+    skipParse: false
+  }
+}
+```
+
+### `Render`
+
+If you want to use a custom render, you can pass it in under the `render` key in the loader options
+
+#### `{String}`
+
+**webpack.config.js**
+```js
+{
+  loader: 'posthtml-loader',
+  options: {
+    render: 'posthtml-you-render'
+  }
+}
+```
+
+#### `{Function}`
+
+**webpack.config.js**
+```js
+{
+  loader: 'posthtml-loader',
+  options: {
+    parser: require('posthtml-you-render')()
+  }
+}
+```
+
 ### `Plugins`
 
 Plugins are specified under the `plugins` key in the loader options
@@ -191,6 +240,38 @@ Plugins are specified under the `plugins` key in the loader options
 }
 ```
 
+### `Sync`
+
+Enables sync mode, plugins will run synchronously, throws an error when used with async plugins
+
+#### `{Boolean}`
+
+**webpack.config.js**
+```js
+{
+  loader: 'posthtml-loader',
+  options: {
+    sync: true
+  }
+}
+```
+
+### `Directives`
+
+If you want to use a custom directives, you can pass it in under the `directives` key in the loader options
+
+#### `{Array}`
+
+**webpack.config.js**
+```js
+{
+  loader: 'posthtml-loader',
+  options: {
+    directives: [{name: '?php', start: '<', end: '>'}]
+  }
+}
+```
+
 <h2 align="center">Maintainer</h2>
 
 <table>
@@ -202,15 +283,6 @@ Plugins are specified under the `plugins` key in the loader options
         <br />
         <a href="https://github.com/michael-ciniawsky">Michael Ciniawsky</a>
       </td>
-    </tr>
-  <tbody>
-</table>
-
-<h2 align="center">Contributors</h2>
-
-<table>
-  <tbody>
-    <tr>
       <td align="center">
         <img width="150" height="150" src="https://github.com/Scrum.png?v=3&s=150">
         <br />

lib/index.js

@@ -106,10 +106,9 @@ module.exports = function loader (html, map, meta) {
         options.parser = require(options.parser)()
       }
 
-      // TODO(michael-ciniawsky) enable if when custom renderer available
-      // if (typeof options.render === 'string') {
-      //   options.render = require(options.render)()
-      // }
+      if (typeof options.render === 'string') {
+        options.render = require(options.render)()
+      }
 
       return posthtml(plugins)
         .process(html, options)

lib/options.js

@@ -1,22 +1,14 @@
 'use strict'
 
 module.exports = function parseOptions (params) {
-  if (typeof params.plugins === 'function') {
-    params.plugins = params.plugins.call(this, this)
-  }
-
-  let plugins
-
-  if (typeof params.plugins === 'undefined') plugins = []
-  else if (Array.isArray(params.plugins)) plugins = params.plugins
-  else plugins = [params.plugins]
+  let { plugins, ...options } = params
 
-  const options = {}
-
-  if (typeof params !== 'undefined') {
-    options.parser = params.parser
-    // options.render = params.render
+  if (typeof plugins === 'function') {
+    plugins = plugins.call(this, this)
   }
 
-  return Promise.resolve({ options: options, plugins: plugins })
+  if (typeof plugins === 'undefined') plugins = []
+  else if (!Array.isArray(plugins)) plugins = [plugins]
+
+  return Promise.resolve({ options, plugins })
 }

lib/options.json

@@ -1,6 +1,29 @@
 {
   "type": "object",
   "properties": {
+    "sync": {
+      "type": "boolean"
+    },
+    "directives": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "start": {
+            "type": "string"
+          },
+          "end": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "skipParse": {
+      "type": "boolean"
+    },
     "ident": {
       "type": "string"
     },
@@ -23,6 +46,13 @@
         { "instanceof": "Function" }
       ]
     },
+    "render": {
+      "oneOf": [
+        { "type": "string" },
+        { "type": "object" },
+        { "instanceof": "Function" }
+      ]
+    },
     "plugins": {
       "oneOf": [
         { "type": "array" },

package.json

@@ -1,10 +1,10 @@
 {
   "name": "posthtml-loader",
   "description": "PostHTML for Webpack",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "main": "lib/index.js",
   "engines": {
-    "node": ">= 8"
+    "node": ">= 10"
   },
   "files": [
     "lib"
@@ -18,20 +18,20 @@
     "release": "standard-version"
   },
   "dependencies": {
-    "loader-utils": "^1.1.0",
-    "posthtml": "^0.12.0",
+    "loader-utils": "^2.0.0",
+    "posthtml": "^0.13.2",
     "posthtml-load-config": "^1.0.0",
     "schema-utils": "^2.5.0"
   },
   "devDependencies": {
     "coveralls": "^3.0.7",
     "del": "^5.1.0",
-    "jest": "^24.9.0",
-    "jsdoc-to-markdown": "^5.0.2",
+    "jest": "^26.4.1",
+    "jsdoc-to-markdown": "^6.0.1",
     "memory-fs": "^0.5.0",
     "posthtml-sugarml": "1.0.0-alpha3",
     "standard": "^14.3.1",
-    "standard-version": "^8.0.1",
+    "standard-version": "^9.0.0",
     "webpack": "^4.41.2"
   },
   "keywords": [

test/__snapshots__/Errors.test.js.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Errors Validation Error 1`] = `
-"Invalid options object. PostHTML Loader has been initialised using an options object that does not match the API schema.
+"Invalid options object. PostHTML Loader has been initialized using an options object that does not match the API schema.
  - options.plugins should be one of these:
    [any, ...] | object { … } | function
    Details:

test/__snapshots__/loader.test.js.snap

@@ -0,0 +1,6 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Loader Defaults 1`] = `
+"export default \`<section>Hello</section>
+\`"
+`;

test/fixtures/options/directives/fixture.html

@@ -0,0 +1 @@
+<?php echo $myVar; ?>

test/fixtures/options/directives/fixture.js

@@ -0,0 +1 @@
+import html from './fixture.html' // eslint-disable-line