Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

CharlesStover/node-package-template

Repository files navigation

Node package

version minzipped size downloads GitHub Action: Push

Description

Install

  • npm install package-name or
  • yarn add package-name

Use

import packageName from 'package-name';

packageName();

API

API

Contributing

To contribute to this repository, start by running the following commands.

  • To keep Yarn up to date, run yarn set version latest.
  • To keep dependencies up to date, run yarn up "*" "@*/*".
  • If you use VIM, run yarn sdks vim.
  • If you use Visual Studio Code, run yarn sdks vscode.

To test your changes for validity, use the following scripts:

  • To build your changes, run yarn rollup.
  • To build your changes in watch mode, run yarn rollup:watch.
  • To lint your changes, run yarn eslint.
  • To unit test your changes, run yarn jest.
  • To unit test your changes in watch mode, run yarn jest:watch.

About

A GitHub repository template for Node modules.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published