diegohazdiegohaz
356

Nod

screenshot of Nod

Node.js module generator/boilerplate with Babel, Jest, Flow, Documentation and more

GithubDemo

Overview

The nod NPM module is a generator/boilerplate for creating NodeJS modules. It provides a set of features and tools to enhance the development process, including Babel for writing next generation JavaScript, Jest for testing, ESLint for code quality, Travis CI for automated testing and linting, and more.

Features

  • Babel: Write next generation JavaScript today.
  • Jest: JavaScript testing framework used by Facebook.
  • ESLint: Make sure you are writing quality code.
  • Prettier: Enforces consistent code style.
  • Flow: A static type checker for JavaScript used by Facebook.
  • Travis CI: Automate tests and linting for every push or pull request.
  • Documentation: A documentation system for writing documentation.
  • Standard Version: Automate versioning and CHANGELOG generation.

Using Yeoman Generator

  1. Install Yeoman globally: npm install -g yo
  2. Install the nod generator: npm install -g generator-nod
  3. Run the generator: yo nod
  4. Follow the prompts to set up your module.

Downloading/Cloning the Repository

  1. Download or clone the repository from the nod GitHub page.
  2. Edit the package.json, README.md, and LICENSE files with your module's information.

Commands

  • Publish: Automatically runs tests, linting, documentation generation, build, generates CHANGELOG.md, and pushes commits and tags to the remote repository.

Removing Stuff

  1. Remove the .flowconfig file.
  2. Remove flow from package.json.
  3. Remove flow from .babelrc.
  4. Remove flow from .eslintrc.
  5. Run yarn.

Adding Stuff

  1. Install dependencies.
  2. Update package.json.
  3. Create tsconfig.json.
  4. Update .babelrc.
  5. Update .eslintrc with the provided settings.

Summary

The nod module is a powerful tool for generating and developing NodeJS modules. It offers a range of features and tools to enhance the development process, including support for next generation JavaScript, testing, code quality, documentation, versioning, and more. Whether you choose to use the Yeoman Generator or download/clonethe repository, nod provides an easy and efficient way to build NodeJS modules.

documentation
Documentation

Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.