eslint-plugin-tvui

A custom plugin designed for use within TV User Interface (TVUI) projects, providing standardized linting rules and environment settings for web and mobile development. The plugin helps ensure code quality, consistency, and best practices in large-scale TVUI projects.

Features

• Standardized Rules: Provides a set of recommended rules that enforce best practices across TVUI projects.
• Environment Configuration: Supports linting for browser, Node.js, ES6, and Jest environments.

Installation

To install the plugin, run:

npm install eslint-plugin-tvui --save-dev

Usage

Step 1: Add the Plugin to Your Configuration

Create an .eslintrc.js or .eslintrc.json file in your project root if you don’t already have one. Add eslint-plugin-tvui to your configuration.

.eslintrc.js Example:

module.exports = {
  "env": {
    "browser": true,
    "node": true,
    "es6": true
  },
  "extends": [
    "plugin:tvui/recommended"
  ],
  "plugins": [
    "tvui"
  ],
  "rules": {
    // Additional custom rules can go here if needed
  }
};

Step 2: Lint Your Code

To lint your code using the plugin, run:

npx eslint .

Output Example:

/path/to/project/index.js
  5:9  warning  Unexpected console statement. Use a logging library instead  no-console
  13:7  warning  'unusedVar' is assigned a value but never used             no-unused-vars

✖ 2 problems (0 errors, 2 warnings)

Contributing

Want to contribute? Although internally focused accept PRs after review- please feel free!

Support

Having issues? Please reach out to your contact(s) directly or file an issue in the repository.