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

create-template-folder

v2.3.1

Published

Template Directory Writer

Downloads

48

Readme

create-template-folder

Instalation

npm install create-template-folder
# OR
yarn add create-template-folder
# OR
pnpm add create-template-folder

Usage

const { createTemplateFolder } = require("create-template-folder")
const path = require("path")

async function main() {
   try {
      const files = await createTemplateFolder({
         inDir: path.join(__dirname, "template"),
         outDir: path.join(__dirname, "..", "outFolder"),
         vars: {
            hello: "world"
         }
      })
      files.forEach(file => {
         console.log(`Just created ${file}`)
      })
   } catch (err) {
      console.log(err)
   }
}

main()

Typescript support

import { createTemplateFolder } from 'create-template-folder'
import * as path from 'path'

async function main() {
   try {
      const files = await createTemplateFolder({
         inDir: path.join(__dirname, "template"),
         outDir: path.join(__dirname, "..", "outFolder"),
         vars: {
            hello: "world"
         }
      })
      files.forEach(file => {
         console.log(`Just created ${file}`)
      })
   } catch (err) {
      console.log(err)
   }
}

main()

Interfacing with api

copyTemplate(ICreateTemplate)

interface ICreateTemplate {
  inDir: string;
  outDir: string;
  vars: Record<string, string>; // defaults to {}
  number?: number; // defaults to 2
}

inDir: Folder you are trying to copy

ouDir: Path to where the new folder should be copied to

vars: List of variables that the package should be looking into in order to override with your custom values

number: Number of "curly braces" the package should look into: {{hello}} vs {{{hello}}} for example

createTemplateFolder(inDir, outDir, vars, number)

createTemplateFolder(inDir: string, outDir: string, vars?: Record<string, string>,  number?: number) {}

Same api structure as before, just without sending an object and passing positional arguments