IDE Settings

This template provides pre-configured IDE settings files that automatically enforce the DevOps Engineering Style Guide standards across all supported languages and editors.

Overview¶

Copy these configuration files to your project root to enable automatic formatting, linting, and style enforcement without manual IDE configuration.

Supported IDEs:

Visual Studio Code
IntelliJ IDEA / PyCharm / WebStorm
Any editor with EditorConfig support

Supported Languages:

Python, TypeScript, Bash, PowerShell, SQL, Groovy (Jenkins)
Terraform, Terragrunt, HCL, AWS CDK, Kubernetes/Helm, Ansible
YAML, JSON, Markdown, Dockerfile, Docker Compose, Makefile
GitHub Actions, GitLab CI/CD

Quick Start¶

Option 1: Copy from This Repository¶

# Clone the style guide repository
git clone https://github.com/tydukes/coding-style-guide.git

# Copy IDE settings to your project
cp -r coding-style-guide/.vscode your-project/
cp -r coding-style-guide/.idea your-project/
cp coding-style-guide/.editorconfig your-project/

Option 2: Use as Git Submodule¶

# Add as submodule
cd your-project
git submodule add https://github.com/tydukes/coding-style-guide.git .style-guide

# Symlink IDE settings
ln -s .style-guide/.vscode .vscode
ln -s .style-guide/.idea .idea
ln -s .style-guide/.editorconfig .editorconfig

Option 3: Manual Setup¶

Create each file as documented below in your project root.

File Structure¶

your-project/
├── .vscode/
│   ├── settings.json          # VS Code settings
│   ├── extensions.json        # Extension recommendations
│   └── launch.json            # Debug configurations
├── .idea/
│   ├── codeStyles/
│   │   ├── Project.xml        # IntelliJ code styles
│   │   └── codeStyleConfig.xml
│   └── inspectionProfiles/
│       ├── Project.xml        # IntelliJ inspections
│       └── profiles_settings.xml
└── .editorconfig              # Universal editor configuration

VS Code Setup¶

1. Settings File (`.vscode/settings.json`)¶

Comprehensive settings for all languages matching pre-commit hook configurations.

Key features:

Black formatter for Python (100 char line)
Flake8 linting (extends ignore E203, W503)
yamllint integration (120 char line)
markdownlint with custom rules
shellcheck integration
Terraform language server with auto-format
TypeScript/JavaScript Prettier integration
Automatic trailing whitespace removal
Final newline enforcement

Python example:

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true,
    "editor.rulers": [100],
    "editor.tabSize": 4
  },
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Args": [
    "--max-line-length=100",
    "--extend-ignore=E203,W503"
  ]
}

YAML example:

{
  "[yaml]": {
    "editor.defaultFormatter": "redhat.vscode-yaml",
    "editor.formatOnSave": true,
    "editor.rulers": [120],
    "editor.tabSize": 2
  }
}

Terraform example:

{
  "[terraform]": {
    "editor.defaultFormatter": "hashicorp.terraform",
    "editor.formatOnSave": true,
    "editor.rulers": [120],
    "editor.tabSize": 2
  },
  "terraform.languageServer.enable": true
}

2. Extension Recommendations (`.vscode/extensions.json`)¶

Automatically prompts users to install required extensions.

Required extensions:

{
  "recommendations": [
    "ms-python.python",
    "ms-python.black-formatter",
    "ms-python.flake8",
    "redhat.vscode-yaml",
    "DavidAnson.vscode-markdownlint",
    "timonwong.shellcheck",
    "hashicorp.terraform",
    "hashicorp.hcl",
    "ms-azuretools.vscode-docker",
    "esbenp.prettier-vscode",
    "ms-vscode.powershell",
    "eamodio.gitlens",
    "EditorConfig.EditorConfig",
    "sonarsource.sonarlint-vscode",
    "redhat.ansible",
    "dbaeumer.vscode-eslint",
    "aws-scripting-guy.cdk-snippets",
    "ms-kubernetes-tools.vscode-kubernetes-tools",
    "tim-koehler.helm-intellisense",
    "github.vscode-github-actions",
    "gitlab.gitlab-workflow"
  ]
}

