Skip to content

Commit 74995de

Browse files
pstackebrandtpstackebrandt
committed
Add Cursor IDE configuration documentation to README
- Include detailed explanation of .cursorignore and .cursorindexingignore files - Describe purpose and usage of Cursor IDE configuration - Provide guidance for team members on managing these configuration files - Improve project documentation with IDE-specific setup information
1 parent d8f83ac commit 74995de

File tree

3 files changed

+163
-0
lines changed

3 files changed

+163
-0
lines changed

‎.cursorignore‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Cursor ignore file - similar to .gitignore but for Cursor IDE
2+
3+
# Dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# Build artifacts
9+
/build
10+
/dist
11+
/.next
12+
/out
13+
14+
# Testing
15+
/coverage
16+
/.nyc_output
17+
/cypress/videos
18+
/cypress/screenshots
19+
20+
# Environment and secrets
21+
.env
22+
.env.local
23+
.env.development.local
24+
.env.test.local
25+
.env.production.local
26+
/.env*
27+
*.pem
28+
29+
# Logs
30+
/logs
31+
*.log
32+
npm-debug.log*
33+
yarn-debug.log*
34+
yarn-error.log*
35+
36+
# Cache and temporary files
37+
.cache
38+
.temp
39+
.tmp
40+
.eslintcache
41+
.stylelintcache
42+
.DS_Store
43+
.idea
44+
.vscode
45+
*.swp
46+
*.swo
47+
*~
48+
49+
# Large binary files
50+
*.zip
51+
*.tar.gz
52+
*.tgz
53+
*.rar
54+
*.pdf
55+
*.mp4
56+
*.mov
57+
*.png
58+
*.jpg
59+
*.jpeg
60+
*.gif
61+
*.ico
62+
*.woff
63+
*.woff2
64+
*.ttf
65+
*.eot
66+
67+
# Package files - often large and not needed for context
68+
package-lock.json
69+
yarn.lock

‎.cursorindexingignore‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Cursor indexing ignore file - controls what's excluded from code indexing
2+
# More targeted than .cursorignore, focusing on performance improvement
3+
4+
# Dependencies - very large and not typically needed for indexing
5+
/node_modules
6+
/.pnp
7+
.pnp.js
8+
9+
# Build output
10+
/build
11+
/dist
12+
/out
13+
14+
# Generated files
15+
*.generated.*
16+
*.min.js
17+
*.min.css
18+
*.bundle.js
19+
20+
# Non-project code
21+
/public/static
22+
/public/assets
23+
24+
# Large data files
25+
*.json
26+
!package.json
27+
!tsconfig.json
28+
!.eslintrc.json
29+
!.prettierrc.json
30+
!manifest.json
31+
!*.config.json
32+
!jest.config.json
33+
34+
# Test fixtures and mocks
35+
__mocks__/
36+
__fixtures__/
37+
/test/fixtures
38+
/cypress/fixtures
39+
40+
# Documentation
41+
/docs
42+
*.md
43+
!README.md
44+
45+
# Large lock files that slow down indexing
46+
package-lock.json
47+
yarn.lock
48+
49+
# Other large files
50+
*.svg
51+
*.map

‎README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Build app for production](#build-app-for-production)
1414
- [Project management](#project-management)
1515
- [Documentation](#documentation)
16+
- [Cursor IDE Configuration](#cursor-ide-configuration)
1617
- [History](#history)
1718
- [Publishing](#publishing)
1819

@@ -86,6 +87,48 @@ I use github for project management.
8687

8788
Documentation can be found in the /docs directory. See the [docs](docs/README.md) directory for more information.
8889

90+
## Cursor IDE Configuration
91+
92+
This project includes configuration files for Cursor IDE to improve performance and AI context management:
93+
94+
### .cursorignore
95+
96+
The `.cursorignore` file tells Cursor which files and directories to exclude from various operations like search, indexing, and AI context. Similar to `.gitignore`, it uses pattern matching.
97+
98+
**Key exclusions:**
99+
- Dependencies and node_modules
100+
- Build artifacts and output directories
101+
- Environment files with potentially sensitive information
102+
- Cache, logs, and temporary files
103+
- Large binary files (images, fonts, etc.)
104+
- Package lock files
105+
106+
### .cursorindexingignore
107+
108+
The `.cursorindexingignore` file specifically controls what's excluded from Cursor's code indexing functionality.
109+
This helps improve performance by reducing the indexed codebase size.
110+
111+
**Key exclusions:**
112+
113+
- Build output and generated files
114+
- Large data files (with exceptions for config files)
115+
- Test fixtures and documentation files
116+
- Source maps and other large non-source files
117+
118+
### How to Use
119+
120+
1. **For new team members:**
121+
- No action needed - these files are part of the repository and will be applied automatically
122+
123+
2. **Customizing the ignore files:**
124+
- Add patterns similar to `.gitignore` syntax
125+
- Use `!` to negate a pattern (include something that would otherwise be excluded)
126+
- Use `/` prefix to specify directory-only matches
127+
128+
3. **When to update:**
129+
- Add new patterns when introducing new build artifacts or large files
130+
- Remove patterns if those files become important for AI context or code indexing
131+
89132
## History
90133

91134
The app runs now directly in the root folder, not in a subfolder like its predecessor.

0 commit comments

Comments
 (0)