Is generator-nm still being maintained or updated?

No, generator-nm is deprecated as per the README, with the author recommending a different boilerplate. It's no longer actively maintained, so avoid it for new projects.

How do I use generator-nm to set up a Node.js module with a CLI?

Install Yeoman and generator-nm globally, then run 'yo nm --cli' to scaffold the project. However, due to deprecation, consider using the linked boilerplate or alternatives like create-node-app instead.

What are the main alternatives to generator-nm for Node.js scaffolding?

Alternatives include the recommended node-module-boilerplate, create-node-app, or using npm init with custom templates. These offer more up-to-date and maintained solutions without Yeoman.

Can generator-nm handle TypeScript or other languages beyond JavaScript?

No, generator-nm is designed for standard Node.js modules and doesn't support TypeScript out-of-the-box. You would need to manually modify the generated setup, which is cumbersome.

How does generator-nm compare to tools like yeoman-generator or plop?

generator-nm is specific to Node.js modules and uses Yeoman, but it's deprecated. Tools like plop offer more flexibility for various project types and are actively maintained.

Why was generator-nm deprecated in favor of a boilerplate?

The author likely shifted to a simpler boilerplate approach to reduce maintenance overhead and provide a more direct, copy-paste solution, as Yeoman generators can become complex to update.

Open-Awesome

generator-nm

MITJavaScriptv7.0.0

A Yeoman generator to scaffold out Node.js modules with optional CLI and testing setup.

GitHub

736 stars82 forks0 contributors

What is generator-nm?

generator-nm is a Yeoman generator that automates the creation of Node.js module boilerplates. It sets up a standardized project structure with essential files, testing, and optional CLI integration, streamlining the initial setup for new modules.

Target Audience

Node.js developers and open-source maintainers who frequently create new npm packages and want a consistent, best-practice starting point.

Value Proposition

It saves time by automating repetitive setup tasks and enforces a proven structure used by the author for many successful modules, ensuring quality and consistency from the start.

Overview

Scaffold out a node module

Use Cases

Best For

Quickly bootstrapping new Node.js modules with a standardized structure
Adding a command-line interface to a Node.js package
Setting up testing with AVA and coverage reporting
Creating modules intended for publication under a GitHub organization
Following best practices for npm package development
Reducing boilerplate code and configuration time for new projects

Not Ideal For

Projects requiring active maintenance and future updates, as generator-nm is deprecated
Developers who prefer modern scaffolding tools without Yeoman dependencies
Teams with custom project structures that don't align with its opinionated conventions
New Node.js module creators seeking up-to-date documentation and community support

Pros & Cons

Pros

Standardized Best Practices

Based on the author's successful modules, it enforces a proven structure with essential files like package.json and testing setup, saving setup time and ensuring consistency.

Integrated Testing Workflow

Includes AVA for testing and optional nyc for coverage, with Codecov integration, streamlining the initial configuration for robust development.

Flexible CLI and Org Options

Offers command-line flags to add a CLI and configure publishing under GitHub organizations, catering to common open-source needs without manual tweaking.

Cons

Deprecated and Unmaintained

The README explicitly states it's deprecated and points to a boilerplate, meaning no bug fixes, security updates, or new features, making it risky for adoption.

Yeoman Dependency Overhead

Requires installing and using Yeoman, which adds complexity and may be less efficient compared to lighter tools like npx or native npm init scripts.

Limited Customization Scope

Its opinionated structure follows specific conventions, which can be restrictive for projects with unique requirements or teams preferring different configurations.

Frequently Asked Questions

Related Projects

husky

Git hooks made easy 🐶 woof!

Stars35,225

Forks1,094

Last commit4 months ago

cheerio

The fast, flexible, and elegant library for parsing and manipulating HTML and XML.

Stars30,426

Forks1,704

Last commit20 hours ago

jsdom

A JavaScript implementation of various web standards, for use with Node.js

Stars21,616

Forks1,786

Last commit4 days ago

dotenv

Loads environment variables from .env for nodejs projects.

Stars20,500

Forks953

Last commit2 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub