https://github.com/herrmannplatz/npm-module-init

npm module scaffolding
https://github.com/herrmannplatz/npm-module-init

commitizen jest npm scaffolding semantic-release standard

Last synced: 14 days ago
JSON representation

npm module scaffolding

• Host: GitHub
• URL: https://github.com/herrmannplatz/npm-module-init
• Owner: herrmannplatz
• License: mit
• Created: 2017-11-11T20:52:09.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-10-12T22:33:12.000Z (over 6 years ago)
• Last Synced: 2024-12-11T16:51:08.699Z (about 1 month ago)
• Topics: commitizen, jest, npm, scaffolding, semantic-release, standard
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/npm-module-init
• Size: 141 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# npm-module-init

[![npm version](https://badge.fury.io/js/npm-module-init.svg)](https://badge.fury.io/js/npm-module-init) [![Build Status](https://travis-ci.org/herrmannplatz/npm-module-init.svg?branch=master)](https://travis-ci.org/herrmannplatz/npm-module-init)

Opinionated npm module scaffolding using jest, standard, commitizen and semantic-release.

## Getting started

```

// use as a global dependency

$ npm install npm-module-init -g

$ npm-module-init my-npm-module

// or use without installing

$ npx npm-module-init my-npm-module

```

## Project Structure

This will generate the following project structure.

```

|-- my-npm-module

  |-- .editorconfig

  |-- .gitignore

  |-- .travis.yml

  |-- index.js

  |-- index.test.js

  |-- LICENCE.md

  |-- package.json

  |-- README.md

```

## Usage

Commit your changes.

```

npm run commit

```

Run tests.

```

npm t

```

## Publish a release

Creating a release version and publishing it to the npm registry is handled by `semantic-release`. This is then triggered when travis build was successful. So ensure that travis is able to publish to npm.