# htmlprocessor
> Process html file using special comments
Latest version **0.3.3** (published 2023-09-11) · 0 weekly downloads
## Install
```sh
npm install htmlprocessor
pnpm add htmlprocessor
yarn add htmlprocessor
bun add htmlprocessor
```
Provides the command `htmlprocessor`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.3.3 |
| Published | 2023-09-11 |
| First published | 2014-04-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 47 |
| Author | Denis Ciccale |
| Maintainers | denis |
| Keywords | process, html, build, buildtime, environment, target, optimize |
## Links
- npm: https://www.npmjs.com/package/htmlprocessor
- Repository: https://github.com/dciccale/node-htmlprocessor
- Homepage: https://github.com/dciccale/node-htmlprocessor#readme
- Issues: https://github.com/dciccale/node-htmlprocessor/issues
- npm.io page: https://npm.io/package/htmlprocessor
## Dependencies (1)
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
## Alternatives
- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads
## Recent versions
- 0.3.3 (latest) — 2023-09-11
- 0.3.2 — 2022-03-28
- 0.3.1 — 2021-04-20
- 0.3.0 — 2021-04-20
- 0.2.6 — 2017-08-10
- 0.2.5 — 2017-08-10
- 0.2.4 — 2016-08-30
- 0.2.3 — 2016-02-20
- 0.2.2 — 2016-02-17
- 0.2.1 — 2016-02-04
- 0.2.0 — 2016-01-11
- 0.1.10 — 2015-02-02
- 0.1.9 — 2015-01-21
- 0.1.8 — 2015-01-12
- 0.1.7 — 2015-01-12
- … 7 more at https://npm.io/package/htmlprocessor/versions
## README
# htmlprocessor
[](https://www.npmjs.com/package/htmlprocessor)
[](https://travis-ci.org/dciccale/node-htmlprocessor)
[](https://www.npmjs.com/package/htmlprocessor)
[](https://coveralls.io/github/dciccale/node-htmlprocessor)
`npm install -g htmlprocessor`
### Grunt/Gulp task
This module is the processor behind [grunt-processhtml](https://www.npmjs.com/package/grunt-processhtml), [gulp-processhtml](https://www.npmjs.com/package/gulp-processhtml) tasks.
For plenty of examples visit the [documentation](https://github.com/dciccale/grunt-processhtml#readme).
## CLI
Outputs help
```sh
$ htmlprocessor -h
Usage: htmlprocessor file-to-process.html [options]
-h, --help display this help message
-v, --version display the version number
-l, --list file to output list of replaced files
-o, --output file to output processed HTML to
-d, --data pass a JSON file to processor
-e, --env specify an environment
-r, --recursive recursive processing
-c, --comment-marker change the comment marker
-i, --include-base set the directory to include files from
-s, --strip strip blocks matched by other environments
--custom-block-type specify custom block type
```
Outputs version number
```sh
$ htmlprocessor -v
```
Outputs to `file-to-process.processed.html`.
```sh
$ htmlprocessor file-to-process.html
```
Outputs to `processed/file.html`.
```sh
$ htmlprocessor file-to-process.html -o processed/file.html
```
Pass some data
```sh
$ htmlprocessor file-to-process.html -o processed/file.html -d data.json
```
Specify an environment
```sh
$ htmlprocessor file-to-process.html -o processed/file.html -e dev
```
Allow recursive processing
```sh
$ htmlprocessor file-to-process.html -o processed/file.html -r
```
Change the comment marker to ``
```sh
$ htmlprocessor file-to-process.html -o processed/file.html --comment-marker process
```
## List option
Create a list of files that were replaced and use that list to streamline the build process.
Note: This new option does not affect in any way the previous existing functionality (i.e. it's backward compatible).
```sh
$ htmlprocessor file-to-process.html -o processed/file.html --list wrk/replacement.list
```
Assumning you have this code in an HTML (or JSP)
```sh
.
.
.
.
.
.
.
.
.
```
The file "wrk/replacement.list" will contain something like this:
```sh
file-to-process.html:js/bower_components/bootstrap/dist/css/bootstrap.css
file-to-process.html:content/bootstrap-responsive.min.css
file-to-process.html:content/styles.css
file-to-process.html:content/myApplicationStyles.css
file-to-process.html:js/bower_components/jquery/dist/jquery.js
file-to-process.html:js/bower_components/angular/angular.js
file-to-process.html:js/bower_components/angular-route/angular-route.js
file-to-process.html:app/app.js
file-to-process.html:app/filters/filters.js
file-to-process.html:app/controllers/applications.js
```
And you can use these commands to concatenate and eventually minify without having to update the build to tell
it where it should pickup each files. Also, in this way it orders the global file content in the same manner
as your individual includes originally were.
```sh
sh -c "cat `cat wrk/replacement.list | grep '\.js$' | cut -d: -f2` > dist/js/myApplication.js"
sh -c "cat `cat wrk/replacement.list | grep '\.css$' | cut -d: -f2` > dist/css/myApplication.css"
```
If you processed more than a single "html" file, you can change the grep like this:
```sh
... | grep 'file-to-process.html:.*\.js$' | ... > dist/js/myApplication.js
... | grep 'other-file-to-process.html:.*\.js$' | ... > dist/js/myApplicationOther.js
```
The originating file name is included in the list file for that very purpose.
## License
See [LICENSE.txt](https://raw.github.com/dciccale/node-htmlprocessor/master/LICENSE-MIT)
---
_Source: https://npm.io/package/htmlprocessor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._