https://github.com/zanuka/originator

:seedling: starter template for a new node module
https://github.com/zanuka/originator

es6-modules eslint javascript node-module sauce-labs starter tap-spec tape travis-ci zuul

Last synced: 2 months ago
JSON representation

:seedling: starter template for a new node module

• Host: GitHub
• URL: https://github.com/zanuka/originator
• Owner: zanuka
• License: mit
• Created: 2015-08-31T17:16:28.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T15:59:00.000Z (4 months ago)
• Last Synced: 2024-07-25T19:27:05.755Z (3 months ago)
• Topics: es6-modules, eslint, javascript, node-module, sauce-labs, starter, tap-spec, tape, travis-ci, zuul
• Language: JavaScript
• Homepage:
• Size: 877 KB
• Stars: 12
• Watchers: 2
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# originator

[![Known Vulnerabilities](https://snyk.io/test/github/mdelucchi/originator/badge.svg?targetFile=package.json)](https://snyk.io/test/github/mdelucchi/originator?targetFile=package.json)

![](./img/originator.png)

## [deprecated]

at this point this thing is ancient history, not recommended for modern use ;-)

## intent

This is currently intended to be cloned as a starter template for a new node module. It was created to serve as a utility/backup for my module template experiments and is a bit outdated now.

## usage

`git clone https://github.com/mdelucchi/originator.git your-module-name`

## npm scripts

`watch` - starts file watcher

`lint` - runs eslint on `/src`

`test` - runs tests and formats piped TAP output with [tap-spec](https://github.com/scottcorgan/tap-spec).

`ci` - Travis CI integration + zuul multi-framework & browser tests

`cover` - generates code coverage text-summary report in terminal

`report` - generates code coverage html report and opens it in browser

`coveralls` - runs code coverage and sends report to coveralls

`zuul` - runs browser tests via zuul at `http://localhost:9966/__zuul`

## devDependencies:

- [**babel**](https://github.com/babel/babel) - compiler for writing next generation JavaScript

- [**babel-eslint**](https://github.com/babel/babel-eslint) - ESLint using Babel as the parser

- [**babel-istanbul**](https://github.com/ambitioninc/babel-istanbul) - excellent coverage tool

- [**babelify**](https://github.com/babel/babelify) - Browserify transform for Babel. Used in multi-framework testing with zuul.

- [**blue-tape**](https://github.com/spion/blue-tape) - substack's tape test runner with promise support

- [**coveralls**](https://github.com/nickmerwin/node-coveralls) - test coverage and history statistics support for node.js

- [**eslint**](https://github.com/eslint/eslint) - A fully pluggable tool for identifying and reporting on patterns in JavaScript.

- [**eslint-config-xo**](https://github.com/sindresorhus/eslint-config-xo) - ESLint shareable config for XO

- [**eslint-plugin-babel**](https://github.com/babel/eslint-plugin-babel) - an eslint rule plugin companion to babel-eslint

- [**nsp**](https://github.com/nodesecurity/nsp) - check for vulnerabilities

- [**rimraf**](https://github.com/isaacs/rimraf) - remove stuff

- [**tap-spec**](https://github.com/scottcorgan/tap-spec) - formatted TAP output

- [**zuul**](https://github.com/defunctzombie/zuul) - multi-framework javascript browser testing

## Travis CI / Sauce Connect Configuration

[**Sauce Connect**](https://docs.saucelabs.com/reference/sauce-connect/) -  Used to create tunnel allowing [Travis CI](https://travis-ci.org/) to utilize [Sauce Labs](https://saucelabs.com), a browser and mobile testing platform.

If you plan to use Sauce Connect in your new module, be sure to [sign up](https://saucelabs.com/signup) with Sauce Labs if you haven’t already (it’s free for Open Source projects), and get your access key from your account page.

Then you'll want to replace the secured access key in `.travis.yml` with your own. See the [Getting Started](https://docs.saucelabs.com/ci-integrations/travis-ci/) guide on Travis for more info on setting this up.

Best bet if you're a new Travis and/or Sauce Labs user is to follow their steps to create a new `.travis.yml` file.

## Publishing

When you are ready to publish a new version of your module, the following steps can be used:

  1. add and commit your changes via git

  2. `npm version patch -m "Ugrade message..."`

  3. `npm publish`

If publish is a success, the `postpublish` npm script will run `git push origin master --follow-tags`, pushing up and tagging your code properly.

If you run `npm version patch` before committing your changes, you'll get a message like `npm ERR! Git working directory not clean.`. Commit and retry.