fix: add the root dir of the module to exports in the package.json

webdiscus · Nov 8, 2023 · 54a43d5 · 54a43d5
1 parent 4bbd285
commit 54a43d5
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 66 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Change log
 
-## 3.0.0 (2023-10-29)
+## 3.0.1 (2023-11-08)
+
+- fix: add the root dir of the module to exports in the package.json
+- test: update manual tests for using with the Eta version 3.x
+- docs: update readme for live reloading
+
+## 3.0.0 (2023-11-07)
 
 - feat(BREAKING CHANGE): changed `postprocess` callback arguments and return\
   OLD:

diff --git a/README.md b/README.md
@@ -955,7 +955,7 @@ module.exports = {
       },
     }),
     // your plugin
-    new MyBundlerPlugin({ enable: true });
+    new MyBundlerPlugin({ enabled: true });
   ],
 };
 ```
@@ -2535,10 +2535,12 @@ Use this options only if you don't have a referenced source file of a script in
 
 > **Note**
 > 
-> The `devServer.hot` must be true.
+> The `devServer.hot` must be `true`.
 
 If you already have a js file in html, this setting should be `false` as Webpack automatically injects the hot update code into the compiled js file.
 
+Also see [Setup Live Reload](#setup-live-reload).
+
 <a id="option-verbose" name="option-verbose"></a>
 
 ### `verbose`
@@ -3950,6 +3952,13 @@ module.exports = {
 };
 ```
 
