https://github.com/adobe-rnd/eslint-plugin-xwalk

https://github.com/adobe-rnd/eslint-plugin-xwalk

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/adobe-rnd/eslint-plugin-xwalk
• Owner: adobe-rnd
• License: apache-2.0
• Created: 2024-06-14T14:45:15.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-01-23T19:28:46.000Z (13 days ago)
• Last Synced: 2025-01-23T20:26:29.845Z (13 days ago)
• Language: JavaScript
• Size: 148 KB
• Stars: 0
• Watchers: 10
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-xwalk

Custom rules to validate aem-boilerplate-xwalk projects

## Installation

You'll first need to install [ESLint](https://eslint.org/):

```sh

npm i eslint --save-dev

```

Next, install `eslint-plugin-xwalk`:

```sh

npm install eslint-plugin-xwalk --save-dev

```

## Usage

Add `xwalk` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "xwalk"

    ]

}

```

Then configure the rules you want to use under the rules section.

```json

{

    "rules": {

        "xwalk/max-cells": "error"

    }

}

```

Or extend the recommended configuration

```json

{

  "extend" [

    "plugin:xwalk/recommended"

  ]

}

```

## Configurations

|    | Name          |

| :- | :------------ |

| ✅  | `recommended` |

## Rules

💼 Configurations enabled in.\

✅ Set in the `recommended` configuration.

| Name                                                                       | Description                                                                                               | 💼 |

| :------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | :- |

| [max-cells](docs/rules/max-cells.md)                                       | Limit the number of cells in a block.                                                                     | ✅  |

| [no-custom-resource-types](docs/rules/no-custom-resource-types.md)         | Do not use custom resource types. Serverside extensibility with customer resource types is not supported. | ✅  |

| [no-duplicate-fields](docs/rules/no-duplicate-fields.md)                   | Avoid duplicate field names.                                                                              | ✅  |

| [no-orphan-collapsible-fields](docs/rules/no-orphan-collapsible-fields.md) | Do not use collapsible field name suffixes without the actual field being present in the model.           | ✅  |