Skip to content

Commit

Permalink
chore: doc and repo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
spence-s committed Nov 13, 2021
1 parent 8ffe0d7 commit 2aa849d
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 18 deletions.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
# lassify

[![build status](https://img.shields.io/travis/com/Spence-S/lassify.svg)](https://travis-ci.com/Spence-S/lassify)
[![code coverage](https://img.shields.io/codecov/c/github/Spence-S/lassify.svg)](https://codecov.io/gh/Spence-S/lassify)
[![build status](https://img.shields.io/travis/com/lassjs/lassify.svg)](https://travis-ci.com/lassjs/lassify)
[![code coverage](https://img.shields.io/codecov/c/github/lassjs/lassify.svg)](https://codecov.io/gh/lassjs/lassify)
[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
[![license](https://img.shields.io/github/license/Spence-S/lassify.svg)](LICENSE)
[![license](https://img.shields.io/github/license/lassjs/lassify.svg)](LICENSE)
[![npm downloads](https://img.shields.io/npm/dt/lassify.svg)](https://npm.im/lassify)

> cli for lass
> Lass inspired cli for managing dev dependency tool chain
## Table of Contents

- [About](#about)
- [Install](#install)
- [Usage](#usage)
- [Contributors](#contributors)
- [License](#license)

## About

Inspired by [lass](https://github.com/lassjs/lass), lassify installs and manages your dev dependency tool chain in any project.

Currently lassify is work-in-progress and installs and sets up husky and lint-staged. In the future we hope to fully and intelligently manage dev dependency upgrade paths and migrations in your project as APIs change, including properly migrating any current configurations that you have that do not line up with our default configurations. For example, running `lassify` in a project with husky v3 and lint-staged v3 will properly take all the current configurations and properly set them up for the newest APIs and remove your old configurations with no breaks. Currently we simply install the newest versions and set up default configurations for these tools.

## Install

[npm][]:
Expand All @@ -33,9 +40,25 @@ yarn add lassify

## Usage

```sh
lassify
```
cli for lass
Run lassify at the root of any project to install and manage your devDependencies.
Usage:
$ lassify [options]
Options
--cwd Optional directory to run the cli from. Defaults to process.cwd().
Examples
$ lassify
$ lassify --cwd '../other/directory'
```

## Similar Efforts

- [mrm](https://github.com/sapegin/mrm)

## Contributors

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "lassify",
"name": "@lassjs/lassify",
"description": "cli for lass",
"version": "0.0.0",
"author": {
Expand All @@ -11,7 +11,7 @@
"lassify": "src/cli.js"
},
"bugs": {
"url": "https://github.com/Spence-S/lassify/issues",
"url": "https://github.com//lassify/issues",
"email": "sasnyde2@gmail.com"
},
"contributors": [
Expand Down Expand Up @@ -50,7 +50,7 @@
"engines": {
"node": ">= 10"
},
"homepage": "https://github.com/Spence-S/lassify",
"homepage": "https://github.com/lassjs/lassify",
"keywords": [
"lass",
"lassify"
Expand All @@ -59,7 +59,7 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/Spence-S/lassify.git"
"url": "git+https://github.com/lassjs/lassify.git"
},
"scripts": {
"coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
Expand Down
16 changes: 8 additions & 8 deletions src/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ import lassify from './lassify.js';

const cli = meow(
`
Run lassify at the root of any project to install and manage your devDependencies.
Run lassify at the root of any project to install and manage your devDependencies.
Usage:
$ lassify [options]
Usage:
$ lassify [options]
Options
--cwd Optional directory to run the cli from. Defaults to process.cwd().
Options
--cwd Optional directory to run the cli from. Defaults to process.cwd().
Examples
$ lassify
$ lassify --cwd '../other/directory'
Examples
$ lassify
$ lassify --cwd '../other/directory'
`,
{
importMeta: import.meta,
Expand Down

0 comments on commit 2aa849d

Please sign in to comment.