# first-mate-select-grammar

> provides `registry.selectGrammar` for dependants that need it like highlghts.

Latest version **1.0.3** (published 2019-06-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install first-mate-select-grammar
pnpm add first-mate-select-grammar
yarn add first-mate-select-grammar
bun add first-mate-select-grammar
```

## 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 | 1.0.3 |
| Published | 2019-06-26 |
| First published | 2015-09-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ryan Day |
| Maintainers | soldair |
| Keywords | first-mate, grammar |

## Links

- npm: https://www.npmjs.com/package/first-mate-select-grammar
- Repository: https://github.com/soldair/first-mate-select-grammar
- Homepage: https://github.com/soldair/first-mate-select-grammar#readme
- Issues: https://github.com/soldair/first-mate-select-grammar/issues
- npm.io page: https://npm.io/package/first-mate-select-grammar

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11

## Recent versions

- 1.0.3 (latest) — 2019-06-26
- 1.0.2 — 2018-12-18
- 1.0.1 — 2015-09-20
- 1.0.0 — 2015-09-20

## README

# first-mate-select-grammar
provides `selectGrammar` searching functionality for dependants that used the 3.x api feature removed from highlights

```js
var pickGrammar = require('first-mate-select-grammar')()
var GrammarRegistry = require('first-mate').GrammarRegistry

var registry = new GrammarRegistry({maxTokens:Infinity})
// you would probably.. registry.loadGrammarSync('path to grammar.cson')

var grammar = pickGrammar.selectGrammar(GrammarRegistry,'test.js',' var a = 1\n var b =2\n')
// yay! grammar is always defined!!

```


## API

- module.exports() 
  - returns new instance of grammarSelector

- grammarSelector.selectGrammar(firstMate.GrammarRegistry, [fileName,[fileContents]])
  - returns an instance of firstMate.Grammar

### override API

this is provided because its useful to implement a grammar cache.

- grammarSelector.setGrammarOverrideForPath(path)
  - sets an override
  - returns undefined

- grammarSelector.grammarOverrideForPath(path)
  - returns a set grammar override

- grammarSelector.clearGrammarOverrideForPath(path)
  - deletes an override
  - returns undefined

- grammarSelector.clearGrammarOverrides(path)
 - deletes all overrides

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