Skip to content
👧 Lass scaffolds a modern package boilerplate for Node.js
Branch: master
Clone or download
Latest commit 2f40de7 Jun 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
media feat: added npm downloads total badge if public Oct 5, 2018
template fix: added helpers glob per ava@2.x Jun 10, 2019
test fix: fixed travis badge Mar 5, 2019
.editorconfig Initial commit Sep 2, 2017
.gitattributes Initial commit Sep 2, 2017
.gitignore Initial commit Sep 2, 2017
.nojekyll Moved docs to root to avoid symbolic link GH page issue Sep 3, 2017
.npmignore fix: added more files to npm ignore Sep 30, 2018
.npmrc Initial commit Sep 2, 2017
.remarkignore
.travis.yml feat: added commitlint/fixpack/npm-check-updates, added post test Sep 30, 2018
CNAME Revert "Delete CNAME" Sep 4, 2017
LICENSE Fixed typo, Removed old files Sep 4, 2017
README.md docs: fixed whitespace Jan 7, 2019
cli.js fix: fixed CLI due to wildcard issue with cac Jan 9, 2019
config.js Added docute-emojify Aug 1, 2018
favicon.ico Moved docs to root to avoid symbolic link GH page issue Sep 3, 2017
index.html docs: fixed docute-emojify Jan 8, 2019
package.json v1.0.18 Jun 10, 2019
sao.js fix: fix per SBoudrias/Inquirer.js#765 Jan 17, 2019
yarn.lock fix: fixed yarn.lock Jan 9, 2019

README.md

Lass

chat build status code coverage code style styled with prettier license npm downloads

Lass scaffolds a modern package boilerplate for Node.js
A lass that fell in love with a lad • Built by @niftylettuce and contributors

❤️ Love this project? Support @niftylettuce's FOSS on Patreon or PayPal 🦄

Table of Contents

Features

  • Unit testing with ava
  • Commit linting with commitlint
  • Linting with eslint (with an option to choose between prettier and xo or standard)
  • Markdown Linting with remark
  • Automatic code formatting with prettier
  • Automatic git init
  • Automatic npm install (or yarn install if selected)
  • Automatic builds, tests, and code coverage uploading to Codecov with Travis-CI
  • Includes git/editor configurations:
  • Automatic markdown formatting and linting with remark
  • Highly configurable and remembers your defaults with sao
  • Test coverage with nyc
  • Automatically generated files with tailored defaults
    • Readme with badges through Shields.io
    • Choose from (343) different licenses with spdx-license-list (defaults to your npm default or MIT)
    • Automatically inserts license year/name/email/website for MIT license if selected

Requirements

Node.js v7.6.0+

Install

npm:

npm install -g lass

yarn:

yarn global add lass

Usage

Create a package

lass new-package
cd new-package

Test it

npm:

npm test

yarn:

yarn test

Tips

Configuration

You should configure npm init defaults before using this package.

Run the following commands and replace the values below with your own:

npm config set init-author-email "niftylettuce@gmail.com"
npm config set init-author-name "Nick Baugh"
npm config set init-author-url "http://niftylettuce.com"
npm config set init-license "MIT"
npm config set init-version "0.0.0"

These defaults get utilized by lass when scaffolding a package and npm init in general.

To check your existing configuration, run npm config list -l.

Version Bump and Release

We highly recommend to use the tools np and release to version bump and release your package to GitHub and NPM.

Related

Contributors

Name Website
Nick Baugh http://niftylettuce.com
Pablo Varela http://pablo.life
Shaun Warman http://shaunwarman.com

Trademark Notice

Lass, Lad, Cabin, Lipo, and their respective logos are trademarks of Niftylettuce LLC. These trademarks may not be reproduced, distributed, transmitted, or otherwise used, except with the prior written permission of Niftylettuce LLC. If you are seeking permission to use these trademarks, then please contact us.

License

MIT © Nick Baugh

#

You can’t perform that action at this time.