Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

generator-libstart

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

generator-libstart

Yeoman generator to start your UMD library.

  • 0.1.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

LibStart

Yeoman generator to start your UMD library.

npm version Build Status Join the chat at https://gitter.im/yoannmoinet/generator-libstart


Getting Started

If you'd like to get to know Yeoman better check out the complete Getting Started Guide.


Overview

This generator will create a basic scaffolding of a generic UMD library.

It will come with :


Install

To install generator-libstart from npm, run:

npm install -g yo generator-libstart

Finally, initiate the generator:

yo libstart

Usage

To generate your new library simply run :

yo libstart <name of your creation>

Answer to some questions and you're good to go.

You'll be able to reserve your library's name into npm's registry if you whish to.

In your new library, you'll have some scripts available to automate your development.

Npm Scripts
npm preversion (auto)

It runs npm build.

npm postversion (auto)

It runs bowerSync and changelog.

npm pretest (auto)

It runs build.

npm test (manual)

It launches tests with mocha.

npm postest (auto)

It runs format and lint.

Custom Scripts

They are all run by the previous npm scripts but you can run them at your convenience.

npm run prebuild (manual)

It runs format and lint.

npm run build (manual)

It runs umd and uglify.

npm run format

Test the formatting with JSCS

npm run lint

Lint with ESLint

npm run umd

It packages your library with umd

npm run changelog

Generate a changelog for your library based on your commits if you've followed one of the supported convention, and will commit the changes automatically.

npm run bowerSync

It synchronizes bower.json's version with package.json's, and will commit the changes automatically.

npm run uglify

It uglifies your library.


Structure

library
├ .eslintrc           // Basic ESLint config
├ .editorconfig       // Basic Editor config
├ .jscsrc             // Basic JSCS configREADME.mdLICENSE
├ package.json
├ bower.json
│
└─── bin               // Helpers for npm scripts
|    ├ changelog.js    // Is run with 'npm run changelog'
|    └ bowerSync.js    // Is run with 'npm postversion'
|
└─── src
|    └ lib.js          // Main file
|
└─── test
     └ lib.spec.js     // Mocha tests

License

MIT

Keywords

FAQs

Package last updated on 20 Sep 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc