RightCapital Frontend Style Guide

RightCapital's frontend style guide monorepo — shared configs for ESLint, Prettier, TypeScript, and related tooling.

Packages

Package	Version	Description
@rightcapital/eslint-config		ESLint flat config with JS, TS, and React support
@rightcapital/eslint-plugin		Custom ESLint rules
@rightcapital/prettier-config		Shared Prettier configuration
@rightcapital/tsconfig		Shared TypeScript configuration
@rightcapital/lint-eslint-config-rules		CLI to check for deprecated/unknown ESLint rules

ESLint

Prerequisites

• eslint (>=9)
• typescript (optional, for TypeScript support)

Usage

Install @rightcapital/eslint-config to your project.

pnpm add -D @rightcapital/eslint-config

In your eslint.config.mjs (or equivalent):

import eslintConfigRightcapital from '@rightcapital/eslint-config';

const { defineConfig } = eslintConfigRightcapital.utils;

export default defineConfig(
  ...eslintConfigRightcapital.configs.recommended,

  // add more configs for specific files or packages if needed
  {
    files: ['scripts/**/*.{js,cjs,mjs}'],
    extends: [
      ...eslintConfigRightcapital.configs.node,
      ...eslintConfigRightcapital.configs.script,
    ],
  },
);

See packages/eslint-config for the full list of exported configs and utils.

Prettier

Prerequisites

• prettier

Usage

Install config package to your project:

pnpm add -D @rightcapital/prettier-config

In your project's prettier.config.cjs:

module.exports = require('@rightcapital/prettier-config');

See packages/prettier-config for details.

Development

1. Create a feature/* branch, make changes, and run pnpm -w change to generate a version plan
2. Open a PR to main and merge after review
3. Merge the automatically created Release PR to publish packages to npm

License

MIT License © 2023-Present