@pleaseai/code-style

English | 한국어

A monorepo providing shared code style configurations for PleaseAI projects — for outsourcing, open source, and internal use.

See the code-style documentation site for full guides.

Packages

Package	Description
@pleaseai/eslint-config	ESLint flat config wrapping @antfu/eslint-config with PleaseAI defaults
@pleaseai/prettier-config	Shared Prettier config (JSON)
@pleaseai/editorconfig	Shared .editorconfig for consistent editor settings
@pleaseai/ast-grep-config	ast-grep rules for agent-navigable code (ADR-0022); the path checker is please-style check

@pleaseai/eslint-config

Installation

bun add -D @pleaseai/eslint-config eslint

Usage

// eslint.config.ts
import pleaseai from '@pleaseai/eslint-config'

export default pleaseai()

With custom overrides:

import pleaseai from '@pleaseai/eslint-config'

export default pleaseai(
  {
    // Override defaults (typescript, stylistic, gitignore are pre-configured)
    vue: true,
  },
  // Additional flat config entries
  {
    rules: {
      'no-console': 'warn',
    },
  },
)

Defaults

• stylistic: indent: 2, quotes: 'single', semi: false
• typescript: true
• gitignore: true

Development

To set up the repo, build, and lint locally, follow Getting started in CONTRIBUTING.md.

Releasing

release-please automates releases from Conventional Commits, and GitHub Actions publishes the packages to npm with provenance.