README.md

@nextcloud/eslint-config

This is a package containing the unified global eslint config used by all nextcloud apps and libraries. It contains the necessary dependencies and peerDependencies so that other apps cannot update if this config does not support it. Please always use dependabot to update your apps, OR pay attention to the peer dependencies error messages!

Installation

npm install @nextcloud/eslint-config --save-dev

Usage

Note

Since version 9 this package depends on ESLint 9, which uses the new flat config system.

This package provides some predefined configurations you can choose from. For the recommended setup add a file eslint.config.js in the root directory of your app repository with the following content:

import { recommended } from '@nextcloud/eslint-config'

export default [
	...recommended,
]

Available configurations

Instead of the recommended configuration this package also provides some alternatives, depending on your app setup you can also choose:

• recommended
  • General rules including code style
  • Support for Typescript
  • Support for Vue 3
  • Support Vue files with Typescript syntax (the script within .vue files will be handled as Typescript).
• recommendedJavascript
  • Same as recommended but Vue files (the script part) will be handled as Javascript.
• recommendedVue2
  • Same as recommended but Vue files are considered in Vue 2 syntax.
• recommendedVue2Javascript
  • Same as recommended but Vue files are considered in Vue 2 syntax and the script part will be handled as Javascript instead of Typescript.

Bundled plugins

This configuration also provides some bundled plugins with new rules, those options are already included in the recommended configurations.

It is possible to override the recommended configurations:

// eslint.config.js
import { recommended } from '@nextcloud/eslint-config'
export default [
  ...recommended,
  {
    files: ['**/*.js'],
    rules: {
      // Make deprecations error instead of warning level
      '@nextcloud/no-deprecations': ['error'],
    }
  }
]

You can even use the plugins without using the Nextcloud ESLint config:

// eslint.config.js
import { nextcloudPlugin } from '@nextcloud/eslint-config'
export default [
  {
    files: ['**/*.js'],
    plugins: {
			'@nextcloud': nextcloudPlugin,
		},
		rules: {
			'@nextcloud/no-removed-apis': ['error', { targetVersion: '29.0.0' }],
	  },
  }
]

package-json plugin

Rules:

• sort-package-json
  • Ensures the package.json is sorted in consistent order
  • Included as error level in recommended configurations

@nextcloud plugin

Rules:

• no-deprecations
  • Report usage of deprecated Nextcloud API
  • Included as warn level in recommended configuration
  • Available options

    {
      /**
       * Limit deprecated API to specified Nextcloud version
       * @example '29.0.0'
       * @default ''
       */
      targetVersion?: string
      /**
       * Try to find appinfo.xml to detect targetVersion
       * @default true
       */
      parseAppInfo?: boolean
    }

• no-removed-apis
  • Report usage of removed Nextcloud API
  • Included as error level in recommended configuration
  • Available options

    {
      /**
       * Limit removed API to specified Nextcloud version
       * @example '29.0.0'
       * @default ''
       */
      targetVersion?: string
      /**
       * Try to find appinfo.xml to detect targetVersion
       * @default true
       */
      parseAppInfo?: boolean
    }

Release new version

1. Update CHANGELOG.md file with the latest changes
2. Bump the package version with npm version
3. Push version bump commit
4. Create a new release with proper changelog https://github.com/nextcloud-libraries/eslint-config/releases/new