eslint-config-minsug
Version:
Minsug shareable ESLint config (v9 Flat)
19 lines (13 loc) • 2.01 kB
Markdown
# Repository Guidelines
## Project Structure & Module Organization
`index.js` is the published flat ESLint config that exports the shared rule set. Dependencies that power the config live in `package.json`; keep version bumps deliberate because they affect every consumer. Runtime artifacts stay out of the repo—verify generated files in a linked project instead of committing them here.
## Build, Test, and Development Commands
- `npm install` keeps plugin and parser versions aligned with the published config.
- `npm pack` produces the tarball you can install in a sample project to validate changes before release.
- `npx eslint --print-config src/index.ts --config ./node_modules/eslint-config-minsug/index.js` (run inside a consumer project with `eslint@^9`) confirms the final merged rules.
## Coding Style & Naming Conventions
Author config updates in ESM style (`import`/`export`) with two-space indentation and trailing semicolons to match `index.js`. Group related rule blocks with concise comments and prefer English summaries unless aligning with existing Korean notes. When adding plugins, register them in `plugins` using camelCase keys and mirror that key inside `rules` entries.
## Testing Guidelines
There is no in-repo test harness, so validate changes by linting representative TypeScript + React codebases. Capture regressions with targeted fixture repos and share the reproduction steps in the pull request. Use `npx eslint src --config ./node_modules/eslint-config-minsug/index.js --max-warnings=0` to ensure the config remains warning-free.
## Commit & Pull Request Guidelines
Recent history uses short, imperative messages (e.g., “eslint 룰 생성”). Stay concise, lead with the action, and keep tense present. For pull requests, include: a summary of the rule or dependency change, notes on ecosystem impact (breaking vs. additive), test commands executed, and any follow-up tasks. Link issues when available and add screenshots only if they clarify editor or CLI output.