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

nodejs-module-generator

v1.1.0

Published

A CLI tool to generate a Node.js project structure with dynamic modules.

Downloads

52

Readme

Node.js Module Generator

nodejs-module-generator is a CLI tool designed to dynamically generate module structures for Node.js projects using Sequelize ORM. Create boilerplate code with a simple command.

Installation

To install the package globally, run:

npm install -g nodejs-module-generator

Initialize Sequelize

Initialize Sequelize with default configuration in the src/sequelize directory:

npx nmg init

This command installs Sequelize, sets up the necessary configuration files, and creates the required directories (models, migrations, seeders, config) inside src/sequelize.

Generate a Module

Generate a new module with controllers, services, models, and interfaces:

npx nmg generate:module <modulename>

This command creates a module with the following structure:

src
  modules
    <modulename>
      controllers
        create.controller.js
        update.controller.js
        get.controller.js
      services
        create.service.js
        update.service.js
        get.service.js
      models
        <modulename>.model.js
      interfaces
        <modulename>.interface.js

Generate a Sequelize Model

Generate a new Sequelize model in the specified module. Hyphenated names will be converted to camelCase:

npx nmg model <moduleName>:<modelName> --attributes <attributes>

Options

  • moduleName: The name of the module where the model should be created.
  • modelName: The name of the model. Hyphens will be converted to camelCase.
  • --attributes: A comma-separated list of attributes and their types. For example: username:string,email:string,age:integer.

Example

To generate a model named admin-users in the admin module with attributes username, email, and age, run:

npx nmg model admin:admin-users --attributes username:string,email:string,age:integer

This command will:

  • Create adminUsers.model.js in the src/modules/admin/models directory.
  • Define the model with attributes username, email, and age.
  • Add the model reference to the src/sequelize/models/index.js file.

Configuration

The generator creates a basic structure which you can further customize according to your project's needs.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License.

License

Created by Pritey Mehta.

Acknowledgments

Inspired by Sequelize ORM for Node.js.