Install all extensions:

# Install extensions from command line
cat .vscode/extensions.json | jq -r '.recommendations[]' | xargs -L 1 code --install-extension

IntelliJ/PyCharm Setup¶

1. Code Styles (`.idea/codeStyles/Project.xml`)¶

Language-specific formatting rules matching the style guide.

Python configuration:

<Python>
  <option name="INDENT_SIZE" value="4" />
  <option name="RIGHT_MARGIN" value="100" />
  <option name="BLACK_FORMATTER" value="true" />
  <option name="OPTIMIZE_IMPORTS_ON_THE_FLY" value="true" />
</Python>

YAML configuration:

<YAMLCodeStyleSettings>
  <option name="INDENT_SIZE" value="2" />
  <option name="RIGHT_MARGIN" value="120" />
</YAMLCodeStyleSettings>

Terraform configuration:

<TerraformCodeStyleSettings>
  <option name="INDENT_SIZE" value="2" />
  <option name="RIGHT_MARGIN" value="120" />
</TerraformCodeStyleSettings>

2. Inspections (`.idea/inspectionProfiles/Project.xml`)¶

Enabled inspections matching linting standards.

Python inspections:

<inspection_tool class="PyPep8Inspection" enabled="true" level="WEAK WARNING">
  <option name="ignoredErrors">
    <list>
      <option value="E203" />
      <option value="W503" />
    </list>
  </option>
</inspection_tool>

Shell inspections:

<inspection_tool class="ShellCheck" enabled="true" level="ERROR" />

Terraform inspections:

<inspection_tool class="TFIncorrectVariableType" enabled="true" level="ERROR" />
<inspection_tool class="TFMissingModule" enabled="true" level="ERROR" />

EditorConfig Setup¶

Universal Settings (`.editorconfig`)¶

Works with all editors (VS Code, IntelliJ, Vim, Emacs, etc.).

Complete example:

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

[*.py]
indent_size = 4
max_line_length = 100

[*.{yaml,yml}]
indent_size = 2
max_line_length = 120

[*.{tf,tfvars,hcl}]
indent_size = 2
max_line_length = 120

[*.{sh,bash}]
indent_size = 2
max_line_length = 100

[*.md]
max_line_length = 120
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

EditorConfig precedence:

.editorconfig (universal baseline)
IDE-specific settings (.vscode/settings.json, .idea/codeStyles/)
User global settings

Benefits:

Works across all team members regardless of IDE choice
No IDE-specific configuration needed
Portable across projects
Language-aware indentation and line endings

Language-Specific Configuration¶

Python¶

VS Code:

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.rulers": [100],
    "editor.tabSize": 4
  },
  "python.linting.flake8Args": ["--max-line-length=100", "--extend-ignore=E203,W503"]
}

EditorConfig:

[*.py]
indent_size = 4
max_line_length = 100

Terraform/HCL¶

VS Code:

{
  "[terraform]": {
    "editor.defaultFormatter": "hashicorp.terraform",
    "editor.formatOnSave": true,
    "editor.tabSize": 2
  },
  "terraform.languageServer.enable": true
}

EditorConfig:

[*.{tf,tfvars,hcl}]
indent_size = 2
max_line_length = 120

YAML¶

VS Code:

{
  "[yaml]": {
    "editor.defaultFormatter": "redhat.vscode-yaml",
    "editor.rulers": [120],
    "editor.tabSize": 2
  }
}

EditorConfig:

[*.{yaml,yml}]
indent_size = 2
max_line_length = 120

Bash/Shell¶

VS Code:

{
  "[shellscript]": {
    "editor.defaultFormatter": "foxundermoon.shell-format",
    "editor.tabSize": 2
  },
  "shellcheck.enable": true
}

EditorConfig:

[*.{sh,bash}]
indent_size = 2
max_line_length = 100

TypeScript/JavaScript¶

VS Code:

{
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.rulers": [100],
    "editor.tabSize": 2
  }
}

EditorConfig:

[*.{ts,tsx,js,jsx}]
indent_size = 2
max_line_length = 100

