Skip to content
Transform HTML with JavaScript
JavaScript
Branch: master
Clone or download
Latest commit 7db4811 May 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src 4.1.0 May 17, 2019
test 3.3.1 May 4, 2019
.appveyor.yml 1.0.0 Jan 18, 2019
.benchmark.js 4.1.0 May 17, 2019
.editorconfig 3.1.0 Apr 19, 2019
.gitignore 4.1.0 May 17, 2019
.jsdocrc 4.1.0 May 17, 2019
.travis.yml 4.0.0 May 6, 2019
CHANGELOG.md
CONTRIBUTING.md 1.1.0 Feb 11, 2019
LICENSE.md 1.1.0 Feb 11, 2019
README.md 4.1.0 May 17, 2019
babel.config.js
package.json 4.1.0 May 17, 2019
rollup.config.js

README.md

phtml phtml

NPM Version Build Status Support Chat

phtml is a tool for transforming HTML with JavaScript.

It fully embraces the HTML language, and aims to help you write and maintain HTML that you and future you feel good about.

phtml helps you compose reusable templates and components, or automate image size attributes and schema.org microdata and heading levels, or transform modern CSS with PostCSS and JS with Babel.

It works in the command line and Node, but also Grunt, Gulp, , Webpack, Rollup, and even the browser itself.

Usage

Transform HTML files directly from the command line:

npx phtml source.html output.html

Include plugins directly from the command line:

npx phtml source.html output.html -p @phtml/markdown,@phtml/image-alt

Transform strings from the command line:

echo "<h1 md>phtml **Markdown**</h1>" | npx phtml -p @phtml/markdown

# <h1>phtml <strong>Markdown</strong></h1>

Node

Add phtml to your build tool:

npm install phtml --save-dev

Use phtml to process your CSS:

const phtml = require('phtml');

phtml.process(YOUR_HTML, /* processOptions */, /* pluginOrPlugins */);

Node Example

const phtml = require('phtml');

const html = `<my-component class="main">
  <title>Super Title</title>
  <text>Awesome Text</text>
</my-component>`;

phtml.process(html, { from: 'my-component.html' }).then(console.log);

/* Result {
  from: 'component.html',
  to: 'component.html',
  root: Fragment {
    name: '#document-fragment',
    nodes: NodeList [
      Element {
        name: "my-component",
        attrs: AttributeList [
          { name: "class", value: "main" }
        ],
        nodes: NodeList [
          Text "\n  ",
          Element {
            name: "title",
            nodes: NodeList [
              Text "Super Title"
            ]
          },
          Text "\n  ",
          Element {
            name: "text",
            nodes: NodeList [
              Text "Awesome Text"
            ]
          },
          Text "\n"
        ]
      }
    ]
  }
}

Using Plugins in Node

Add a phtml Plugin to your build tool:

npm install phtml-some-thing --save-dev
const phtml = require('phtml');
const postHtmlSomeThing = require('phtml-some-thing');

phtml.use(
  postHtmlSomeThing(/* pluginOptions */)
).process(YOUR_HTML);

Plugins

You can find phtml plugins on npm.

https://www.npmjs.com/search?q=keywords:phtml-plugin

Plugin Creation

Create plugins directly from the command line:

npm init phtml-plugin

# Plugin Name: Example (becomes `phtml Hello` / `phtml-hello`)
# Keywords: awesome,blossom (added to package.json keywords)

Once the command finishes, a new plugin is fully scaffolded with bare functionality, documentation, and tests. Within the plugin directory, functionality is added to src/index.js.

Advanced Plugin Creation

Create plugins using a new Plugin class:

import phtml from 'phtml';

export default new phtml.Plugin('phtml-hello', pluginOptions => {
	// initialization logic

  return {
    Element(element, result) {
      // runtime logic, do something with an element
    },
    Root(root, result) {
      // runtime logic, do something with the root
    }
  };
});

The runtime plugin can visit nodes as they are entered or exited.

Browser Usage

phtml works in the browser, which may be great for experimentation:

<script src="https://unpkg.com/phtml"></script>
<script>
const html = `<my-component class="main">
  <title>Super Title</title>
  <text>Awesome Text</text>
</my-component>`;

phtml.process(html, { from: 'my-component.html' }).then(console.log);
</script>

Note that the browser version of phtml is 52 kB because it includes its own HTML parser, parse5.

You can’t perform that action at this time.