Skip to content

README.md

Latest commit

 

History

History
140 lines (88 loc) · 4.4 KB

README.md

File metadata and controls

140 lines (88 loc) · 4.4 KB

DevContainer

This DevContainer is intended to simplify local development and ensure all contributors are using the same local dependencies to build and run this solution.

Git

A small amount of configuration may be required when setting up your DevContainer for the first time.

Git config

Remote-Containers should copy your gitconfig settings from your local machine, but you may be asked to configure your global git settings when developing in the container.

git config --global user.name "Your Name"
git config --global user.email "your.email@address"

Configuring SSH

For SSH to work with your local SSH keys in the DevContainer, you must configure an SSH agent using these instructions.

Note: If you are running Windows as your host OS and launch VS Code from the start menu or PowerShell, use the Windows instructions (even if you're using WSL/WSL2 to run a Linux terminal for git)

Project Configuration

package.json

The project uses a package.json file to define scripts and dependencies for development tasks. This file enables consistent command execution across different environments and simplifies common tasks through npm scripts.

Key npm scripts available:

# Install dependencies
npm install

# Run all linters
npm run lint

# Fix common linting issues
npm run lint-fix

# Run only markdown linting
npm run mdlint

# Fix markdown linting issues
npm run mdlint-fix

# Run spell check
npm run cspell

# Run security scanning on changed folders only
npm run checkov-changes

# Run security scanning on all folders
npm run checkov-all

# Check for language-specific links
npm run link-check

# Fix language-specific links
npm run link-fix

These scripts are defined in the package.json file in the project root and provide shortcuts to the underlying tools configured specifically for this project.

Linting

Run ALL linters (when running in the Dev Container, use the special -devcontainer scripts versions to prevent Bicep linter from generating .JSON files in repo):

npm run lint-devcontainer

To fix basic linting issues, run the following:

npm run lint-fix-devcontainer

For detailed information about our CI/CD lint configuration and available linters, see the Azure Pipelines documentation.

Markdown linting

The linter run as part of PR validation is installed and configured in the DevContainer, making it possible to check your markdown before committing & PR.

npm run mdlint

To fix basic markdown linting issues, run the following:

npm run mdlint-fix

NOTE

Because not all rules include fix information when reporting errors, fixes may overlap, and not all errors are fixable, fix will not usually address all errors.

Spell checking

Cspell checker runs as part of PR validation and is installed and configured in the DevContainer, which makes it possible to check your language basics before committing & PR.

npm run cspell

NOTE

If cspell detects an unknown word which should be ignored, add the word to the excluded word dictionary file cspell-dictionary.txt. If you think it's a common computing word, you can make a PR against the cspell software terms dictionary

Security Scanning

The project includes integration with Checkov, a static code analysis tool for infrastructure-as-code (IaC) that helps identify security and compliance issues.

Two scanning modes are available:

# Scan only folders with detected changes
npm run checkov-changes

# Scan all folders in the repository
npm run checkov-all

The scanning process:

  1. Detects which folders have changed (or includes all folders with the -IncludeIaCFolders flag)
  2. Runs Checkov security scanner on those folders
  3. Aggregates results into a JUnit XML report file at ./checkov-results/code-analysis.xml

This helps identify potential security issues early in the development process.

Updates

If you need to change this DevContainer, please ensure that the changes maintain consistency with the production build pipeline.

Codespaces

This DevContainer configuration enables you to use GitHub Codespaces instead of editing the docs locally in VS Code.