Markdown¶

VS Code:

{
  "[markdown]": {
    "editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
    "editor.rulers": [120],
    "files.trimTrailingWhitespace": false
  },
  "markdownlint.config": {
    "MD013": { "line_length": 120 }
  }
}

EditorConfig:

[*.md]
max_line_length = 120
trim_trailing_whitespace = false

Makefile¶

VS Code:

{
  "[makefile]": {
    "editor.insertSpaces": false,
    "editor.detectIndentation": false
  }
}

EditorConfig:

[Makefile]
indent_style = tab

Ansible¶

VS Code:

{
  "[ansible]": {
    "editor.defaultFormatter": "redhat.ansible",
    "editor.formatOnSave": true,
    "editor.rulers": [120],
    "editor.tabSize": 2
  },
  "ansible.ansible.useFullyQualifiedCollectionNames": true,
  "ansible.validation.enabled": true,
  "ansible.validation.lint.enabled": true,
  "ansible.validation.lint.path": "ansible-lint"
}

EditorConfig:

[*.{yaml,yml}]
indent_size = 2
max_line_length = 120

AWS CDK¶

VS Code:

{
  "[typescript]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports": "explicit",
      "source.fixAll.eslint": "explicit"
    }
  },
  "eslint.validate": ["typescript"],
  "cdk.autoSuggest": true
}

EditorConfig:

[*.{ts,tsx}]
indent_size = 2
max_line_length = 100

Kubernetes/Helm¶

VS Code:

{
  "vs-kubernetes": {
    "vs-kubernetes.helm-path": "helm",
    "vs-kubernetes.kubectl-path": "kubectl"
  },
  "yaml.schemas": {
    "kubernetes": ["k8s/**/*.yaml", "manifests/**/*.yaml"],
    "https://json.schemastore.org/helmfile": "helmfile.yaml",
    "https://json.schemastore.org/kustomization": "kustomization.yaml"
  },
  "files.associations": {
    "**/k8s/**/*.yaml": "yaml",
    "**/manifests/**/*.yaml": "yaml",
    "**/charts/**/*.yaml": "helm"
  }
}

EditorConfig:

[{k8s,manifests}/**/*.{yaml,yml}]
indent_size = 2
max_line_length = 120

Terragrunt¶

VS Code:

{
  "files.associations": {
    "terragrunt.hcl": "terraform",
    "**/terragrunt.hcl": "terraform"
  },
  "[terraform]": {
    "editor.defaultFormatter": "hashicorp.terraform",
    "editor.formatOnSave": true,
    "editor.rulers": [120]
  }
}

EditorConfig:

[terragrunt.hcl]
indent_size = 2
max_line_length = 120

GitHub Actions¶

VS Code:

{
  "yaml.schemas": {
    "https://json.schemastore.org/github-workflow": ".github/workflows/*.{yml,yaml}",
    "https://json.schemastore.org/github-action": "action.{yml,yaml}"
  },
  "github.actions.languageServer": {
    "enable": true
  }
}

EditorConfig:

