npmpackage.info

Gathering detailed insights and metrics for posthtml-modules

posthtml-modules

Modules Plugin

0.9.1

MIT

JavaScript

29.11 kB

Installations

npm install posthtml-modules

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

16.18.1

NPM Version

8.19.2 Pull Requests

Open

1

Total

71

Closed

18

Merged

52

Issues

Open

11

Total

31

Closed

20

Releases

v0.9.1

Updated on Mar 02, 2023

v0.9.0

Updated on May 04, 2022

v0.8.1

Updated on Mar 30, 2022

v0.8.0

Updated on Dec 01, 2021

v0.7.6

Updated on Nov 08, 2021

v0.7.4

Updated on Mar 04, 2021

View All 14 releases

Languages

JavaScript

HTML

JavaScript (95.98%)

HTML (4.02%)

Developer

canvaskisa

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

83 Stars

176 Commits

11 Forks

8 Watchers

8 Branches

17 Contributors

Updated on Apr 13, 2025

Maintainers

View All 17 Contributors

Package Meta Information

Latest Version

0.9.1

Package Id

posthtml-modules@0.9.1

Unpacked Size

29.11 kB

Size

8.49 kB

File Count

NPM Version

8.19.2

Node Version

16.18.1

Published on

Mar 02, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

is-json lodash posthtml-expressions posthtml-match-helper posthtml-render

Dev Dependencies

@commitlint/cli @commitlint/config-angular ava c8 clinton conventional-changelog-cli husky lint-staged posthtml xo

Modules Plugin

Import and process HTML Modules with PostHTML

Install

1npm i -D posthtml-modules

Example

1<!-- index.html -->
2<html>
3<body>
4  <module href="./module.html">
5    title
6  </module>
7</body>
8</html>

1<!-- module.html -->
2<header>
3  <h1>
4    Test <content></content>
5  </h1>
6</header>

1const { readFileSync } = require('fs')
2const posthtml = require('posthtml')
3const options = { /* see available options below */ }
4
5posthtml()
6  .use(require('posthtml-modules')(options))
7  .process(readFileSync('index.html', 'utf8'))
8  .then((result) => result)
9  });

1<html>
2 <body>
3   <header>
4     <h1>Test title</h1>
5   </header>
6  </body>
7</html>

Options

`root`

Type: string
Default: ./

Root path for modules lookup.

`plugins`

Type: array | function
Default: []

PostHTML plugins to apply for every parsed module.

If a function provided, it will be called with module's file path.

`from`

Type: string
Default: ''

Root filename for processing apply, needed for path resolving (it's better to always provide it).

`initial`

Type: boolean
Default: false

Apply plugins to root file after modules processing.

`tag`

Type: string
Default: module

Use a custom tag name.

`attribute`

Type: string
Default: href

Use a custom attribute name.

`locals`

Type: object
Default: {}

Pass data to the module.

If present, the JSON object from the locals="" attribute will be merged on top of this, overwriting any existing values.

`attributeAsLocals`

Type: boolean
Default: false

All attributes on <module></module> will be added to locals

`parser`

Type: object
Default: {}

Options for the PostHTML parser.

By default, posthtml-parser is used.

`expressions`

Type: object
Default: {}

Options to forward to posthtml-expressions, like custom delimiters for example. Available options can be found here.

Component options

`locals`

You can pass data to a module using a locals="" attribute.

Must be a valid JSON object.

Example:

1<!-- module.html -->
2<p>The foo is {{ foo }} in this one.</p>
3<content></content>

1<!-- index.html -->
2<module href="./module.html" locals='{"foo": "strong"}'>
3  <p>Or so they say...</p>
4</module>

Result

1<p>The foo is strong in this one.</p>
2<p>Or so they say...</p>

`attributeAsLocals`

All attributes on <module></module> will be added to locals

Example:

1<!-- module.html -->
2<div class="{{ class }}" id="{{ id }}" style="{{ style }}">
3  <content></content>
4</div>

1<!-- index.html -->
2<module 
3  href="module.html" 
4  class="text-center uppercase" 
5  id="example"
6  style="display: flex; gap: 2;"
7>
8  Module content
9</module>

Result

1<div class="text-center uppercase" id="example" style="display: flex; gap: 2;">
2  Module content
3</div>

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to posthtml-modules

Other packages similar to posthtml-modules

posthtml-modules

Installations

Developer Guide

No

CommonJS

>=10

16.18.1

8.19.2

Pull Requests

1

71

18

52

Issues

11

31

20

Releases

Languages

Developer

canvaskisa

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Modules Plugin

Install

Example

Options

root

plugins

from

initial

tag

attribute

locals

attributeAsLocals

parser

expressions

Component options

locals

Result

attributeAsLocals

Result

10

10

10

4

3

0

0

0

0

0

0

0

0

3

/10

`root`

`plugins`

`from`

`initial`

`tag`

`attribute`

`locals`

`attributeAsLocals`

`parser`

`expressions`

`locals`

`attributeAsLocals`