Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextcloud-libraries/eslint-plugin
An ESLint plugin that detects usage of deprecated and removed Nextcloud APIs
https://github.com/nextcloud-libraries/eslint-plugin
eslint nextcloud-config nextcloud-eslint-plugin nextcloud-plugin
Last synced: 30 days ago
JSON representation
An ESLint plugin that detects usage of deprecated and removed Nextcloud APIs
- Host: GitHub
- URL: https://github.com/nextcloud-libraries/eslint-plugin
- Owner: nextcloud-libraries
- License: mit
- Created: 2019-05-14T19:49:50.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T01:48:14.000Z (7 months ago)
- Last Synced: 2024-04-01T02:46:34.690Z (7 months ago)
- Topics: eslint, nextcloud-config, nextcloud-eslint-plugin, nextcloud-plugin
- Language: JavaScript
- Homepage: https://npmjs.org/@nextcloud/eslint-plugin
- Size: 448 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @nextcloud/eslint-plugin
Nextcloud lint plugin for ESLint. This plugin provides a set of rules in order to check compliance of your app to the Nextcloud JavaScript API.
It is recommended to configure your app to use [`@nextcloud/eslint-config`](https://github.com/nextcloud/eslint-config) in advance. Then, this plugin is integrated automatically, but you profit also from the common Nextcloud coding standard.
## Installation
You'll first need to install [ESLint](http://eslint.org):
```
$ npm i eslint --save-dev
```
Next, install `@nextcloud/eslint-plugin`:
```
$ npm install @nextcloud/eslint-plugin --save-dev
```
## Usage
Add `plugin:nextcloud/recommended` to the `extends` section of your `.eslintrc` configuration file in order to use all recommended options (load estlint-plugin-nextcloud, add Nextcloud environment and add recommended rules):
```json
{
"extends": [
"plugin:nextcloud/recommended"
]
}
```
Alternatively, you can activate only those parts that you want to use. In this case, you have to add `nextcloud` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": [
"nextcloud"
]
}
```
Add the Nextcloud environment if you want to use global variables defined by Nextcloud server.
```json
{
"env": {
"nextcloud/nextcloud": true,
}
}
```
Configure the rules you want to use under the rules section.
```json
{
"rules": {
"nextcloud/no-deprecations": "warn",
"nextcloud/no-removed-apis": "error",
}
}
```
### Limit the Nextcloud version to report
By default all removed or deprecated API is reported, but if your app targets an older version of Nextcloud then you can limit the reported issues to changes before and with that version.
For example you target Nextcloud 25 and you use `OC.L10n` which was deprecated with Nextcloud 26. To disable reporting that deprecation you can set the target version to *25*:
```json
{
"rules": {
"nextcloud/no-deprecations": ["warn", { "targetVersion": "25.0.0" }],
"nextcloud/no-removed-apis": ["error", { "targetVersion": "25.0.0" }],
}
}
```
It is also possible to detect that your supported Nextcloud version from your `appinfo/info.xml` (`max-version` of your `nextcloud` dependency):
```json
{
"rules": {
"nextcloud/no-deprecations": ["warn", { "parseAppInfo": true }],
"nextcloud/no-removed-apis": ["error", { "parseAppInfo": true }],
}
}
```
## Supported Shared Configurations
* `nextcloud/recommended`: Recommended configuration that loads the Nextcloud ESlint plugin, adds the Nextcloud environment and configures all recommended Nextcloud rules.
## Supported Environments
* `nextcloud/nextcloud`: Manifests global variables defined by Nextcloud server
## Supported Rules
* `nextcloud/no-deprecations`: Detects properties and functions that were deprecated in Nextcloud server
* `nextcloud/no-removed-apis`: Detects previously available APIs that were removed from Nextcloud server