[.github/workflows/*.{yml,yaml}]
indent_size = 2

Diagram as Code¶

Diagram-as-code tools enable version-controlled, text-based diagrams. Configure your IDE for Mermaid, PlantUML, D2, Graphviz, and Structurizr support.

VS Code Extensions:

{
  "recommendations": [
    "bierner.markdown-mermaid",
    "jebbs.plantuml",
    "terrastruct.d2",
    "joaompinto.vscode-graphviz",
    "tintinweb.graphviz-interactive-preview",
    "systemticks.c4-dsl-extension"
  ]
}

VS Code Settings:

{
  "[mermaid]": {
    "editor.formatOnSave": true,
    "editor.tabSize": 2,
    "editor.insertSpaces": true
  },
  "[plantuml]": {
    "editor.formatOnSave": false,
    "editor.tabSize": 2,
    "editor.insertSpaces": true
  },
  "[d2]": {
    "editor.formatOnSave": true,
    "editor.tabSize": 2,
    "editor.insertSpaces": true
  },
  "[dot]": {
    "editor.formatOnSave": false,
    "editor.tabSize": 2,
    "editor.insertSpaces": true
  },
  "plantuml.server": "https://www.plantuml.com/plantuml",
  "plantuml.render": "PlantUMLServer",
  "plantuml.exportFormat": "svg",
  "files.associations": {
    "*.mmd": "mermaid",
    "*.puml": "plantuml",
    "*.plantuml": "plantuml",
    "*.d2": "d2",
    "*.dot": "dot",
    "*.gv": "dot",
    "*.dsl": "structurizr"
  }
}

EditorConfig:

[*.{mmd,puml,plantuml,d2,dot,gv,dsl}]
indent_size = 2
indent_style = space

Supported Tools:

Tool	Extension	File Types	Use Case
Mermaid	`bierner.markdown-mermaid`	`.mmd`, inline in `.md`	Flowcharts, sequences, ER diagrams
PlantUML	`jebbs.plantuml`	`.puml`, `.plantuml`	UML, deployment, component diagrams
D2	`terrastruct.d2`	`.d2`	Modern architecture diagrams
Graphviz	`joaompinto.vscode-graphviz`	`.dot`, `.gv`	Dependency graphs, state machines
Structurizr	`systemticks.c4-dsl-extension`	`.dsl`	C4 model architecture

See the Diagram as Code Style Guide for comprehensive standards.

GitLab CI¶

VS Code:

{
  "yaml.schemas": {
    "https://json.schemastore.org/gitlab-ci": ".gitlab-ci.yml"
  }
}

EditorConfig:

[.gitlab-ci.yml]
indent_size = 2

Docker Compose¶

VS Code:

{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/compose-spec/compose-spec/master/schema/compose-spec.json": [
      "docker-compose*.{yml,yaml}",
      "compose*.{yml,yaml}"
    ]
  },
  "files.associations": {
    "docker-compose*.yml": "yaml",
    "compose*.yml": "yaml"
  }
}

EditorConfig:

[docker-compose*.{yml,yaml}]
indent_size = 2

HCL¶

VS Code:

{
  "files.associations": {
    ".terraformrc": "hcl",
    "terraform.rc": "hcl"
  },
  "[hcl]": {
    "editor.defaultFormatter": "hashicorp.hcl",
    "editor.formatOnSave": true,
    "editor.rulers": [120],
    "editor.tabSize": 2
  }
}

EditorConfig:

[{.terraformrc,terraform.rc}]
indent_size = 2
max_line_length = 120

Verification & Testing¶

Verify VS Code Settings¶

# Check if settings are applied
code --list-extensions | grep -E "(python|yaml|markdown|terraform|shellcheck)"

# Test Python formatting
echo "x=1" > test.py
code test.py  # Should auto-format to "x = 1"

Verify IntelliJ Settings¶

Open IntelliJ IDEA
Navigate to Settings → Editor → Code Style
Confirm Scheme is set to "Project"
Check Python tab shows 4-space indent, 100 char margin
Check YAML tab shows 2-space indent, 120 char margin

Verify EditorConfig¶

# Check EditorConfig support
editorconfig --version

# Test with sample file
cat > test.py << EOF
x=1
EOF

# Open in editor - should auto-indent with 4 spaces

Integration with Pre-commit Hooks¶

Ensure IDE settings match .pre-commit-config.yaml:

# Run pre-commit on all files
pre-commit run --all-files

# Should pass without changes if IDE formatted correctly
git status

Troubleshooting¶

VS Code Extensions Not Installing¶

# Install extensions manually
code --install-extension ms-python.black-formatter
code --install-extension hashicorp.terraform
code --install-extension redhat.vscode-yaml

IntelliJ Not Using Project Settings¶

Settings → Editor → Code Style
Ensure "Enable EditorConfig support" is checked
Verify Scheme dropdown shows "Project"
Restart IDE

EditorConfig Not Working¶

Check file is named exactly .editorconfig (lowercase, with leading dot):

ls -la .editorconfig

Ensure root = true is at the top of the file.

Format on Save Not Working¶

VS Code:

{
  "editor.formatOnSave": true,
  "[python]": {
    "editor.formatOnSave": true
  }
}

IntelliJ:

Settings → Tools → Actions on Save
Enable "Reformat code"
Enable "Optimize imports"

Conflicting Formatter Settings¶

Priority order:

Language-specific settings ([python])
General editor settings
EditorConfig settings
User global settings

Ensure language-specific settings override general settings.

Maintenance¶

Updating Settings¶

When the style guide updates:

# Pull latest changes
cd coding-style-guide
git pull origin main

# Copy updated settings
cp -r .vscode/* your-project/.vscode/
cp -r .idea/* your-project/.idea/
cp .editorconfig your-project/

Syncing with Pre-commit Hooks¶

After updating .pre-commit-config.yaml, synchronize IDE settings:

# Update Flake8 args in VS Code settings.json
# Update Black line length
# Update yamllint rules

Version Control¶

Add to version control:

git add .vscode/settings.json
git add .vscode/extensions.json
git add .idea/codeStyles/
git add .idea/inspectionProfiles/
git add .editorconfig
git commit -m "feat: add IDE settings for automatic style compliance"

Exclude from version control (optional):

# .gitignore
.idea/workspace.xml
.idea/tasks.xml
.idea/usage.statistics.xml
.idea/shelf/
.vscode/*.code-workspace

Team Onboarding¶

New Developer Setup¶

Clone repository
Open in IDE (VS Code or IntelliJ)
Install recommended extensions (prompted automatically in VS Code)
Verify auto-formatting works by editing a Python file
Run pre-commit hooks: pre-commit run --all-files

Documentation for Teams¶

## IDE Setup

This project uses automated formatting and linting. Your IDE will automatically
format code on save.

**VS Code:**
1. Install recommended extensions when prompted
2. Settings are pre-configured in `.vscode/settings.json`

**IntelliJ/PyCharm:**
1. Open project
2. IDE will use settings from `.idea/codeStyles/`
3. Enable "Actions on Save → Reformat code"

**Other Editors:**
1. Install EditorConfig plugin
2. Settings will be applied from `.editorconfig`

Reference¶

Complete File Listings¶

See the actual configuration files in this repository on GitHub:

IDE Settings

Overview¶

Quick Start¶

Option 1: Copy from This Repository¶

Option 2: Use as Git Submodule¶

Option 3: Manual Setup¶

File Structure¶

VS Code Setup¶

1. Settings File (.vscode/settings.json)¶

2. Extension Recommendations (.vscode/extensions.json)¶

IntelliJ/PyCharm Setup¶

1. Code Styles (.idea/codeStyles/Project.xml)¶

2. Inspections (.idea/inspectionProfiles/Project.xml)¶

EditorConfig Setup¶

Universal Settings (.editorconfig)¶

Language-Specific Configuration¶

Python¶

Terraform/HCL¶

YAML¶

Bash/Shell¶

TypeScript/JavaScript¶

Markdown¶

Makefile¶

Ansible¶

AWS CDK¶

Kubernetes/Helm¶

Terragrunt¶

GitHub Actions¶

Diagram as Code¶

GitLab CI¶

Docker Compose¶

HCL¶

Verification & Testing¶

Verify VS Code Settings¶

Verify IntelliJ Settings¶

Verify EditorConfig¶

Integration with Pre-commit Hooks¶

Troubleshooting¶

VS Code Extensions Not Installing¶

IntelliJ Not Using Project Settings¶

EditorConfig Not Working¶

Format on Save Not Working¶

Conflicting Formatter Settings¶

Maintenance¶

Updating Settings¶

Syncing with Pre-commit Hooks¶

Version Control¶

Team Onboarding¶

New Developer Setup¶

Documentation for Teams¶

Reference¶

Complete File Listings¶

Related Documentation¶

External Resources¶

1. Settings File (`.vscode/settings.json`)¶

2. Extension Recommendations (`.vscode/extensions.json`)¶

1. Code Styles (`.idea/codeStyles/Project.xml`)¶

2. Inspections (`.idea/inspectionProfiles/Project.xml`)¶

Universal Settings (`.editorconfig`)¶