Merge pull request #3 from SubZtep/render-locals

SubZtep · web-flow · commit bcef4127e002 · 2021-04-23T22:38:10.000+02:00
Render locals
diff --git a/README.md b/README.md
@@ -2,52 +2,59 @@
 
 ![test](https://github.com/SubZtep/vite-plugin-pug/workflows/npm%20test/badge.svg)
 
-A plugin that makes [Vite](https://vitejs.dev/) parse `<pug file="example.pug"></pug>` in your `index.html`. The rendered template replaces this tag with the compiled markup.
+A plugin that makes [Vite](https://vitejs.dev/) parse `<pug src="example.pug"></pug>` in your `index.html`. The rendered template replaces this tag with the compiled markup.
 
-> :information_source: **Vue** single file components don't require this plugin, adding [Pug](https://www.npmjs.com/package/pug) to the dependency list is enough. — aka `npm i -D pug`
+> :information_source: **Vue** single file components don’t require this plugin, adding [Pug](https://www.npmjs.com/package/pug) to the dependency list is enough. — aka `npm i -D pug`
 
-- Handle self-closing tags.
-- Works with multiple `pug` tags.
-- Generated _TypeScript_ declarations.
-- Common JS module but tested as ES module.
-- Auto-reload browser when saving changes to `.pug` file.
+## Features (exists and awaiting)
+
+- [x] CommonJS and ES module builds.
+- [x] Handle self-closing `pug` tags.
+- [x] Works with multiple `pug` tags.
+- [x] Generated _TypeScript_ declarations.
+- [x] Reload when saving changes on a `.pug` file.
+- [x] Support Pug local variables.
+- [ ] _Experimental hot module reloading functionality._
+- [ ] _Handle adding or removing files._
 
 ## Installation
 
 Using npm:
 
-```console
-npm install vite-plugin-pug --save-dev
+```sh
+$ npm install vite-plugin-pug --save-dev
 ```
 
 ## Configuration
 
 Create a `vite.config.js` [configuration file](https://vitejs.dev/config/) and import the plugin:
 
 ```js
+// vite.config.(js|ts)
 import { defineConfig } from "vite"
 import pugPlugin from "vite-plugin-pug"
 
+const options = { pretty: true } // FIXME: pug pretty is deprecated!
+const locals = { name: "My Pug" }
+
 export default defineConfig({
   plugins: [
-    pugPlugin()
+    pugPlugin(options, locals)
   ]
 })
 ```
 
-### Plugin Options
+### Plugin Parameters
 
-Accept [Pug options](https://pugjs.org/api/reference.html#options) as an optional parameter.
-
-```js
-// vite.config.js
-pugPlugin({
-  pretty: true
-})
-```
+| Name    | Required | Description                                                         |
+| ------- | -------- | ------------------------------------------------------------------- |
+| options | optional | [Pug options](https://pugjs.org/api/reference.html#options) object. |
+| locals  | optional | Data object with Pug locals.                                        |
 
 ## Usage
 
+### Simple
+
 Create a template file.
 
 ```pug
@@ -56,24 +63,28 @@ h1 Hello World
 p I'm a cool Vite project!
 ```
 
-Embed `pug` tag with `file` attribute somewhere.
+Embed `pug` tag with `src` attribute somewhere.
 
 ```html
 <!-- index.html -->
 <html>
-<body>
-  <pug file="index.pug" />
-  <script type="module" src="/main.ts"></script>
-</body>
+  <body>
+    <pug src="index.pug" />
+    <script type="module" src="/main.ts"></script>
+  </body>
 </html>
 ```
 
 That's it.
 
-> :bulb: Check out **an example** implementation [in this repository](https://github.com/SubZtep/css-tetris-3d).
+> :bulb: Check out **its starter** implementation [in this repository](https://github.com/SubZtep/css-tetris-3d).
+
+## Example
+
+Please find the [examples](examples/multipage) folder in this repository.
 
 ## Contribution
 
- ~~After Rollup~~ I started to use _**Vite**_ recently but this is not a reason to leave my beloved template format behind. Its [lack of active](https://github.com/marlonmarcello/vite-plugin-pug) Pug plugins made me make one quickly. It does the job to me, I will extend it when I need it. :suspect:
+~~After Rollup~~ I started to use _**Vite**_ recently but this is not a reason to leave my beloved template format behind. Its [lack of active](https://github.com/marlonmarcello/vite-plugin-pug) Pug plugins made me make one quickly. It does the job to me, I will extend it when I need it. :suspect:
 
- If it doesn't match with your setup please [start a new discussion](https://github.com/SubZtep/vite-plugin-pug/discussions/new) about it, I'm interested to see other workflows. If something is simply not working, please [raise an issue](https://github.com/SubZtep/vite-plugin-pug/issues/new). **PRs certainly welcome!** (.❛ ᴗ ❛.)
+If it doesn't match with your setup please [start a new discussion](https://github.com/SubZtep/vite-plugin-pug/discussions/new) about it, I'm interested to see other workflows. If something is simply not working, please [raise an issue](https://github.com/SubZtep/vite-plugin-pug/issues/new). **PRs certainly welcome!** (.❛ ᴗ ❛.)
diff --git a/__tests__/index.ts b/__tests__/index.ts
@@ -0,0 +1,32 @@
+import { pugs } from "../src/index"
+
+describe("html parser", () => {
+  const html = `<html>
+    <pug>moo</pug>
+    <pug file="inner.pug"/>
+    <pug file="INner2.pug" />
+    <pug file="./nested/inner3.pug"></pug>
+    <pug src="nested/inner4.pug">hello</pug>
+    <p>a</p>
+  </html>`
+
+  test("warning for deprecated", () => {
+    const spy = jest.spyOn(console, "warn").mockImplementation()
+    pugs(html, _ => "", console)
+    expect(console.warn).toHaveBeenCalledTimes(3)
+    spy.mockRestore()
+  })
+
+  test("find all source files", () => {
+    let filenames: string[] = []
+    pugs(html, filename => filenames.push(filename).toString())
+    expect(filenames).toEqual(["inner.pug", "INner2.pug", "./nested/inner3.pug", "nested/inner4.pug"]
+    )
+  })
+
+  test("replace tags", () => {
+    const parsed = pugs(html, _ => "")
+    expect(parsed).toContain("<html>")
+    expect(parsed.split("pug")).toHaveLength(3)
+  })
+})
diff --git a/__tests__/transformer.ts b/__tests__/transformer.ts
diff --git a/examples/multipage/README.md b/examples/multipage/README.md
@@ -0,0 +1,18 @@
+# :paw_prints:
+
+A basic example of how to use this plugin with **multiple pages** including **Pug locals**.
+
+Bootstrapped with the TypeScript variant of vanilla Vite template with the following command.
+
+```sh
+$ npm init @vitejs/app
+```
+
+To try out install dependencies and start the local server.
+
+```sh
+$ npm i
+$ npm run dev
+```
+
+Open up http://localhost:3000/ and close down when you finish. :mushroom:
diff --git a/examples/multipage/favicon.svg b/examples/multipage/favicon.svg
@@ -0,0 +1,15 @@
+<svg width="410" height="404" viewBox="0 0 410 404" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M399.641 59.5246L215.643 388.545C211.844 395.338 202.084 395.378 198.228 388.618L10.5817 59.5563C6.38087 52.1896 12.6802 43.2665 21.0281 44.7586L205.223 77.6824C206.398 77.8924 207.601 77.8904 208.776 77.6763L389.119 44.8058C397.439 43.2894 403.768 52.1434 399.641 59.5246Z" fill="url(#paint0_linear)"/>
+<path d="M292.965 1.5744L156.801 28.2552C154.563 28.6937 152.906 30.5903 152.771 32.8664L144.395 174.33C144.198 177.662 147.258 180.248 150.51 179.498L188.42 170.749C191.967 169.931 195.172 173.055 194.443 176.622L183.18 231.775C182.422 235.487 185.907 238.661 189.532 237.56L212.947 230.446C216.577 229.344 220.065 232.527 219.297 236.242L201.398 322.875C200.278 328.294 207.486 331.249 210.492 326.603L212.5 323.5L323.454 102.072C325.312 98.3645 322.108 94.137 318.036 94.9228L279.014 102.454C275.347 103.161 272.227 99.746 273.262 96.1583L298.731 7.86689C299.767 4.27314 296.636 0.855181 292.965 1.5744Z" fill="url(#paint1_linear)"/>
+<defs>
+<linearGradient id="paint0_linear" x1="6.00017" y1="32.9999" x2="235" y2="344" gradientUnits="userSpaceOnUse">
+<stop stop-color="#41D1FF"/>
+<stop offset="1" stop-color="#BD34FE"/>
+</linearGradient>
+<linearGradient id="paint1_linear" x1="194.651" y1="8.81818" x2="236.076" y2="292.989" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FFEA83"/>
+<stop offset="0.0833333" stop-color="#FFDD35"/>
+<stop offset="1" stop-color="#FFA800"/>
+</linearGradient>
+</defs>
+</svg>
diff --git a/examples/multipage/index.html b/examples/multipage/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite App</title>
+  </head>
+  <body>
+    <pug src="./index.pug"></pug>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/examples/multipage/index.pug b/examples/multipage/index.pug
@@ -0,0 +1,6 @@
+include nested/index.pug
+
+p
+  a(href=baseUrl) simply nested
+  =" — "
+  a(href=baseUrl+"test.html") html link
diff --git a/examples/multipage/nested/index.html b/examples/multipage/nested/index.html
@@ -0,0 +1,2 @@
+html
+<pug src="./nested/index.pug"></pug>
diff --git a/examples/multipage/nested/index.pug b/examples/multipage/nested/index.pug
@@ -0,0 +1,2 @@
+h1 hello #{hello}
+p nested pug
diff --git a/examples/multipage/nested/test.html b/examples/multipage/nested/test.html
@@ -0,0 +1 @@
+test html
diff --git a/examples/multipage/package.json b/examples/multipage/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "multipage",
+  "version": "0.0.0",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "serve": "vite preview"
+  },
+  "devDependencies": {
+    "typescript": "^4.2.3",
+    "vite": "^2.1.5"
+  }
+}
diff --git a/examples/multipage/src/main.ts b/examples/multipage/src/main.ts
@@ -0,0 +1,8 @@
+import './style.css'
+
+const app = document.querySelector<HTMLDivElement>('#app')!
+
+app.innerHTML = `
+  <h1>Hello Vite!</h1>
+  <a href="https://vitejs.dev/guide/features.html" target="_blank">Documentation</a>
+`
diff --git a/examples/multipage/src/style.css b/examples/multipage/src/style.css
@@ -0,0 +1,8 @@
+#app {
+  font-family: Avenir, Helvetica, Arial, sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  text-align: center;
+  color: #2c3e50;
+  margin-top: 60px;
+}
diff --git a/examples/multipage/tsconfig.json b/examples/multipage/tsconfig.json
@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "moduleResolution": "Node",
+    "strict": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "types": ["vite/client"],
+    "noEmit": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true
+  },
+  "include": ["./src"]
+}
diff --git a/examples/multipage/vite.config.ts b/examples/multipage/vite.config.ts
@@ -0,0 +1,16 @@
+import { resolve } from "path"
+import { defineConfig } from "vite"
+import pugPlugin from "../../src/index"
+
+export default defineConfig({
+  plugins: [pugPlugin(undefined, { hello: "world", baseUrl: "/nested/" })],
+  base: "./",
+  build: {
+    rollupOptions: {
+      input: {
+        main: resolve(__dirname, "index.html"),
+        nested: resolve(__dirname, "nested/index.html"),
+      },
+    },
+  },
+})
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/transformer.ts b/src/transformer.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+html`
	`2`	`+<pug src="./nested/index.pug"></pug>`