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

simple-file-templater

v1.0.5

Published

Simple templating system for file. Pattern replacer, file name replacer...

Downloads

232

Readme

TEMPLATER

Simply replace patterns in files or copy folder and change file names.

Documentation

/**
 * @param {String} from absolute url of template (it can be a folder)
 * @param {String} to absolute url of folder/file to be copied (it can be a folder)
 * @param {Object|Array} replaceInFiles list of variables to interpolates
 * * {myVar : myReplacement}
 * * OR [[/myRegExp/g, 'myString'], ['myString1', 'myString2']...]
 * * DON'T forget the g flag when using regexps
 * @param {Object|Array} replaceInFileNames same as above but for fileNames (only valid when copying folders)
 * @param {RegExp[]} ignorePaths regexp array to check against path. Eg: /node_module/ <= file paths that includes the word node_module will not be taken in account
 * @return {Array} createdPaths
 */
function templater(from, to, replaceInFiles = [], replaceInFileNames = [], ignorePaths = []) {
    //
}

Example code:


const templater = require('../templater/templater');
const path = require('path');

const moduleName = 'cosmic-module'

// COPY AND REPLACE PATTERN IN A SINGLE FILE
templater.templater(
    path.resolve(__dirname, './my/template/file.js'), // from
    Path.resolve(__dirname, './my/output/renamed-file.js'), // to
    {
        'myModule': moduleName, // will replace all "myModule" string in the file with 'cosmic-module'
        'replace-this': 'by-that',
    },
);

// COPY AND REPLACE PATTERN IN A WHOLE FOLDER
templater.templater(
    path.resolve(__dirname, './my/template/module/'), // shall be a folder
    Path.resolve(__dirname, './my/output/new-module/'), // 
    [
        [/my-module/g, moduleName], // same as above but with a differnet syntax
    ],
    [
        'my-custom-file', 'cosmic-module-file' // will replace "my-custom-file" string in file name by the "cosmic-module-file" string
    ]
);

FEEDBACK

Don't hesitate to write an issue for any request or make a pull request :)