Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrmlnc/vscode-puglint
:electric_plug: Linter and style checker for Pug (formerly Jade) as plugin for VS Code.
https://github.com/mrmlnc/vscode-puglint
pug pug-lint visual-studio-code vscode vscode-extension
Last synced: 9 days ago
JSON representation
:electric_plug: Linter and style checker for Pug (formerly Jade) as plugin for VS Code.
- Host: GitHub
- URL: https://github.com/mrmlnc/vscode-puglint
- Owner: mrmlnc
- License: mit
- Created: 2016-05-01T00:24:09.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-28T19:47:56.000Z (over 7 years ago)
- Last Synced: 2025-01-31T10:36:03.338Z (20 days ago)
- Topics: pug, pug-lint, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://goo.gl/g82rhu
- Size: 82 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-puglint
> This linter plugin for VS Code provides an interface to [pug-lint](https://github.com/pugjs/pug-lint).
## Installation
Linter installation is performed in several stages:
1. Install **pug-lint** use `npm i -D pug-lint` or `npm i -g pug-lint`.
2. Press F1 and select `Extensions: Install Extensions`.
3. Search and choose `vscode-puglint`.
See the [extension installation guide](https://code.visualstudio.com/docs/editor/extension-gallery) for details.
## Usage
Enable the linter in the VS Code [settings](https://code.visualstudio.com/docs/customization/userandworkspace).
```json
{
"puglint.enable": true
}
```
## Configurations
The plugin supports the following files:
* `.jade-lintrc` or `.jade-lint.json`
* `.pug-lintrc`, `.pug-lintrc.js`, `.pug-lintrc.json` or `.pug-lint.json`
* `pugLintConfig` section in the `package.json` file
The rules for determining the configuration file:
1. Editor settings
2. Workspace config (current project)
3. Package file (current project)
4. Global config ($HOME directory)
5. Default config `{}`
## Supported languages
* Pug
* Jade
## Supported settings
**puglint.enable**
* Type: `Boolean`
* Default: `false`
Control whether puglint is enabled for Pug/Jade files or not.
**puglint.run**
* Type: `String`
* Default: `onType`
* Supported values: `onType`, `onSave`
Run the linter on save (onSave) or on type (onType).
**puglint.config**
* Type: `Object`
* Default: `{}`
Will be directly passed to [config option](https://github.com/pugjs/pug-lint/blob/master/docs/rules.md).
For example:
```json
{
"puglint.enable": true,
"puglint.config": {
"requireClassLiteralsBeforeIdLiterals": true
}
}
```
Examples for use `extends` (don't forget to install config, for example [`pug-lint-config-clock`](https://github.com/clocklimited/pug-lint-config-clock)):
```json
{
"puglint.enable": true,
"puglint.config": {
"extends": "clock"
}
}
```
More information: [pug-lint: extends](https://github.com/pugjs/pug-lint#extends)
## Changelog
See the [Releases section of our GitHub project](https://github.com/mrmlnc/vscode-puglint/releases) for changelogs for each release version.
## License
This software is released under the terms of the MIT license.