.cursorrules Astro TypeScript

by @Jaime Aleman

{
  "rules": {
    "commit_message_guidelines": {
      "description": "Guidelines for creating conventional commit messages.",
      
      "format": {
        "description": "The format for commit messages using the conventional commits spec.",
        "body": "[optional scope]: \n\n[optional body]\n\n[optional footer(s)]"
      },
      
      "enabled": true,
      
      "rules": [
        {
          "description": "Always suggest a conventional commit with a type and optional scope in lowercase letters."
        },
        {
          "description": "Keep the commit message concise and within 60 characters."
        },
        {
          "description": "Ensure the commit message is ready to be pasted into the terminal without further editing."
        },
        {
          "description": "Provide the full command to commit, not just the message."
        }
      ],
      
      "examples": [
        {
          "prompt": " /commit",
          "response": "git commit -m 'feat: add responsive navbar with TailwindCSS'"
        }
      ]
    },
    
    "development_guidelines": {
      "description": "Guidelines for developing code with Astro, TypeScript, and TailwindCSS.",
      
      "enabled": true,
      
      "rules": [
        {
          "description": "Enforce strict TypeScript settings, ensuring type safety across the project."
        },
        {
          "description": "Use TailwindCSS for all styling, keeping the utility-first approach in mind."
        },
        {
          "description": "Ensure Astro components are modular, reusable, and maintain a clear separation of concerns."
        }
      ]
    },
    
    "coding_style": {
      "description": "Guidelines for maintaining consistent coding style.",
      
      "enabled": true,
      
      "rules": [
        {
          "description": "Code must start with path/filename as a one-line comment."
        },
        {
          "description": "Comments should describe purpose, not effect."
        },
        {
          "description": "Prioritize modularity, DRY principles, and performance."
        }
      ]
    },
    
    "custom_slash_commands": {
      "description": "Custom slash commands.",
      
      "enabled": true,
      
      "commands": [
        {
          "name": "/commit",
          "description": "Generate a Git commit message using the conventional commits spec.",
          "enabled": true
        }
      ]
    }
  }
}

Commit Message Generator Web Tool

Web application generating conventional commit messages based on user input, complete with Git commands.

VSCode Extension for Conventional Commits

VS Code extension suggesting and completing commit messages according to conventional commit guidelines.

TailwindCSS Component Library Platform

Marketplace for building, sharing, and purchasing modular Astro components styled with TailwindCSS, ensuring type safety with TypeScript.

AI-Powered Code Review Bot

GitHub bot reviewing pull requests to enforce coding guidelines, providing feedback and suggestions.

Developer Onboarding Tool

Interactive guide for new developers to learn project-specific guidelines with exercises and examples.

CLI Tool for Conventional Commit Suggestions

Command-line tool analyzing code changes and suggesting conventional commit messages with execution commands.

Coding Standards Checker

Software integrated into CI/CD pipelines to check coding style adherence and provide actionable feedback.

Custom Slash Command Dashboard for Teams

Customizable interface for creating and managing team-specific slash commands to streamline workflows.

Interactive TailwindCSS Tutorial Platform

Step-by-step platform for learning TailwindCSS with a focus on utility-first design in Astro projects.

TypeScript Strict Configuration Starter Pack

Downloadable guide and setup kit for implementing strict TypeScript configurations to promote type safety and best practices.

Overview of .cursorrules prompt

The .cursorrules file establishes guidelines and rules for maintaining consistency and best practices in a development environment. It includes specific rules for creating conventional commit messages, ensuring development adherence using Astro, TypeScript, and TailwindCSS, and maintaining a consistent coding style. It also defines custom slash commands, like “/commit”, to facilitate the generation of Git commit messages following the conventional commits specification. These rules aim to streamline development processes and ensure code quality and uniformity across a project.

Updated: March 14, 2025

Developers using Astro, TypeScript, and TailwindCSS will benefit by creating a consistent, efficient workflow with clear commit messages and modular, maintainable components.

Usefull for: