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

scaffander

v1.1.0

Published

Code generator library with support for structure templates

Downloads

56

Readme

scaffander

Code generator with support for structure templates

Example template for scaffander-cli can be found here: https://github.com/ikatun/scaffander-example

Example of a code generator (from examples/ directory)

.
├── index.js
├── templates
|   └── test-template
|     ├── template-init.js
|     └── {{directoryName}}
|       └── {{myFileName}}.js

{{myFileName}}.js

export class {{className}} {
     constructor() {
       console.log('Thank you very much for constructing me!');
     }
   }
   
   export default {{className}};

template-init.js

// don't worry, this file will not be part of the generated code :)

// called before template is parsed
// variables added to context here can be used within the template
exports.before = (context) => {
  context.directoryName = 'MyTestDirectory';
};

// called after template is parsed
// postRunActions can be added to the postRunActions array
// these are executed after user accepts the new diff
exports.after = (context) => {
  context.postRunActions.push(() => console.log("I'm all done, thanks for waiting!"));
  //you can also call scaffander() function here if you want to generate a template within another template 
};

index.js

const path = require('path');
const scaffander = require('scaffander').default;
// or better yet: import scaffander from 'scaffander';

const argv = process.argv;
if (argv.length !== 4) {
  console.log('usage: node index.js <templateName> <destinationPath>');
  process.exit(-1);
}
const templateName = argv[2];
const destinationPath = argv[3];

const context = { myFileName: 'index', className: 'MyBeautifulClass' };
const templatePath = path.join(__dirname, 'templates', templateName);
scaffander(templatePath, destinationPath, context, { msg: 'Do you want to apply these changes?' });

running the example (from the examples/scaffander-test directory)

npm install
node index.js test-template generated-template
# generated-template directory is created