VS Code Settings Management

This repository contains the master configuration for VS Code-based editors (VS Code, Cursor, and Antigravity). By using symbolic links, we ensure a consistent coding environment across all editors.

How it Works

The master settings.json file in this directory is symlinked to the standard configuration paths used by the editors. Any change made in one editor is immediately reflected in the others.

Setup Instructions

To link your editor to this master configuration, run the following commands (standard for macOS):

# Antigravity
ln -s "$(pwd)/settings.json" "$HOME/Library/Application Support/Antigravity/User/settings.json"

# VS Code
ln -s "$(pwd)/settings.json" "$HOME/Library/Application Support/Code/User/settings.json"

# Cursor
ln -s "$(pwd)/settings.json" "$HOME/Library/Application Support/Cursor/User/settings.json"

How to Update Settings

1. Direct Edit: Open the settings.json file in this repository and make your changes.
2. Editor UI: Open the Settings UI in your editor. Changes made there will be saved directly to the symlinked master file.

Reloading the Editor

While most settings (like themes and font sizes) update instantly, some specialized extension settings or core editor behaviors require a reload to take effect:

• Command Palette: Press Cmd+Shift+P
• Command: Type Developer: Reload Window and press Enter.

Included Features

Markdownlint Configuration

Markdown linting is configured to work consistently across both the VS Code extension and CLI tool, using a shared configuration file as the single source of truth.

Why use markdownlint-cli2?

For beginners, this tool is helpful because it allows for automatic fixing of Markdown formatting issues.

Your suspicion is correct: we have custom rules in the markdownlint-rules/ directory (like md040-autofix.js) that automatically repair common mistakes (e.g., fixing fenced code block syntax). Without the CLI tool, you would rely solely on the editor's "Format on Save" feature. The CLI tool allows you to:

1. Batch Fix: Fix multiple files at once from the terminal.
2. Consistency: Ensure identical linting results across different environments.
3. Automation: Run checks automatically before committing code.

Installation

To use the CLI features, install the tool globally via npm:

npm install -g markdownlint-cli2

Architecture

~/.markdownlint.jsonc ──symlink──▶ .markdownlint.jsonc (SOURCE OF TRUTH)
                                          ▲                    ▲
                                          │                    │
                                      extends              extends
                                          │                    │
                     settings.json ───────┘                    │
                     (markdownlint.config)                     │
                                                               │
                     .markdownlint-cli2.jsonc ─────────────────┘
                     (CLI config)

#### Files

| File | Purpose |
| ------ | --------- |
| `.markdownlint.jsonc` | **Single source of truth** for rule settings (e.g., MD013, MD036) |
| `.markdownlint-cli2.jsonc` | CLI config — extends `.markdownlint.jsonc`, adds `customRules` & `ignores` |
| `settings.json` | VS Code config — extends `.markdownlint.jsonc`, adds `customRules` |
| `markdownlint-rules/` | Custom autofix rules (md040-autofix.js, md060-autofix.js) |

#### Symlinks

```bash
# Markdownlint CLI config (for running markdownlint-cli2 from any directory)
ln -s "$(pwd)/.markdownlint-cli2.jsonc" "$HOME/.markdownlint-cli2.jsonc"

# Shared rules config (for extends to work globally)
ln -s "$(pwd)/.markdownlint.jsonc" "$HOME/.markdownlint.jsonc"

Adding/Changing Rules

Edit .markdownlint.jsonc — both the VS Code extension and CLI will pick up the changes.

Other Features

• Python Support: Optimized for Ruff and Black.
• Tailwind CSS: Enabled Emmet completions.
• UI Tweaks: Consistent themes and breadcrumbs across all environments.