tauri-svelte-typescript-guide — Cursor rule for Tauri, Svelte
A Cursor rule that sets how the agent writes desktop apps with Tauri: Svelte on the frontend, TypeScript for types.
.cursor/rules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdcWhat tauri-svelte-typescript-guide-cursorrules-prompt-f does
The file tells the assistant how to write code in a Tauri project that uses Svelte and TypeScript. It covers type safety, Svelte's component model, calls to native Tauri APIs for the file system and system tray, and state through Svelte stores. Backend communication gets its own section: HTTP requests via Axios, network error handling, TypeScript interfaces for the data you send and receive.
Security and performance have their own blocks. The agent will flag Tauri's allowlist, frontend input validation and HTTPS for external services. On the performance side it suggests lazy loading for components and routes plus caching for frequently read data. Testing is described as Jest and Testing Library for components, Playwright or Cypress for end-to-end flows.
The rule assumes an external Python backend, so retry logic and serialization of complex structures are baked into the prompt. Swap that backend for something else and those sections need rewriting. Builds run through Vite, packaging through the Tauri CLI. Dependencies listed are Tauri, Svelte, TypeScript, Vite and Axios, which means a project without Axios gets advice that does not fit it.
What it helps with
- keep one code style across a Tauri and Svelte project
- get typed interfaces for external API responses
- remember the allowlist and input validation when touching native APIs
- set up lazy loading for Svelte components and routes
- cover components and critical user flows with tests
Example prompts for the agent
- Add a settings screen in Svelte and wire it to the API through Axios with types
- Check that file system access goes through native Tauri APIs and the allowlist is not wider than needed
- Write a unit test for this component and a Playwright end-to-end flow
How to install tauri-svelte-typescript-guide-cursorrules-prompt-f
Manually: put the files in place
.cursor/rules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdcFrontmatter: description, globs, alwaysApply
Manually: put the files in place
.claude/rules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdThe paths frontmatter field limits the files: move globs from the source into paths
AGENTS.md
Codex reads AGENTS.md: paste the rule text there
Manually: put the files in place
.github/instructions/tauri-svelte-typescript-guide-cursorrules-prompt-f.instructions.mdThe applyTo field sets which files it applies to: move globs from the source into applyTo
Manually: put the files in place
.devin/rules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdManually: put the files in place
.clinerules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdStep by step, with commands for each platform: Cursor rules: .mdc files, four modes and what replaced .cursorrules
Questions about tauri-svelte-typescript-guide-cursorrules-prompt-f
How do I install the tauri-svelte-typescript-guide rule in Cursor?
Create .cursor/rules/tauri-svelte-typescript-guide-cursorrules-prompt-f.mdc in your project root and paste the rule text into it. Cursor picks it up automatically.
What does this rule do?
It sets the agent's conventions for Tauri desktop apps with Svelte and TypeScript: typing, native API calls, Axios requests to an external backend, security and tests.
Which backend does the rule target?
The text covers talking to an external Python backend, including retries on failed requests and serialization of complex data. Point it at a backend in another language and those sections need rewriting.
Source text
tauri-svelte-typescript-guide-cursorrules-prompt-f.mdc · CC0-1.0
--- description: "Cursor rules for Tauri development with Svelte and TypeScript guide integration." globs: **/* alwaysApply: false --- You are an expert in developing desktop applications using Tauri with Svelte and TypeScript for the frontend. Key Principles: - Write clear, technical responses with precise examples for Tauri, Svelte, and TypeScript. - Prioritize type safety and utilize TypeScript features effectively. - Follow best practices for Tauri application development, including security considerations. - Implement responsive and efficient UIs using Svelte's reactive paradigm. - Ensure smooth communication between the Tauri frontend and external backend services. Frontend (Tauri + Svelte + TypeScript): - Use Svelte's component-based architecture for modular and reusable UI elements. - Leverage TypeScript for strong typing and improved code quality. - Utilize Tauri's APIs for native desktop integration (file system access, system tray, etc.). - Implement proper state management using Svelte stores or other state management solutions if needed. - Use Svelte's built-in reactivity for efficient UI updates. - Follow Svelte's naming conventions (PascalCase for components, camelCase for variables and functions). Communication with Backend: - Use Axios for HTTP requests from the Tauri frontend to the external backend. - Implement proper error handling for network requests and responses. - Use TypeScript interfaces to define the structure of data sent and received. - Consider implementing a simple API versioning strategy for future-proofing. - Handle potential CORS issues when communicating with the backend. Security: - Follow Tauri's security best practices, especially when dealing with IPC and native API access. - Implement proper input validation and sanitization on the frontend. - Use HTTPS for all communications with external services. - Implement proper authentication and authorization mechanisms if required. - Be cautious when using Tauri's allowlist feature, only exposing necessary APIs. Performance Optimization: - Optimize Svelte components for efficient rendering and updates. - Use lazy loading for components and routes where appropriate. - Implement proper caching strategies for frequently accessed data. - Utilize Tauri's performance features, such as resource optimization and app size reduction. Testing: - Write unit tests for Svelte components using testing libraries like Jest and Testing Library. - Implement end-to-end tests for critical user flows using tools like Playwright or Cypress. - Test Tauri-specific features and APIs thoroughly. - Implement proper mocking for API calls and external dependencies in tests. Build and Deployment: - Use Vite for fast development and optimized production builds of the Svelte app. - Leverage Tauri's built-in updater for seamless application updates. - Implement proper environment configuration for development, staging, and production. - Use Tauri's CLI tools for building and packaging the application for different platforms. Key Conventions: 1. Follow a consistent code style across the project (e.g., use Prettier). 2. Use meaningful and descriptive names for variables, functions, and components. 3. Write clear and concise comments, focusing on why rather than what. 4. Maintain a clear project structure separating UI components, state management, and API communication. Dependencies: - Tauri - Svelte - TypeScript - Vite - Axios Refer to official documentation for Tauri, Svelte, and TypeScript for best practices and up-to-date APIs. Note on Backend Communication: When working with the external Python backend: - Ensure proper error handling for potential backend failures or slow responses. - Consider implementing retry mechanisms for failed requests. - Use appropriate data serialization methods when sending/receiving complex data structures.
© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules