https://github.com/posthtml/posthtml-load-options
Autoload Options for PostHTML
https://github.com/posthtml/posthtml-load-options
Last synced: 6 months ago
JSON representation
Autoload Options for PostHTML
- Host: GitHub
- URL: https://github.com/posthtml/posthtml-load-options
- Owner: posthtml
- License: other
- Created: 2016-06-01T16:24:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-14T13:38:36.000Z (about 9 years ago)
- Last Synced: 2025-08-06T11:46:12.919Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![coverage][cover]][cover-url]
[![code style][style]][style-url]
[![chat][chat]][chat-url]
Load Options
Autoload Options for PostHTML
Install
```bash
npm i -D posthtml-load-options
```
Usage
### `package.json`
Create a **`posthtml`** section in **`package.json`**.
```
Root
|– client
|– public
|
|- package.json
```
```json
{
"dependencies": {
"posthtml-sugarml": "^1.0.0"
},
"posthtml": {
"parser": "posthtml-sugarss",
"from": "path/to/src/file.html",
"to": "path/to/dest/file.html"
}
}
```
### `.posthtmlrc`
Create a **`.posthtmlrc`** file.
```
Root
|– client
|– public
|
|-.posthtmlrc
|- package.json
```
```json
{
"parser": "posthtml-sugarss",
"from": "path/to/src/file.html",
"to": "path/to/dest/file.html"
}
```
### `posthtml.config.js`
Create a **`posthtml.config.js`** file.
```
Root
|– client
|– public
|
|- posthtml.config.js
|- package.json
```
```js
module.exports = (ctx) => {
return {
parser: ctx.ext ==='.sml' ? 'posthtml-sugarss' : false,
from: 'path/to/src/file.html',
to: 'path/to/dest/file.html'
}
}
```
Options
**`parser`**:
```js
parser: 'posthtml-sugarss'
```
**`from`**:
```js
from: 'path/to/dest/file.html'
```
**`to`**:
```js
to: 'path/to/dest/file.html'
```
**`render`**:
```js
render: 'posthtml-jsx'
```
### Context
When using a function in `(posthtml.config.js)`, it's possible to pass context to `posthtml-load-options`, which will be evaluated before loading your options. By default `ctx.env (process.env.NODE_ENV)` and `ctx.cwd (process.cwd())` are available.
Example
**posthtml.config.js**
```js
export default config = (ctx) => {
return {
parser: ctx.ext === '.sml' ? 'posthtml-sugarml' : false,
from: 'client/index.html',
to: 'public/index.html'
}
}
```
### 
```js
import { dirname } from 'path'
import { readFileSync } from 'fs'
import posthtml from 'posthtml'
import optionsrc from 'posthtml-load-options'
const sml = readFileSync('./client/index.sml', 'utf8')
const ctx = { ext: dirname(sml) }
optionsrc(ctx).then((options) => {
posthtml()
.process(sml, options)
.then((result) => console.log(result.html))
}))
```
Maintainer
[npm]: https://img.shields.io/npm/v/posthtml-load-options.svg
[npm-url]: https://npmjs.com/package/posthtml-load-options
[node]: https://img.shields.io/node/v/posthtml-load-options.svg
[node-url]: https://nodejs.org/
[deps]: https://david-dm.org/michael-ciniawsky/posthtml-load-options.svg
[deps-url]: https://david-dm.org/michael-ciniawsky/posthtml-load-options
[tests]: http://img.shields.io/travis/michael-ciniawsky/posthtml-load-options.svg
[tests-url]: https://travis-ci.org/michael-ciniawsky/posthtml-load-options
[cover]: https://coveralls.io/repos/github/michael-ciniawsky/posthtml-load-options/badge.svg?branch=master
[cover-url]: https://coveralls.io/github/michael-ciniawsky/posthtml-load-options?branch=master
[style]: https://img.shields.io/badge/code%20style-standard-yellow.svg
[style-url]: http://standardjs.com/
[chat]: https://badges.gitter.im/posthtml/posthtml.svg
[chat-url]: https://gitter.im/posthtml/posthtml?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"
