@canva/app-eslint-plugin

ESLint plugin for working with Canva.

Table of contents

• Introduction
• Setup
  • 1. Install
  • 2. Configure
• Shareable Configuration
• Changelog
• Contributing
• License

Introduction

The @canva/app-eslint-plugin package is an ESLint plugin that supplies configuration defaults and rules for working with Canva.

Setup

If you're using the Canva Apps SDK starter kit, or you've used the Canva CLI to create a Canva SDK app, the @canva/app-eslint-plugin package should already be installed and configured for you.

1. Install

You can migrate an existing Canva SDK app, or use the @canva/app-eslint-plugin package in an app not based on the starter kit or generated from the Canva CLI. First install the package as a development dependency:

npm install @canva/app-eslint-plugin --save-dev

2. Configure

You can use the ESLint plugin by importing the @canva/app-eslint-plugin package into your ESlint config, and applying the provided shareable config. To import the package to your ESlint flat config:

// eslint.config.js
import canva from "@canva/app-eslint-plugin";

export default [
  ...canva.configs.apps,
  // your existing eslint config
];

To opt in to stricter linting, use the strict configuration:

// eslint.config.mjs
import canva from "@canva/app-eslint-plugin";

export default [...canva.configs.apps_strict];

Strict linting adds import validation, React Hooks and accessibility rules, Testing Library rules, snake-case TypeScript filenames, and absolute imports between directories. It does not prescribe a test runner.

Shareable Configuration

This package provides the following configuration sets:

• apps - For creating and maintaining high-quality Canva Apps SDK apps.
• apps_strict - The apps configuration with additional strict lint rules.
• apps_no_i18n - This is the same as the apps configuration but without the requirement to translate the app. Most apps should support internationalization, however due to constraints on the number of messages some apps may not be able to be translated at this time.
• apps_i18n - This is just the parts of the apps config that aren't included in the apps_no_i18n configuration. Generally it's better to use the apps config directly.

These sets include the following configuration sets provided by other packages:

• ESLint recommended.
• typescript-eslint recommended, stylistic, and strict.
• eslint-plugin-react recommended.
• eslint-plugin-jest recommended.

Additionally, the following rules are configured:

• 💼 Configuration sets the rule is enabled in:
  • 📦 apps and apps_no_i18n
  • 🌐 apps and apps_i18n

Changelog

See the CHANGELOG.md file.

Contributing

We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the Canva Developers Community.

License

See the LICENSE.md file.