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

view-locals

v1.0.2

Published

Sets up the default locals to use with the render function of express

Downloads

4

Readme

view-locals

An express middleware which sets default local variables to pass into the view engine for use.

Feel free to comment/tear apart my code and let me know how to improve it.

Example Use

First you must have a .locals file in the root of your project (where package.json) which contains all the defaults you wish to use.

const express = require("express");
const app = express();
const viewLocals = require("view-locals");

... Other code here ...

app.use(viewLocals());

app.get("/", (req, res, next) => {
  res.render("index");
});

... Other code here ...

app.listen(1337);

Now in your index.jade or index.ejs file you will have access to a bunch of default local variables (based on your .locals file) such as:

  • Title
  • Description
  • Keywords
  • Stylesheets array
  • Scripts array
  • ...

##Sending arguments A filepath and/or options object can also be sent into the view-locals middleware:

  • Path and options:
app.use(viewLocals("path/to/config.json", {encoding: "utf-8", reference: "+"});
  • Just path:
app.use(viewLocals("path/to/config.anything"));
  • Just options:
app.use(viewLocals({encoding: "utf-8", reference: "+"});

##Options There are a few options that can be sent in to the viewLocals module:

  • encoding: The file encoding to use, defaults to "utf-8".
  • filepath: The path to the configuration json file, defaults to the file ".locals" in the root of the project.
  • reference: The reference symbol to use when referencing other properties, defaults to "~". The default value for "ogTitle" below will be the value of "title".
{
  "title": "Default title",
  "ogTitle": "~title"
}

.locals file

The json formatted default locals that will be applied.

{
  //The defaults to use.
  "defaults": {
    //Global meta information.
    "title": "View Locals",
    "language": "en",
    "charset": "utf-8",
    "viewport": "width=device-width,initial-scale=1.0",
    "description": "An example .locals file to use with your express project.",
    "ogTitle": "~title",
    "keywords": [
      "Example",
      "keywords",
      "express",
      "locals"
    ],
    "robots": [
      "noindex",
      "nofollow"
    ],
    "alternateUrls": {
      "fr": "http://www.alternative-french-url.com",
      "br": "http://www.alternative-brazilian-url.com"
    },

    //Static files.
    "stylesheets": [
      "stylesheet1.css"
    ],
    "scripts": [
      "/path/to/js/file.js"
    ]
  }
}