https://github.com/luciancooper/pug-lint-config

Shareable pug-lint config
https://github.com/luciancooper/pug-lint-config

Last synced: 2 days ago
JSON representation

Shareable pug-lint config

• Host: GitHub
• URL: https://github.com/luciancooper/pug-lint-config
• Owner: luciancooper
• License: mit
• Created: 2020-01-06T03:39:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T22:03:58.000Z (almost 3 years ago)
• Last Synced: 2025-01-04T03:21:19.295Z (23 days ago)
• Language: JavaScript
• Size: 275 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @lcooper/pug-lint-config

[![npm][npm-badge]][npm-link]

[![license][license-badge]][license-link]

A sharable [pug-lint](https://github.com/pugjs/pug-lint) config for linting `pug` files.

## Installation

Install with the peer dependency [pug-lint](https://www.npmjs.com/package/pug-lint):

```bash

npm install --save-dev pug-lint @lcooper/pug-lint-config

```

## Usage

Add the `pugLintConfig` field to your `package.json` file:

```json

"pugLintConfig": {

  "extends": "@lcooper/pug-lint-config"

}

```

Or create a pug-lint config file type of your choice in the root folder of your project:

`.pug-lintrc` or `.pug-lintrc.json`

```json

{

  "extends": "@lcooper/pug-lint-config"

}

```

`.pug-lintrc.js`

```javascript

module.exports = {

    extends: '@lcooper/pug-lint-config',

};

```

## Scripts

Add a script to your `package.json` file:

```json

"scripts": {

  "lint:pug": "pug-lint **/*.pug"

}

```

[npm-link]: https://www.npmjs.com/package/@lcooper/pug-lint-config

[npm-badge]: https://img.shields.io/npm/v/@lcooper/pug-lint-config?logo=npm&style=for-the-badge

[license-link]: LICENSE

[license-badge]: https://img.shields.io/github/license/luciancooper/pug-lint-config?color=brightgreen&style=for-the-badge