https://github.com/tinymins/eslint-plugin-lvmcn
https://github.com/tinymins/eslint-plugin-lvmcn
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tinymins/eslint-plugin-lvmcn
- Owner: tinymins
- License: mit
- Created: 2022-12-21T16:02:17.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T15:17:49.000Z (almost 3 years ago)
- Last Synced: 2025-03-15T04:02:44.335Z (11 months ago)
- Language: TypeScript
- Size: 878 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin
[](https://github.com/tinymins/eslint-plugin-lvmcn/actions)
[](https://github.com/prettier/prettier)
[](http://commitizen.github.io/cz-cli/)
## 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.
### 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