0.2.0 • Published 4 years ago

@sap/ui5-jsdocs v0.2.0

Weekly downloads
7
License
Apache-2.0
Repository
github
Last release
4 years ago

Build Status

@sap/ui5-jsdocs

Overview

This is the eslint plugin for UI5 appplications. It contains a set of eslint rules and recommended ESLint configuration for static jsdoc code checks of sap.ui.define modules to be used by UI5 appplication developers.

Usage

To add this package as a dependency in your package.json file, do the following:

  1. Under the "devDependencies" section, add the following dependency: "@sap/eslint-plugin-ui5-jsdocs": "a.b.c"
  2. Add .eslintrc.json file with the following content:
{
	"plugins": ["@sap/ui5-jsdocs"],
	"extends": "plugin:@sap/ui5-jsdocs/recommended"
}

List of rules

RuleDescriptionRecommended SeverityFixable
no-jsdocThere is no JSDoc providedWarningyes
no-jsdoc-paramThere is no JSDoc param definedWarningyes
no-jsdoc-param-typeThere is no JSDoc param type definedWarningno
wrong-jsdoc-param-typeThe JSDoc param type is incorrectWarningyes
duplicate-jsdoc-paramsThe argument should contain only one JSDoc paramWarningno