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

project-templater

v1.0.2

Published

A Node module for templating projects

Downloads

2

Readme

project-templater

This is a simple Node module for creating a new project from a template directory, and supports replacing placeholders in files with custom values.

Installation

yarn add project-templater

Usage

To use project-templater, it's as simple as the following code:

// Load module
var templater = require('templater');

// Copy from the template folder to a new folder
templater.copy('../template-project', './new-project', {
    // This is the context object. Placeholders in the format
    // of `$((key))` will be replaced with the appropriate
    // value from this object.
    name: 'MyProject',
    someKey: 'a value'
}, (file) => file.endsWith('.js'));

Documentation

copy(template, destination, context, filter?)

  • template: string
    The path to the template project directory.
  • destination: string
    The path of the destination project directory. If this folder does not exist, it will be created.
  • context: Object
    The context object to be used for key-value replacement.
  • filter?: (filename: string) => boolean
    An optional filter to control which files are copied over from the template. If this filter-callback returns false on a file, that file will not be copied. All file names passed to this callback are relative to the template folder.

Templating examples

<template>/myFile.txt:

This is my file about $((projectName)). Description: $((description)).

context object:

{
    projectName: 'My Project',
    description: 'A fancy templated project'
}

<destination>/myFile.txt:

This is my file about My Project. Description: A fancy templated project.