+> **Warning**
+> 
+> If you don't have a referenced source script file in HTML, then set the [hotUpdate](#option-hot-update) option to `true` to enable live reload.
+> Besides, the `devServer.hot` must be `true` (defaults).
+> 
+
+
 ---
 
 #### [↑ back to contents](#contents)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "html-bundler-webpack-plugin",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "HTML bundler plugin for webpack handles a template as an entry point, extracts CSS and JS from their sources referenced in HTML, supports template engines like Eta, EJS, Handlebars, Nunjucks.",
   "keywords": [
     "html",
@@ -66,6 +66,7 @@
     "types.d.ts"
   ],
   "exports": {
+    ".": "./src/index.js",
     "./plugins": "./plugins/index.js",
     "./plugins/favicons-bundler-plugin": {
       "types": "./plugins/favicons-bundler-plugin/index.d.ts",

diff --git a/test/manual/preprocessor-default/src/views/home.eta b/test/manual/preprocessor-default/src/views/home.eta
@@ -4,14 +4,14 @@
   <script src="./main.js"></script>
 </head>
 <body>
-  <%~ includeFile('/src/views/partials/header') %>
+  <%~ include('/src/views/partials/header') %>
   <h1><%= headline %></h1>
   <ul class="people">
     <% for (let i = 0; i < people.length; i++) {%>
     <li><%= people[i] %>></li>
     <% } %>
   </ul>
   <img src="../images/apple.png" alt="apple" />
-  <%~ includeFile('/src/views/partials/footer') %>
+  <%~ include('/src/views/partials/footer') %>
 </body>
 </html>
diff --git a/test/manual/watch-dependencies-bootstrap/src/views/home.html b/test/manual/watch-dependencies-bootstrap/src/views/home.html
@@ -1,23 +1,31 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
-<head>
-  <title>Test</title>
-  <link rel="icon" href="apple.png">
-  <link href="bootstrap" rel="stylesheet">
-  <link href="./style.css" rel="stylesheet">
-  <script src="https://code.jquery.com/jquery-1.12.4.min.js" defer="defer"></script>
-  <script src="bootstrap" defer="defer"></script>
-  <script src="./main.js" defer="defer"></script>
-</head>
-<body>
-  <%~ includeFile('/src/views/partials/header') %>
-  <h1>Hello World!</h1>
-  <img src="apple.png">
-  <p><button type="button" class="btn-modal btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@mdo">Open modal</button></p>
-  <%~ includeFile('/src/views/partials/footer') %>
-  <%~ includeFile('/src/views/partials/modal.html') %>
+  <head>
+    <title>Test</title>
+    <link rel="icon" href="apple.png" />
+    <link href="bootstrap" rel="stylesheet" />
+    <link href="./style.css" rel="stylesheet" />
+    <script src="https://code.jquery.com/jquery-1.12.4.min.js" defer="defer"></script>
+    <script src="bootstrap" defer="defer"></script>
+    <script src="./main.js" defer="defer"></script>
+  </head>
+  <body>
+    <%~ include('/src/views/partials/header') %>
+    <h1>Hello World!</h1>
+    <img src="apple.png" />
+    <p>
+      <button
+        type="button"
+        class="btn-modal btn btn-primary"
+        data-toggle="modal"
+        data-target="#exampleModal"
+        data-whatever="@mdo">
+        Open modal
+      </button>
+    </p>
+    <%~ include('/src/views/partials/footer') %> <%~ include('/src/views/partials/modal.html') %>
 
-  <script src="./app.js"></script>
-  <script src="@test-fixtures/js"></script>
-</body>
+    <script src="./app.js"></script>
+    <script src="@test-fixtures/js"></script>
+  </body>
 </html>
diff --git a/test/manual/watch-dependencies/src/views/home.html b/test/manual/watch-dependencies/src/views/home.html
diff --git a/...al/watch-dependencies/src/views/apple.png → ...ch-dependencies/src/views/pages/apple.png b/...al/watch-dependencies/src/views/apple.png → ...ch-dependencies/src/views/pages/apple.png
diff --git a/test/manual/watch-dependencies/src/views/pages/home.html b/test/manual/watch-dependencies/src/views/pages/home.html
@@ -0,0 +1,14 @@
+<!doctype html>
+<html>
+  <head>
+    <link rel="icon" href="apple.png" />
+    <title><%= title %></title>
+    <script src="./main.js"></script>
+  </head>
+  <body>
+    <%~ include('/src/views/partials/header') %>
+    <h1>Hello World!</h1>
+    <img src="apple.png" />
+    <%~ include('/src/views/partials/footer') %>
+  </body>
+</html>
diff --git a/...nual/watch-dependencies/src/views/main.js → ...atch-dependencies/src/views/pages/main.js b/...nual/watch-dependencies/src/views/main.js → ...atch-dependencies/src/views/pages/main.js
diff --git a/test/manual/watch-dependencies/webpack.config.js b/test/manual/watch-dependencies/webpack.config.js
@@ -11,20 +11,29 @@ module.exports = {
 
   plugins: [
     new HtmlBundlerPlugin({
-      entry: {
-        index: {
-          import: './src/views/home.html',
-          data: {
-            title: 'Home',
-          },
-        },
-      },
-      // configure paths to watch file changes
-      watchFiles: {
-        paths: ['./src'],
-        //files: [/\.(html|js|sc?ss)$/],
-        //ignore: [],
-      },
+      // auto processing templates in the path
+      entry: './src/views/pages/',
+
+      // define templates manual
+      // entry: {
+      //   index: {
+      //     import: './src/views/pages/home.html',
+      //     // the template data
+      //     data: {
+      //       title: 'Home',
+      //     },
+      //   },
+      // },
+
+      // test: configure paths to watch file changes
+      // watchFiles: {
+      //   paths: ['./src'],
+      //   //files: [/\.(html|js|sc?ss)$/],
+      //   //ignore: [],
+      // },
+
+      data: { title: 'Home' }, // global data for all templates
+      hotUpdate: true, // <= use it only if your html don't have a js file
       verbose: true,
     }),
   ],

diff --git a/test/manual/watch-html-without-js/src/views/home.html b/test/manual/watch-html-without-js/src/views/home.html
@@ -1,12 +1,12 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
-<head>
-  <link rel="icon" href="favicon.ico">
-  <title>Home</title>
-</head>
-<body>
-  <%~ includeFile('/src/views/partials/header') %>
-  <h1>Home</h1>
-  <%~ includeFile('/src/views/partials/footer') %>
-</body>
+  <head>
+    <link rel="icon" href="favicon.ico" />
+    <title>Home</title>
+  </head>
+  <body>
+    <%~ include('/src/views/partials/header') %>
+    <h1>Home</h1>
+    <%~ include('/src/views/partials/footer') %>
+  </body>
 </html>