Skip to content

Commit 5a5bef1

Browse files
committed
chore: merge branch 'main' into nkruk/updatePreviewCommand
2 parents 4fdf6d0 + 48cacce commit 5a5bef1

File tree

1 file changed

+5
-32
lines changed

1 file changed

+5
-32
lines changed

.cursorrules

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Project Overview
44

5-
This is a Salesforce CLI plugin for Lightning development tools (LEX, Mobile, and Experience Sites). It's built with TypeScript, uses yarn for package management, and leverages wireit for intelligent build caching and task orchestration.
5+
This is a Salesforce CLI plugin for Lightning Web Component development (LEX, Mobile, Experience Sites, and Single Component Preview). It's built with TypeScript, uses yarn for package management, and leverages wireit for intelligent build caching and task orchestration.
66

77
## Key Technologies
88

99
- **TypeScript**: Primary language for the plugin
1010
- **Wireit**: Build task orchestration with intelligent caching
1111
- **Yarn**: Package manager (v1.22.22 as specified in volta config)
12-
- **Node.js**: Runtime (v20.11.0 as specified in volta config)
12+
- **Node.js**: This project supports all active and LTS versions of node
1313
- **Salesforce CLI (sf)**: The platform this plugin extends
1414
- **Lightning Web Components (LWC)**: Core technology for component development
1515
- **Jest/Mocha**: Testing frameworks
@@ -86,7 +86,7 @@ Why both commands are needed:
8686
### Alternative Cleaning Options
8787

8888
- `yarn clean`: Light cleanup (preserves some caches)
89-
- Individual task clearing: Delete specific folders in `.wireit/` if you know which task is problematic
89+
- Individual task clearing: Delete specific folders in `.wireit/` or `.eslintcache` if you know which task is problematic
9090

9191
## Development Workflow Best Practices
9292

@@ -109,21 +109,11 @@ yarn test:only # Just unit tests
109109
yarn test:nuts # Integration tests (slower)
110110
```
111111

112-
### Local Development
113-
114-
```bash
115-
# Use local dev command instead of global sf
116-
./bin/dev lightning dev component
117-
./bin/dev lightning dev site
118-
./bin/dev lightning dev app
119-
```
120-
121112
### Linking for Testing
122113

123114
```bash
124115
# Link plugin to global sf CLI for testing
125116
sf plugins link .
126-
sf plugins # Verify plugin is linked
127117
```
128118

129119
## Project-Specific Context
@@ -163,7 +153,7 @@ This plugin provides three main commands:
163153
- `package.json`: Contains all wireit task definitions
164154
- `tsconfig.json`: TypeScript configuration
165155
- `lwc.config.json`: Lightning Web Components configuration
166-
- `.eslintcache`: ESLint cache file
156+
- `.eslintcache`: ESLint cache file (can be safely deleted)
167157

168158
## Coding Guidelines
169159

@@ -194,25 +184,8 @@ This plugin provides three main commands:
194184
2. **Don't ignore wireit cache issues**: If builds seem wrong, clean and rebuild
195185
3. **Don't skip the yarn install step**: After `clean-all`, always reinstall dependencies
196186
4. **Don't modify generated files**: Focus changes on `src/` directory
197-
5. **Don't use global sf CLI for development**: Use `./bin/dev` for local testing
187+
5. **Don't ignore eslint cache issues**: If linting shouldn't be failing, always try deleting the `.eslintcache`
198188

199189
## Emergency Troubleshooting
200190

201-
If everything seems broken:
202-
203-
```bash
204-
# Nuclear option - start completely fresh
205-
rm -rf node_modules .wireit lib *.tsbuildinfo .eslintcache
206-
yarn install
207-
yarn build
208-
```
209-
210-
If wireit tasks seem stuck or corrupted:
211-
212-
```bash
213-
# Just clear wireit cache
214-
rm -rf .wireit
215-
yarn build
216-
```
217-
218191
Remember: **When in doubt, `yarn clean-all && yarn install && yarn build`** - this solves 90% of build-related issues in this project.

0 commit comments

Comments
 (0)