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

grunt-jade-i18n

v0.4.0

Published

Compile Jade templates via Grunt with internalization support

Downloads

7

Readme

grunt-jade-i18n Build Status Downloads

Compile Jade templates with internationalization support based on JS/JSON/YAML files using Grunt

Getting started

This plugin is exactly the same like grunt-contrib-jade, but it adds high level support for Jade template internationalization based on JSON/YAML/JS files

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

$ npm install grunt-jade-i18n --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile:

grunt.loadNpmTasks('grunt-jade-i18n')

This plugin requires Grunt ~0.4.0

The "jade" task

Run this task with the grunt jade command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide

This plugin provides a localization mechanism for Jade templates. Since localization is done once during the build process, there is no performance hit on the application, opposed to dynamic translation on the client side

Usage example

Gruntfile configuration
grunt.initConfig({
  jade: {
    templates: {
      options: {
        // jade i18n specific options
        i18n: {
          locales: 'locales/*.json',
          namespace: '$i18n'
        },
        // Jade specific options
        pretty: true
      },
      files: {
        "path/to/dest.html": ["path/to/templates/*.jade", "another/path/tmpl.jade"]
      }
    }
  }
})

See Gruntfile for more configuration examples

Example JSON locale file (es_ES.json)
{
  "hello": {
    "world": "Hola Mundo"
  }
}
Example Jade template
body
  h1 #{$i18n.hello.world}!
  p Using locale #{$localeName}

Options

Only jade-i18n specific options are listed below

To see all the available options available, please see grunt-contrib-jade

locales

Type: string|array

Path to localization files. Please check the examples in tests. Glob patterns can be used

JSON, YAML and JS formats are supported for the translation templates

namespace

Type: string Default: $i18n

Namespace to expose translation keys in Jade template

localeExtension

Type: boolean Default: false

Generate the HTML output files with the extension prefix with the current language. By default it will create different folders for each language

Setting this option into true, the generated HTML files will look like this:

html/
├── view.en-en.html
└── view.es-es.html

... instead of:

html/
├── en-EN/
│   └── view.html
└── es-ES/
    └── view.html

See test for more examples

Contributing

Instead of a formal styleguide, take care to maintain the existing coding style.

Add unit tests for any new or changed functionality

Development

Clone the repository

$ git clone https://github.com/adesisnetlife/grunt-jade-i18n.git && cd grunt-jade-i18n

Install dependencies

$ npm install

Run tests

$ npm test

Release History

  • 0.3.4 2015.02.18
    • Fix error in multiple running tasks (#22, #23)
  • 0.3.3 2015.02.08
    • Maintance release
  • 0.3.2 2015.01.02
    • Bump grunt-contrib-jade version
  • 0.3.1 2014.12.03
    • Fix #18
  • 0.3.0 2014.09.16
    • Uninstall grunt-newer
    • Adds compatibility with external tasks like grunt-newer
  • 0.2.1 2014.08.04
    • Fix #14
  • 0.2.0 2014.06.26
    • Installs and uses grunt-newer
  • 0.1.7 2014.04.22
    • Replace caret (^) with tilde (~) for grunt-contrib-jade version
  • 0.1.5 2013.01.07
    • Fix #4
  • 0.1.4 2013.01.03
    • Upgrade grunt-contrib-jade task dependency to 0.9.0
  • 0.1.3 2013.12.19
    • Fix #2
    • Fix #3
  • 0.1.2 2013.12.11
    • Fix locale bad formed name
  • 0.1.1 2013.12.10
    • Minor refactor
    • Improvements: avoid possible configuration issues with output file extensions
  • 0.1.0 2013.12.09
    • Initial release

Contribute

Did you miss something? Open an issue or make a PR!

Contributors

License

Copyright (c) Adesis Netlife S.L

Released under MIT license