https://github.com/ericmorand/html-deps
https://github.com/ericmorand/html-deps
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ericmorand/html-deps
- Owner: ericmorand
- License: apache-2.0
- Created: 2017-09-27T19:57:49.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-28T17:26:32.000Z (almost 9 years ago)
- Last Synced: 2025-10-19T02:29:28.841Z (9 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# html-deps
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
Walk the dependency graph of an HTML document.
## Installation
```bash
npm install html-deps
```
# API
`let HTMLDeps = require('html-deps');`
## depper = HTMLDeps()
Return an object transform stream `depper` that expects entry filenames.
## depper.inline(source, basedir, callback)
Adds a new inline file to the dependency graph, where source is the HTML source to include and basedir is the directory to pretend it's being created in. A basedir is required to properly resolve dependencies and defaults to process.cwd().
# Example
``` js
let HTMLDeps = require('html-deps');
let depper = new HTMLDeps();
let entry = '/path/to/your/document.html';
depper.on('data', function (dependency) {
// do something with dependency
});
depper.on('missing', function (dependency) {
// do something with missing dependency
});
depper.on('error', function (error) {
// do something on error
});
depper.on('finish', function (error) {
// do something when done
});
d.end(entry);
```
## Contributing
* Fork the main repository
* Code
* Implement tests using [node-tap](https://github.com/tapjs/node-tap)
* Issue a pull request keeping in mind that all pull requests must reference an issue in the issue queue
## License
Apache-2.0 © [Eric MORAND]()
[npm-image]: https://badge.fury.io/js/html-deps.svg
[npm-url]: https://npmjs.org/package/html-deps
[travis-image]: https://travis-ci.org/ericmorand/html-deps.svg?branch=master
[travis-url]: https://travis-ci.org/ericmorand/html-deps
[daviddm-image]: https://david-dm.org/ericmorand/html-deps.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/ericmorand/html-deps
[coveralls-image]: https://coveralls.io/repos/github/ericmorand/html-deps/badge.svg
[coveralls-url]: https://coveralls.io/github/ericmorand/html-deps