@the-ruby-group/rgts v0.0.7

@the-ruby-group/rgts is an extension of Google's gts tooling, providing enhanced configurations for ESLint, Prettier, and TypeScript. This package is designed to simplify and standardize TypeScript development across multiple projects, ensuring consistency in code style, linting, and type checking.

Features

• Extended ESLint configuration based on gts to enforce best practices.
• Prettier integration for automatic code formatting.
• TypeScript configurations for base and React-specific projects.

Installation

To install @the-ruby-group/rgts, run:

# npm
npm install --save-dev @the-ruby-group/rgts

# yarn
yarn add --dev @the-ruby-group/rgts

# pnpm
pnpm add -D @the-ruby-group/rgts

# bun
bun add -d @the-ruby-group/rgts

Usage

An example of usage can be found in the project repository.

Extend ESLint Configuration

In your eslint.config.mjs file, extend the configuration provided by @the-ruby-group/rgts:

// Import the configuration from @the-ruby-group/rgts
import rubyGroupConfig from '@the-ruby-group/rgts/eslint.config.js';

export default [
  ...rubyGroupConfig,
  // Extra project-specific ESLint configurations can be added here...
];

Prettier Configuration

Add a prettier.config.mjs file and extend the configuration:

import rubyGroupConfig from '@the-ruby-group/rgts/prettier.config.js';

export default {
  ...rubyGroupConfig,
  // Extra project-specific settings can be added here...
};

TypeScript Configuration

Extend the TypeScript configuration by specifying tsconfig.json:

For base configuration:

{
  "extends": "@the-ruby-group/rgts/tsconfig.base.json"
}

For React projects:

{
  "extends": "@the-ruby-group/rgts/tsconfig.react.json"
}

License

MIT License