# eslint-plugin-lvmcn

> ESLint plugin for custom rules.

Latest version **0.0.5** (published 2022-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-lvmcn
pnpm add eslint-plugin-lvmcn
yarn add eslint-plugin-lvmcn
bun add eslint-plugin-lvmcn
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2022-12-23 |
| First published | 2022-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 14 |
| Dependencies | 2 |
| Unpacked size | 29.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | tinymins |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-lvmcn
- Repository: https://github.com/tinymins/eslint-plugin-lvmcn
- Homepage: https://github.com/tinymins/eslint-plugin-lvmcn#readme
- Issues: https://github.com/tinymins/eslint-plugin-lvmcn/issues
- npm.io page: https://npm.io/package/eslint-plugin-lvmcn

## Dependencies (2)

- [@typescript-eslint/utils](https://npm.io/package/@typescript-eslint/utils.md) ^5.47.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.47.0

## Recent versions

- 0.0.5 (latest) — 2022-12-23
- 0.0.4 — 2022-12-22
- 0.0.3 — 2022-12-22
- 0.0.2 — 2022-12-22
- 0.0.1 — 2022-12-22

## README

# eslint-plugin

[![GitHub Actions Status](https://github.com/tinymins/eslint-plugin-lvmcn/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/tinymins/eslint-plugin-lvmcn/actions)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

<!-- Short and clear description of the package -->

## Usage

### Basic setup

To use this plugin, install it as a `devDependency` first, alongside ESLint
itself:

```bash
npm install --save-dev eslint-plugin-lvmcn eslint
```

## Rules

| Rule                             | Description                                            | Configurations   | Fixable  |
| -------------------------------- | ------------------------------------------------------ | ---------------- | -------- |
| [no-single-line-comment-block][] | Single line comments should not be in a block comment. | ![recommended][] | ![fix][] |

## Getting Started

These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes. See usage notes on how to
consume this package in your project.

<!-- Instructions -->

### Prerequisites

Minimal requirements to set up the project:

- [Node.js](https://nodejs.org/en) v14, installation instructions can be found
  on the official website, a recommended installation option is to use
  [Node Version Manager](https://github.com/creationix/nvm#readme). It can be
  installed in a
  [few commands](https://nodejs.org/en/download/package-manager/#nvm).
- A package manager [npm](https://www.npmjs.com). All instructions in the
  documentation will follow the npm syntax.
- Optionally a [Git](https://git-scm.com) client.

### Installing

Start by cloning the repository:

```bash
git clone git@github.com:tinymins/eslint-plugin-lvmcn.git
```

In case you don't have a git client, you can get the latest version directly by
using
[this link](https://github.com/tinymins/eslint-plugin-lvmcn/archive/master.zip)
and extracting the downloaded archive.

Go the the right directory and install dependencies:

```bash
cd eslint-plugin-lvmcn
npm install
```

That's it! You can now go to the next step.

## Tests

### Formatting

This project uses [Prettier](https://prettier.io) to automate formatting. All
supported files are being reformatted in a pre-commit hook. You can also use one
of the two scripts to validate and optionally fix all of the files:

```bash
npm run format
npm run format:fix
```

### Linting

This project uses [ESLint](https://eslint.org) to enable static analysis.
TypeScript files are linted using a [custom configuration](./.eslintrc). You can
use one of the following scripts to validate and optionally fix all of the
files:

```bash
npm run lint
npm run lint:fix
```

### Coverage

[Coveralls.io](https://coveralls.io)

## Built with

### Runtime libraries

### Automation

- [GitHub Actions](https://github.com/features/actions)
- [Dependabot](https://dependabot.com/)

### Source

- [TypeScript](https://www.typescriptlang.org)

### Delivery

## Versioning

This project adheres to [Semantic Versioning](http://semver.org) v2.

[no-single-line-comment-block]: docs/rules/no-single-line-comment-block.md
[recommended]: https://img.shields.io/badge/-recommended-blueviolet.svg
[fix]: https://img.shields.io/badge/-fix-yellow.svg

---
_Source: https://npm.io/package/eslint-plugin-lvmcn · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._