@fimbul/mithotyn
Advanced tools
Comparing version 0.17.0-dev.20181218 to 0.17.0
{ | ||
"name": "@fimbul/mithotyn", | ||
"version": "0.17.0-dev.20181218", | ||
"version": "0.17.0", | ||
"description": "TypeScript LanguageService plugin for the Fimbullinter project", | ||
@@ -5,0 +5,0 @@ "main": "index", |
@@ -41,2 +41,14 @@ # Mithotyn | ||
### Using your existing `.fimbullinter.yaml` | ||
Like the CLI this plugin uses your configurations from a file named `.fimbullinter.yaml`. The main difference is that it doesn't only look for this file in the current directory but also in all parent directories. | ||
This is necessary because there is likely only one `.fimbullinter.yaml` in the root of your workspace, but multiple TypeScript projects may exist in subdirectories. | ||
The following options are used if present in that file. Note that all paths and modules are resolved relative to the directory containing this configuration file. | ||
* `modules`: loads the specified plugin modules to customize linter behavior | ||
* `config`: use the specified configuration file for all files | ||
* `files`: only lint files matching one of the given glob patterns | ||
* `exclude`: exclude files matching one of the given glob patterns | ||
### Configuration Options | ||
@@ -46,3 +58,3 @@ | ||
* `displayErrorsAsWarnings: boolean`: Report failures with severity `error` as warning to make them distinguishable from real type errors (e.g. green instead of red squiggles in VS Code) | ||
* `displayErrorsAsWarnings: boolean`: Report findings with severity `error` as warning to make them distinguishable from real type errors (e.g. green instead of red squiggles in VS Code) | ||
@@ -81,12 +93,12 @@ Example: | ||
There are some limitations of the current implementation. These are subject to change in future releases. | ||
There are some limitations of the current implementation. | ||
* doesn't use processors at all | ||
The following limitations will likely be fixed in future releases. | ||
* Currently only works with TypeScript installed in your workspace, see [Usage in VS Code](#usage-in-vs-code) | ||
* doesn't use global options from `.fimbullinter.yaml` | ||
* no plugin modules | ||
* no fixed `config` option | ||
* no `files` matching | ||
* no `exclude` option | ||
* doesn't provide code fixes for rule failures | ||
* doesn't provide code fixes for findings | ||
* doesn't validate `.wotanrc.yaml` and `.fimbullinter.yaml` files | ||
* doesn't refresh lint findings if configuration changes; you need to reopen or change the file | ||
@@ -93,0 +105,0 @@ ## License |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
19259
105