https://github.com/zdychacek/eslint-plugin-sklik

https://github.com/zdychacek/eslint-plugin-sklik

deprecation-tracker eslint eslint-plugin

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/zdychacek/eslint-plugin-sklik
• Owner: zdychacek
• Created: 2017-11-23T09:01:59.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-12T17:00:43.000Z (about 7 years ago)
• Last Synced: 2024-11-08T20:49:25.635Z (about 2 months ago)
• Topics: deprecation-tracker, eslint, eslint-plugin
• Language: JavaScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Sklik ESLint rules

Instalation:

`npm i @sklik/eslint-plugin-sklik --dev`

## Rules

### Deprecated

This rule informs about deprecated code. It uses JSDoc syntax to mark deprecated code.

**Example:**

Configuration:

```js

{

  plugins: [

    "@sklik/eslint-plugin-sklik"

  ],

  rules: {

    "@sklik/sklik/deprecated": 1 // 2 for errors

  }

}

```

Code:

```js

/**

 * This is a description.

 * @deprecated since 12.0.1

 * @deprecated reason Requires AS >= 15.0

 */

function myFn () {}

 ```

ESLint output:

 `"myFn" is deprecated since version 12.0.1. Current version is 12.5.0. (Reason: "Requires AS >= 15.0") (@sklik/sklik/deprecated)`