https://github.com/nextcloud-libraries/eslint-config

Shared eslint config
https://github.com/nextcloud-libraries/eslint-config

config configuration nextcloud nextcloud-config nextcloud-plugin

Last synced: 5 days ago
JSON representation

Shared eslint config

• Host: GitHub
• URL: https://github.com/nextcloud-libraries/eslint-config
• Owner: nextcloud-libraries
• License: agpl-3.0
• Created: 2019-09-23T16:21:12.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-20T16:29:32.000Z (21 days ago)
• Last Synced: 2024-12-27T04:03:09.323Z (15 days ago)
• Topics: config, configuration, nextcloud, nextcloud-config, nextcloud-plugin
• Language: JavaScript
• Homepage: https://npmjs.org/@nextcloud/eslint-config
• Size: 3.31 MB
• Stars: 8
• Watchers: 4
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
	

## @nextcloud/eslint-config

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/eslint-config)](https://api.reuse.software/info/github.com/nextcloud-libraries/eslint-config)

[![npm last version](https://img.shields.io/npm/v/@nextcloud/eslint-config.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/eslint-config)

[![Lint status](https://img.shields.io/github/actions/workflow/status/nextcloud-libraries/eslint-config/lint-eslint.yml?label=lint&style=flat-square)](https://github.com/nextcloud-libraries/eslint-config/actions/workflows/lint.yml)

[![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&style=flat-square&logo=dependabot)](https://dependabot.com)

This is a package containing the unified global eslint config used by all nextcloud apps.

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

```bash

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

```

## Usage

Add a file `.eslintrc.js` in the root directory of your app repository with the following content:

```js

module.exports = {

	extends: [

		'@nextcloud',

	],

}

```

### Usage with Typescript projects

If your projects uses Typescript for vue files, like `` then use the Typescript config instead:

Add a file `.eslintrc.js` in the root directory of your app repository with the following content:

```js

module.exports = {

	extends: [

		'@nextcloud/eslint-config/typescript',

	],

}

```

### Usage with Vue 3 projects

If your projects uses Vue 3 you have to use the `vue3` sub-configuration.

This configuration also includes Typescript support by default.

Add a file `.eslintrc.js` in the root directory of your app repository with the following content:

```js

module.exports = {

	extends: [

		'@nextcloud/eslint-config/vue3',

	],

}

```

## 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