Merge pull request #121 from posthtml/milestone-1.9.0

Milestone 1.9.0

Author: Scrum

changelog.md

@@ -1,3 +1,17 @@
+# [1.9.0](https://github.com/posthtml/posthtml-expressions/compare/v1.8.1...v1.9.0) (2021-08-23)
+
+
+### Features
+
+* remove script locals, close [#120](https://github.com/posthtml/posthtml-expressions/issues/120) ([023fcb9](https://github.com/posthtml/posthtml-expressions/commit/023fcb9845939524265589d5b59741e41ea73aa4))
+
+
+### Performance Improvements
+
+* default locals attr ([73dc216](https://github.com/posthtml/posthtml-expressions/commit/73dc216c2adae6de9582c1c65a83d460df836f0a))
+
+
+
 ## [1.8.1](https://github.com/posthtml/posthtml-expressions/compare/v1.8.0...v1.8.1) (2021-08-10)
 
 

lib/index.js

@@ -114,7 +114,9 @@ module.exports = function postHTMLExpressions (options) {
     loopTags: ['each'],
     scopeTags: ['scope'],
     ignoredTag: 'raw',
-    strictMode: true
+    strictMode: true,
+    localsAttr: 'locals',
+    removeScriptLocals: false
   }, options)
 
   // set tags

lib/locals.js

@@ -21,7 +21,7 @@ const ctx = vm.createContext({ module })
  */
 function scriptDataLocals (tree, options) {
   const locals = {}
-  const localsAttr = options.localsAttr || 'locals'
+  const localsAttr = options.localsAttr
 
   match.call(tree, matchHelper(`script[${localsAttr}]`), node => {
     if (node.content) {
@@ -34,6 +34,10 @@ function scriptDataLocals (tree, options) {
       } catch {};
     }
 
+    if (options.removeScriptLocals) {
+      return ''
+    }
+
     return node
   })
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "posthtml-expressions",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "Expressions Plugin for PostHTML",
   "engines": {
     "node": ">=10"

package.json

@@ -41,6 +41,7 @@ You have full control over the delimiters used for injecting locals, as well as
 | **unescapeDelimiters** | `['{{{', '}}}']` | Array containing beginning and ending delimiters for unescaped locals |
 | **locals** | `{}` | Object containing any local variables you want to be available inside your expressions |
 | **localsAttr** | `locals` | Attribute name for the tag `script` which contains ***[locals](#locals)***|
+| **removeScriptLocals** | `false` | Will remove tag `script` which contains ***[locals](#locals)***|
 | **conditionalTags** | `['if', 'elseif', 'else']` | Array containing names for tags used for `if/else if/else` statements |
 | **switchTags** | `['switch', 'case', 'default']` | Array containing names for tags used for `switch/case/default` statements |
 | **loopTags** | `['each']` | Array containing names for `for` loops |

readme.md

@@ -0,0 +1 @@
+<div>My name: Scrum</div>

test/expect/script-locals-remove.html

@@ -0,0 +1,7 @@
+<script locals>
+  module.exports = {
+    name: 'Scrum'
+  }
+</script>
+
+<div>My name: {{name}}</div>

test/fixtures/script-locals-remove.html

@@ -34,3 +34,7 @@ function clean (html) {
 test('Basic', (t) => {
   return process(t, 'script-locals')
 })
+
+test('Remove script locals', (t) => {
+  return process(t, 'script-locals-remove', { removeScriptLocals: true })
+})