@sap-cloud-sdk/eslint-config

@sap-cloud-sdk/eslint-config

This package contains a shareable eslint configuration based on the configuration used by the SAP Cloud SDK. It extends the eslint:recommended and @typescript-eslint/recommended rulesets. It also uses the eslint-config-prettier to avoid any formatting conflicts when using the highly recommended prettier.

How to use

Import the flat configuration in your eslint.config.js:

import sapCloudSdkConfig from '@sap-cloud-sdk/eslint-config/flat-config';

Then add it to your own configuration in defineConfig(): defineConfig(sapCloudSdkConfig, /* your config */).

Legacy ESLint configuration files

To add the configuration please adjust your ESlint configuration (usually called .eslintrc or .eslintrc.js):

{
  "extends": "@sap-cloud-sdk"
}

or if you want to combine this configuration with others:

{
  "extends": ["airbnb", "@sap-cloud-sdk"]
}

This configuration depends on plugins "eslint-plugin-import-x" and "eslint-plugin-unused-imports", which need to be installed in your project.

ESlint merges these shareable configs with your configuration. Any rule configured in your .eslintrc.js will overwrite the setting for this rule in shareable configs.

Support

The recommended way to get in touch with us is to create an issue on GitHub. Select the issue category Bug, Feature, or Question depending on the nature of your request. We try to provide fixes, features and answers as soon as possible.

Contribute

If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.

Links

• Official support channel
• Github
• SAP Cloud SDK Documentation
  • Overview
  • Getting started guide
  • API documentation
  • Release notes
• Sample repository
• SAP Cloud SDK for AI (JavaScript)
  • GitHub
  • Documentation

License

The SAP Cloud SDK is released under the Apache License Version 2.0.