# brms-linter

> A linter for BRMS

Latest version **0.0.1** (published 2020-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install brms-linter
pnpm add brms-linter
yarn add brms-linter
bun add brms-linter
```

Provides the command `brmslint`.

## 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.1 |
| Published | 2020-04-16 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 205.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | jeremiec |
| Maintainers | jeremiec |

## Links

- npm: https://www.npmjs.com/package/brms-linter
- Repository: https://github.com/theodo/brms-linter
- Homepage: https://github.com/theodo/brms-linter#readme
- Issues: https://github.com/theodo/brms-linter/issues
- npm.io page: https://npm.io/package/brms-linter

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) 7.1.6
- [antlr4](https://npm.io/package/antlr4.md) 4.8.0

## Recent versions

- 0.0.1 (latest) — 2020-04-16

## README

# Linter for BRMS

## Install the latest release

```shell
git clone --depth 1 --branch releases git@github.com:theodo/brms-linter.git
```

## Usage

Single file:

```shell
node app.js filepath.srl
```

Several files, use a glob:

```shell
node app.js './**/*.srl'
```

### Update

```shell
git checkout releases
git fetch origin releases
git pull
```

## Dev

### Install

- Clone the repository `git clone git@github.com:theodo/brms-linter.git`
- You need to [install antlr](https://www.antlr.org/download.html)
- Create a simlink to your installed antlr `ln -sr <path to your installed antlr> <repo path>/antlr`

### Run

- Run `make build-parser` to rebuild the parser
- `npm start` to run it again sample.srl

### Release :

- From branch master:
- Checkout the releases branch `git checkout releases`
- Merge master in releases `git merge master`
- Run `make build-parser` and **amend the merge commit** with the generated files `git add -f build/*;git commit -v --no-edit --amend`

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