Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ladjs/cache-pug-templates
Cache Pug templates for Lad/Koa/Express/Connect with Redis
https://github.com/ladjs/cache-pug-templates
app cache caching connect deploy deployment engine engines express jade koa lad listen post pug redis template templates templating views
Last synced: 3 months ago
JSON representation
Cache Pug templates for Lad/Koa/Express/Connect with Redis
- Host: GitHub
- URL: https://github.com/ladjs/cache-pug-templates
- Owner: ladjs
- License: mit
- Created: 2017-09-12T07:10:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T23:14:49.000Z (about 1 year ago)
- Last Synced: 2024-09-28T08:42:35.027Z (4 months ago)
- Topics: app, cache, caching, connect, deploy, deployment, engine, engines, express, jade, koa, lad, listen, post, pug, redis, template, templates, templating, views
- Language: JavaScript
- Homepage: https://lad.js.org
- Size: 538 KB
- Stars: 26
- Watchers: 7
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cache-pug-templates
[](https://travis-ci.org/ladjs/cache-pug-templates)
[](https://codecov.io/gh/ladjs/cache-pug-templates)
[](https://github.com/sindresorhus/xo)
[](https://github.com/prettier/prettier)
[](https://lass.js.org)
[](<>)
> Cache [Pug][] templates for [Lad][]/[Koa][]/[Express][]/[Connect][].
## Table of Contents
* [Install](#install)
* [Usage](#usage)
* [Basic](#basic)
* [Koa](#koa)
* [Express](#express)
* [Options](#options)
* [Debugging](#debugging)
* [Contributors](#contributors)
* [License](#license)
## Install
[npm][]:
```sh
npm install cache-pug-templates
```
[yarn][]:
```sh
yarn add cache-pug-templates
```
## Usage
### Basic
```js
const path = require('path');
const CachePugTemplates = require('cache-pug-templates');
const views = path.join(__dirname, 'views');
const cache = new CachePugTemplates({ views });
cache.start();
```
### Koa
```js
const path = require('path');
const Koa = require('koa');
const CachePugTemplates = require('cache-pug-templates');
const app = new Koa();
// optional (e.g. if you want to cache in non-production)
// app.cache = true;
// note that koa requires us to specify a
// path name for the views directory
const views = path.join(__dirname, 'views');
app.listen(3000, () => {
const cache = new CachePugTemplates({ app, views });
cache.start();
});
```
### Express
```js
const path = require('path');
const express = require('express');
const CachePugTemplates = require('cache-pug-templates');
const app = express();
// optional (by default express defaults to `./views`)
// app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'pug');
app.listen(3000, () => {
const cache = new CachePugTemplates({ app, views });
cache.start();
});
```
## Options
* `app` (Object) - an instance of Koa, Express, or Connect
* `views` (String or Array) - a file directory path (or an Array of file directory paths) (if you pass an Express app instance as the `app` option, this will be automatically populated to your applications `views` configuration option via `app.get('views')`)
* `logger` (Object) - a logger, defaults to `console` (we recommend using [Cabin][] for your logger)
* `callback` (Function) - defaults to `false` (no operation), but if a function is provided then it will be invoked with two arguments, `file` (String) and `template` (Function)
* `cache` (Boolean) - defaults to `true`, whether or not to cache templates automatically if `cache.start()` is called (useful if you are writing tests or have a custom approach using `callback` function)
* `concurrency` (Number) - number of concurrent files that can be cached per `interval` in parallel (defaults to `1`)
* `interval` (Number) - duration of time in (milliseconds) to limit concurrency for (e.g. `1 cached file every 1000ms` is the default), this value's default is `1000`
## Debugging
If you want to check what the cache state is at anytime:
```js
const pug = require('pug');
// ...
// get everything:
console.log('pug.cache', pug.cache);
// just get the file names:
console.log('pug cached files', Object.keys(pug.cache));
```
## Contributors
| Name | Website |
| -------------- | -------------------------- |
| **Nick Baugh** | |
## License
[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
##
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/
[pug]: https://pugjs.org
[lad]: https://lad.js.org
[koa]: http://koajs.com
[express]: https://expressjs.com/
[connect]: https://github.com/senchalabs/connect
[cabin]: https://cabinjs.com