B4CKSP4CE Code Style Guide

Introduction

This repository is the home of B4CKSP4CE's style guide, which includes configs for popular linting and styling tools.

The following configs are available, and are designed to be used together.

• ESLint
• TypeScript

Install the package using your package manager of choice:

# Using pnpm
pnpm install --save-dev @bksp/style-guide eslint@9

# For Next.js, also install the Next.js ESLint plugin
pnpm install --save-dev eslint-config-next

Editorconfig

Editorconfig enforcing consistent coding styles across various editors and IDEs. Copy the .editorconfig file to the root of your project.

ESLint

Note: ESLint is a peer-dependency of this package, and should be installed at the root of your project.

There are multiple ESLint configurations available:

• @bksp/style-guide/eslint/base - base rules without environment-specific settings
• @bksp/style-guide/eslint/node - for generic JS/TS projects
• @bksp/style-guide/eslint/nest - for Nest
• @bksp/style-guide/eslint/next - for Next

Re-export the desired configuration in your project's eslint.config.mjs file:

// eslint.config.mjs
export { default } from '@bksp/style-guide/eslint/next'

You can extend this configuration to add project-specific rules. Read more about it in Configuring ESLint documentation.

TypeScript

Extend your tsconfig.json file with the shared TypeScript config:

{
  "extends": "@bksp/style-guide/typescript"
}

Commit messages

Use whatever style you prefer, but be consistent. We encourage you to use Conventional Commits.

Example:

feat(recognition): add Digikey PN recognition (#123)

fix: incorrect part number recognition