Awesome
<h1 align="center"> <a href="https://lass.js.org"><img src="https://cdn.rawgit.com/lassjs/lass/e39cd571/media/lass.png" alt="Lass" /></a> </h1> <div align="center"> <a href="https://join.slack.com/t/ladjs/shared_invite/zt-fqei6z11-Bq2trhwHQxVc5x~ifiZG0g"><img src="https://img.shields.io/badge/chat-join%20slack-brightgreen" alt="chat" /></a> <a href="https://travis-ci.com/lassjs/lass"><img src="https://travis-ci.com/lassjs/lass.svg?branch=master" alt="build status" /></a> <a href="https://codecov.io/github/lassjs/lass"><img src="https://img.shields.io/codecov/c/github/lassjs/lass/master.svg" alt="code coverage" /></a> <a href="https://github.com/sindresorhus/xo"><img src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg" alt="code style" /></a> <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="styled with prettier" /></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/lassjs/lass.svg" alt="license" /></a> <a href="https://npm.im/lass"><img src="https://img.shields.io/npm/dt/lass.svg" alt="npm downloads" /></a> </div> <br /> <div align="center"> Lass scaffolds a modern package boilerplate for <a href="https://nodejs.org">Node.js</a> </div> <div align="center"> <sub> A lass that fell in love with a <a href="https://lad.js.org"><strong>lad</strong></a> • Built by <a href="https://github.com/niftylettuce">@niftylettuce</a> and <a href="#contributors">contributors</a> </sub> </div> <hr /> <div align="center">:heart: Love this project? Support <a href="https://github.com/niftylettuce" target="_blank">@niftylettuce's</a> <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software" target="_blank">FOSS</a> on <a href="https://patreon.com/niftylettuce" target="_blank">Patreon</a> or <a href="https://paypal.me/niftylettuce">PayPal</a> :unicorn:</div>Table of Contents
Features
- Unit testing with ava
- Commit linting with commitlint
- Linting with xo (uses eslint and prettier)
- Markdown Linting with remark
- Automatic code formatting with prettier
- Automatic
git init - Automatic
npm install(oryarn installif selected) - Automatic builds, tests, and code coverage uploading to Codecov with Travis-CI
- Includes git/editor configurations:
- Automatic markdown formatting and linting with remark
- Adheres to GitHub flavored markdown standards
- Adds contributors section automatically with remark-contributors
- Adjusts heading gaps automatically
- Adds a license block automatically with remark-license
- Utilizes configurable presets with remark-preset-github
- 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 v10+
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
- lad - Scaffold a Koa webapp and API framework for Node.js
- lipo - Free image manipulation API service built on top of Sharp
- cabin - Logging and analytics solution for Node.js, Lad, Koa, and Express
Contributors
| Name | Website |
|---|---|
| Nick Baugh | http://niftylettuce.com |
| Pablo Varela | http://pablo.life |
| Shaun Warman | http://shaunwarman.com |
| Imed Jaberi | https://www.3imed-jaberi.com |
| Spencer Snyder | https://spencersnyder.io |
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
<a href="#"><img src="https://cdn.rawgit.com/lassjs/lass/e39cd571/media/lass-footer.png" alt="#" /></a>