Skip to content

Commit 93dba87

Browse files
committed
chore: add CLAUDE.md and disallow test.skip
1 parent e0893f6 commit 93dba87

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

.claude/CLAUDE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
This is Entity, a privacy-aware data layer for defining, caching, and authorizing access to application data models.
8+
9+
## Essential Development Commands
10+
11+
### Dependencies
12+
- `yarn add` - Add a dependency. Run this only if necessary and ask before running.
13+
14+
### Building and Linting
15+
- `yarn tsc` - Typecheck the code
16+
- `yarn lint` - Run ESLint on source code
17+
- `yarn ctix` - Build barrel index.ts files
18+
19+
### Testing
20+
- `yarn test` - Run unit tests
21+
- `yarn integration` - Run integration tests against dockerized environment
22+
23+
### Commit messages
24+
- All PRs use conventional commits for their titles: https://www.conventionalcommits.org/
25+
26+
## Code conventions
27+
- 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.
28+
- Do not use jest's `test.skip`
29+
- Prefer not to use dynamic imports for now
30+
- Whenever technically correct, use typescript types for something instead of `any`

eslint.config.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,21 @@ module.exports = defineConfig([
4646
property: 'only',
4747
message: 'describe.only should not be committed to main.',
4848
},
49+
{
50+
object: 'it',
51+
property: 'skip',
52+
message: 'it.skip should not be committed to main.',
53+
},
54+
{
55+
object: 'test',
56+
property: 'skip',
57+
message: 'test.skip should not be committed to main.',
58+
},
59+
{
60+
object: 'describe',
61+
property: 'skip',
62+
message: 'describe.skip should not be committed to main.',
63+
},
4964
],
5065
},
5166
},

0 commit comments

Comments
 (0)