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

anygen

v0.0.3

Published

!!!Automatic Scaffolding Generator For Any Project!!!

Downloads

3

Readme

Travis npm David Github All Releases npm

You declare some directories to use as blueprints and then new modules are automatically generated based on those blueprints.

Install

Install globally to use the CLI.

npm install -g  anygen

Install locally to use programtically.

npm install --save  anygen

Configuration

Anygen requires you to set the path of your blueprints and the path where you want to generate you new modules.
In your package.json add the object anygen and set both paths. You can override this values using the cli options -b for blueprints_root and -m for modules_root.

//file: package.json
{
	"anygen": {
		"blueprints_root": "./path/to/your/blueprints/",
		"modules_root": "./src/modules"
	}
}

Examples

CLI
ganerate a new module:

anygen generate blueprint_name new_module_name

list all Blueprints:

anygen list

Javascript

var anygen = require('anygen');
var builder = anygen.Builder;

var modules_root = ".src/modules/";
var blueprints_root = "./path/to/your/blueprints/";
var blueprint_name = "ng-component";//this must be a direct subfolder of blueprints_root path (an existing blueprint).
var new_module_name = "MyNewModule";
var builder = new Builder();

builder.addBlueprints(blueprints_root);
var files = builder.build(blueprint_name, new_module_name, modules_root);

console.log("Generated files:");
files.forEach(function (item) {
   console.log("   " + item);
});

API

For detailed info please check the API documentation generated using typedoc

Builder.addBlueprints(blueprints_root)

  • blueprints_root: root path to the Blueprint generators, each subdirectory of the root_path is a Blueprint

Builder.build(blueprint_name, new_module_name, modules_root)

  • blueprint_name: Name od the Blueprint to be used (a direct subdirectory of blueprints_oot)
  • new_module_name: the name of the new module that is generated
  • modules_root: path where the new module will be generated, new module path = modules_root + new_module_name

Creating Your Blueprints

A blueprint is any direct ">" subdirectory of your blueprints_root directory.

path/to/your/blueprints_root
  +──  blueprint1
  |   └──  __name__
  |       +── __name__Controller.js
  |       +── __name__Controller.js
  |       └── __name__Template.html
  └──  blueprint2
      └──  __name__
          +── __name__Controller.js
          +── __name__Controller.js
          └── __name__Template.html

The __name__ string:
Any __name__ string in a directory or file name will be replaced by the new_module_name when the build process is executed.
Any __name__ string withing the content of the Blueprint files also will be replaced by the new_module_name.

Examples of the Blueprints can be found withing the repo: tools/blueprints/.

  • single-dir blueprint: shows how to create a blueprint with all the files in a single directory with the name of the module
  • multiple-dir blueprint: show how to create a module where the files are split within multiple directories. in this case the modules_root parameter should be the common root af all the split directories and blueprint should replicate the subdirectory structure of this common root.

License

MIT @ Ma Jerez