Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.24 KB

README.md

File metadata and controls

76 lines (47 loc) · 2.24 KB

@esri/eslint-plugin-calcite-components

ESLint rules specific to @esri/calcite-components development.

Installation

Install the following deps in your stencil project:

npm i @esri/eslint-plugin-calcite-components --save-dev

Usage

Add or update the .eslintrc.json configuration file:

{
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "extends": ["plugin:@esri/calcite-components/recommended"]
}

Add a new lint script to package.json:

{
  "scripts": {
    "lint": "eslint src/**/*{.ts,.tsx}"
  }
}

Then you can run the linter:

npm run lint

Supported Rules

This rule helps prevent usage of specific events and allows suggesting alternatives.

This rule ensures that calls to document.createElement() use string literals to avoid dynamic tag creation to enhance plugin compatibility.

This rule catches boolean props that are initialized in a way that does not conform to the HTML5 spec.

Contributing

We welcome contributions to this project. See CONTRIBUTING.md for an overview of contribution guidelines.

License

COPYRIGHT © 2025 Esri

All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.

This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.

See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english

For additional information, refer to Calcite's licensing and contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA

email: [email protected]

Third-party licenses

See THIRD-PARTY-LICENSES.md.