# san-eslint-parser

> The ESLint custom parser for `.san/.ts/.js` files.

Latest version **2.0.6** (published 2022-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install san-eslint-parser
pnpm add san-eslint-parser
yarn add san-eslint-parser
bun add san-eslint-parser
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.6 |
| Published | 2022-03-24 |
| First published | 2020-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.10 |
| Dependencies | 7 |
| Unpacked size | 771.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | searchfe |
| Maintainers | wuyan1907, lhuanyu |

## Links

- npm: https://www.npmjs.com/package/san-eslint-parser
- Repository: https://github.com/searchfe/san-eslint-parser
- Homepage: https://github.com/searchfe/san-eslint-parser/blob/master/README.md
- Issues: https://github.com/searchfe/san-eslint-parser/issues
- npm.io page: https://npm.io/package/san-eslint-parser

## Dependencies (7)

- [esm](https://npm.io/package/esm.md) ^3.2.25
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [espree](https://npm.io/package/espree.md) ^6.2.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [esquery](https://npm.io/package/esquery.md) ^1.0.1
- [eslint-scope](https://npm.io/package/eslint-scope.md) ^5.0.0
- [eslint-visitor-keys](https://npm.io/package/eslint-visitor-keys.md) ^1.1.0

## Recent versions

- 2.0.6 (latest) — 2022-03-24
- 2.0.6-beta.0 (beta) — 2022-03-22
- 2.0.5 — 2022-01-07
- 2.0.4 — 2021-08-30
- 2.0.3 — 2021-08-26
- 2.0.2 — 2021-08-24
- 2.0.1 — 2021-08-17
- 2.0.0 — 2021-08-11
- 1.2.1 — 2021-05-25
- 1.2.0 — 2021-05-10
- 1.1.0 — 2020-12-03
- 1.0.0 — 2020-09-10

## README

# san-eslint-parser

The ESLint custom parser for `.san/.ts/.js` files.
Inspired by [vue-eslint-parser](https://github.com/vuejs/vue-eslint-parser)

## ⤴️ Motivation

This parser allows us to lint the `<template>` of `.san` files. We can make mistakes easily on `<template>` if we use complex directives and expressions in the template. This parser and the rules of [eslint-plugin-san] would catch some of the mistakes.

Also, This parser allows us to lint the first `template` class property or object property of `.ts/.js` files, that is to say you can only allowed to write one san component in every single `.ts/.js` file.

## 💿 Installation

```bash
$ npm install --save-dev eslint san-eslint-parser
```

- Requires Node.js 6.5.0 or later.
- Requires ESLint 5.0.0 or later.
- Requires `babel-eslint` 8.1.1 or later if you want it. (optional)
- Requires `@typescript-eslint/parser` 1.0.0 or later if you want it. (optional)

## 📖 Usage

1. Write `parser` option into your `.eslintrc.*` file.
2. Use glob patterns or `--ext .san` CLI option.

```json
{
    "extends": "eslint:recommended",
    "parser": "san-eslint-parser"
}
```

```console
$ eslint "src/**/*.{js,san}"
# or
$ eslint src --ext .san
```

## 🔧 Options

`parserOptions` has the same properties as what [espree](https://github.com/eslint/espree#usage), the default parser of ESLint, is supporting.
For example:

```json
{
    "parser": "san-eslint-parser",
    "parserOptions": {
        "sourceType": "module",
        "ecmaVersion": 2018,
        "ecmaFeatures": {
            "globalReturn": false,
            "impliedStrict": false,
            "jsx": false
        }
    }
}
```

### parserOptions.parser

You can use `parserOptions.parser` property to specify a custom parser to parse `<script>` tags.
Other properties than parser would be given to the specified parser.
For example:

```json
{
    "parser": "san-eslint-parser",
    "parserOptions": {
        "parser": "babel-eslint",
        "sourceType": "module",
        "allowImportExportEverywhere": false
    }
}
```

```json
{
    "parser": "san-eslint-parser",
    "parserOptions": {
        "parser": "@typescript-eslint/parser"
    }
}
```

If the `parserOptions.parser` is `false`, the `san-eslint-parser` skips parsing `<script>` tags completely.
This is useful for people who use the language ESLint community doesn't provide custom parser implementation.

## 🎇 Usage for custom rules / plugins

- This parser provides `parserServices` to traverse `<template>`.
    - `defineTemplateBodyVisitor(templateVisitor, scriptVisitor)` ... returns ESLint visitor to traverse `<template>`.
    - `getTemplateBodyTokenStore()` ... returns ESLint `TokenStore` to get the tokens of `<template>`.
    - `getDocumentFragment()` ... returns the root `VDocumentFragment`.
- [ast.md](./docs/ast.md) is `<template>` AST specification.


## ⚠️ Known Limitations

Some rules make warnings due to the outside of `<script>` tags.
Please disable those rules for `.san` files as necessary.

- [eol-last](http://eslint.org/docs/rules/eol-last)
- [linebreak-style](http://eslint.org/docs/rules/linebreak-style)
- [max-len](http://eslint.org/docs/rules/max-len)
- [max-lines](http://eslint.org/docs/rules/max-lines)
- [no-trailing-spaces](http://eslint.org/docs/rules/no-trailing-spaces)
- [unicode-bom](http://eslint.org/docs/rules/unicode-bom)
- Other rules which are using the source code text instead of AST might be confused as well.


## 🍻 Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

If you want to write code, please execute `npm install && npm run setup` after you cloned this repository.
The `npm install` command installs dependencies.
The `npm run setup` command initializes ESLint as git submodules for tests.

### Development Tools

- `npm test` runs tests and measures coverage.
- `npm run build` compiles TypeScript source code to `index.js`, `index.js.map`, and `index.d.ts`.
- `npm run coverage` shows the coverage result of `npm test` command with the default browser.
- `npm run clean` removes the temporary files which are created by `npm test` and `npm run build`.
- `npm run lint` runs ESLint.
- `npm run setup` setups submodules to develop.
- `npm run update-fixtures` updates files in `test/fixtures/ast` directory based on `test/fixtures/ast/*/source.san` files.
- `npm run watch` runs `build`, `update-fixtures`, and tests with `--watch` option.

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