0.1.14 • Published 11 months ago

@assemble-inc/eslint-config-jest v0.1.14

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

ASMBL ESLint Configuration

This package contains ASMBL's ESLint configurations for testing within projects.

ESLint is used for enforcement of code quality across ASMBL projects.

Installation

From the root of your package, install the ASMBL configuration:

yarn add --dev @assemble-inc/eslint-config-jest

or

pnpm add --dev @assemble-inc/eslint-config-jest

or

bun add --dev @assemble-inc/eslint-config-jest

Configuration

Add Linting Scripts

Add the following scripts to your package.json.

"scripts": {
  "lint": "eslint \"src/**/*.{test.jsx,test.js,test.ts,test.tsx}\"",
  "lint:fix": "eslint \"src/**/*.{test.jsx,test.js,test.ts,test.tsx}\" --fix",
},

You can update the file directories to suit the particular files you would like to lint.

Import the linting configurations

The ASMBL. configuration needs to be imported into ESLint. Add the following to your package.json.

  "eslintConfig": {
    "extends": [
      "@assemble-inc/eslint-config-jest"
    ],
    "env": {
      "browser": true,
      "node": true
    }
  },

That's it! No eslint config file required.

Usage

The lint:fix script will automatically attempt to fix reported errors and warnings. Running lint will report errors/warnings without attempting to fix them.