eslint-config-seek

eslint-config-seek

This package includes the shareable ESLint configuration used by SEEK.

Usage in sku and skuba Projects

The easiest way to use this configuration is with sku or skuba.

You don’t need to install it separately in sku and skuba projects.

Usage Outside of sku and skuba

If you want to use this ESLint configuration in a project not built with sku or skuba, you can install it with following steps.

First, install this package, and the necessary peer dependencies listed in this project's package.json.

Then create a file named eslint.config.js with the following contents in the root folder of your project:

module.exports = require('eslint-config-seek');

The default configuration includes support for React projects. For projects that are not based on React, the "base" configuration should be used instead:

module.exports = require('eslint-config-seek/base');

You can override the settings from eslint-config-seek by editing the eslint.config.js file. Learn more about configuring ESLint on the ESLint website.

License

MIT.

Changelog

14.6.0

Minor Changes

• Error on custom getters and setters (#227)

  The no-restricted-syntax rule is now preconfigured to ban custom getters and setters. Engineers typically expect property access to be a safer operation than method or function invocation. Throwing an error from a getter can cause confusion and unhandled promise rejections, which can lead to a crash on the server side if not appropriately configured. See the PR for more information.

  const obj = {
  - get prop() {
  + prop() {
      throw new Error('Badness!');
    },
  };
  

  A custom getter may be occasionally prescribed as the recommended approach to achieve desired behaviour. For example, this syntax can define a recursive object in Zod. In these rare scenarios, add an inline ignore and ensure that you do not throw an error within the getter.

  import * as z from 'zod';
  
  const Category = z.object({
    name: z.string(),
    // eslint-disable-next-line no-restricted-syntax -- Zod recursive type
    get subcategories() {
      return z.array(Category);
    },
  });