From 244690021c1bbe15310f7adc527f2d4acc17182e Mon Sep 17 00:00:00 2001 From: Will Schurman Date: Sun, 1 Feb 2026 10:10:37 -0800 Subject: [PATCH] chore: add CLAUDE.md and disallow test.skip --- .claude/CLAUDE.md | 30 ++++++++++++++++++++++++++++++ eslint.config.js | 15 +++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 .claude/CLAUDE.md diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md new file mode 100644 index 000000000..c7f8c9ba0 --- /dev/null +++ b/.claude/CLAUDE.md @@ -0,0 +1,30 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +This is Entity, a privacy-aware data layer for defining, caching, and authorizing access to application data models. + +## Essential Development Commands + +### Dependencies +- `yarn add` - Add a dependency. Run this only if necessary and ask before running. + +### Building and Linting +- `yarn tsc` - Typecheck the code +- `yarn lint` - Run ESLint on source code +- `yarn ctix` - Build barrel index.ts files + +### Testing +- `yarn test` - Run unit tests +- `yarn integration` - Run integration tests against dockerized environment + +### Commit messages +- All PRs use conventional commits for their titles: https://www.conventionalcommits.org/ + +## Code conventions +- Backwards compatibility is a non-goal of refactorings of this library. Consumers rely upon typescript to know what needs to be migrated, so all breaking changes should be detectable via running typescript post-entity-version-upgrade in a consumer application that makes use of this package. +- Do not use jest's `test.skip` +- Prefer not to use dynamic imports for now +- Whenever technically correct, use typescript types for something instead of `any` \ No newline at end of file diff --git a/eslint.config.js b/eslint.config.js index 429ebf696..62939dc26 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -46,6 +46,21 @@ module.exports = defineConfig([ property: 'only', message: 'describe.only should not be committed to main.', }, + { + object: 'it', + property: 'skip', + message: 'it.skip should not be committed to main.', + }, + { + object: 'test', + property: 'skip', + message: 'test.skip should not be committed to main.', + }, + { + object: 'describe', + property: 'skip', + message: 'describe.skip should not be committed to main.', + }, ], }, },