npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mustache-cli

v2.3.2

Published

Mustache's CLI interface.

Downloads

152

Readme

mustache-cli

Description

Mustache's CLI interface.

Usage

npm install mustache-cli --global
mustache-cli -h

./tpl/layout.mustache

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>{{title}}</title>
  </head>
  <body>
    <div>
      {{>tpl}}
    </div>
  </body>
</html>

./tpl/page.mustache

<h1>{{title}}</h1>
{{>content}}

./conf/index.json

{
    "__root": "layout.mustache",
    "__tpl": "page.mustache",
    "_content": "<strong>Hello World</strong>",
    "title": "Home"
}

./conf/multi.js

const output = require('mustache-cli').output

module.exports = function(opts){
  return {
    __file: 'multi/index.html',
    __root: 'layout.mustache',
    _tpl: '{{{ html }}}',
    title: 'Multi',
    html: function(){
      const page1 = output({
        __root: 'page.mustache',
        _content: '<p>page1</p>',
        title: this.title,
      }, opts)
      const page2 = output({
        __root: 'page.mustache',
        _content: '<p>page2</p>',
        title: this.title,
      }, opts)
      return page1 + page2
    }
  }
}
mustache-cli -p --color ./

./out/index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>Home</title>
  </head>
  <body>
    <div>
      <h1>Home</h1>
      <strong>Hello World</strong>
    </div>
  </body>
</html>

./out/multi/index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>Multi</title>
  </head>
  <body>
    <div>
      <h1>Multi</h1>
      <p>page1</p>
      <h1>Multi</h1>
      <p>page2</p>
    </div>
  </body>
</html>

Node

import express from 'express'
import {renderFile} from 'mustache-cli/lib/express'

const app = express()

app.set('views', 'src/mustache/tpl')
app.set('view engine', 'mustache')
app.engine('mustache', renderFile({
  baseDir: 'src/mustache',
}))

app.use((req, res) => {
  res.render('layout', {
    title: 'Home',
  })
})

app.listen(3000)

API

output(config[, options])

options:

  • baseDir

    (Default: .)

    Set the root dir for mustache.

  • confDir

    (Default: ./conf)

    Set the config dir, include js or json files.

  • tplDir

    (Default: ./tpl)

    Set the template dir, include mustache or html files.

  • outDir

    (Default: ./out)

    Set the output dir.

  • rootTpl

    (Default: __root)

    Set the key of a main template file path.

  • outFile

    (Default: __file, Since: 2.2.0+)

    Set the key of a output file path.

  • partialPrefix

    (Default: _)

    Set the prefix, represent a partial.

    // HTML
    <div>{{>nav}}</div>
    
    // JSON
    {
      _nav: '<nav>...</nav>',
      ...
    }
  • tplPrefix

    (Default: __)

    Set the prefix, represent a template file path for a partial.

    // HTML
    <div>{{>form}}</div>
    
    // JSON
    {
      __form: 'form.mustache',
      ...
    }
  • forceMinify

    (Default: __minify, Since: 2.3.0+)

    Set the key of minifier, The possible value is true or false, for config file.

  • forcePretty

    (Default: __pretty, Since: 2.3.0+)

    Set the key of pretty, The possible value is true or false, for config file.

  • ext

    (Default: html)

    Set the extname of output files.

  • render

    (Default: mustache.render)

    Set render function.

  • print

    Set log output function.

  • onError

    The callback is called when an error occurs.

  • color

    (Default: false)

    Print color text.

  • minify

    (Default: false)

    To minify HTML.

  • pretty

    (Default: false)

    To pretty HTML.

  • watch

    (Default: false)

    To watch working files.

  • ~~config~~

    (Deprecated)

setGlobalData(data)

Set default data.

getGlobalData()

Get default data.

License

MIT