Formatting updates for yaml and markdown (#2784)

Prettier supports .yml and .md files nicely these days, so there really
isn't a need for exceptions on those anymore. This removes a couple
folders from our .prettierignore and fixes the resulting formatting to
confirm to spec.

These are formatting only changes, no behavior changes (other than
removing folders from the ignore file).

Author: swernli

.ado/publish.yml

@@ -1,19 +1,20 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug, needs triage
-assignees: ''
+assignees: ""
 ---
 
 **Describe the bug**
 
-Describe what the unexpected behavior or issue is. 
+Describe what the unexpected behavior or issue is.
 Please file a single issue per bug instead of enumerating multiple items.
 
 **To Reproduce**
 
 Steps to reproduce the behavior:
+
 1. Open or go to '...'
 2. Type or click on '....'
 3. See error

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement, needs triage
-assignees: ''
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@
 
 This repo contains the Microsoft Quantum Development Kit (QDK), which provides tooling for the Q# language. Q# is an open-source programming language designed for developing and running quantum algorithms. This repo is publicly available at https://github.com/microsoft/qsharp .
 
-
 ## Architecture
 
 All internal source code for the compiler and related tooling has been moved under the `source/` directory at the repository root. This does not include Q# libraries (`library/`), samples (`samples/`), katas (`katas/`), or any standard files and folders typically found at the root of a repository (such as configuration, documentation, or build scripts).
@@ -47,6 +46,7 @@ Most of the core components are implemented in Rust. These components are packag
 - **wasm/**: WebAssembly bindings for core components
 
 **Build & Release**
+
 - **docker/**: Docker container configurations
 
 **Python**
@@ -101,5 +101,5 @@ Most of the core components are implemented in Rust. These components are packag
 - `npm test` from the `vscode/` directory runs the integration tests.
   - `npm test -- --suite=language-service`: Run only the `language-service` test suite
 - Tests use the VS Code for Web testing framework (`@vscode/test-web`), which uses `playwright` under the covers to automate headless Chrome.
-- `mocha` interface is used to declare tests, `chai` for asserts. No mocking library is used. Do *not* add dependencies to the test suite.
+- `mocha` interface is used to declare tests, `chai` for asserts. No mocking library is used. Do _not_ add dependencies to the test suite.
 - Tests run in the real VS Code environment, in the extension host, which means they can directly interact with the VS Code API.

.github/copilot-instructions.md

@@ -4,8 +4,8 @@ on:
   pull_request:
     branches:
       - main
-      - 'feature/**'
-      - 'release/**'
+      - "feature/**"
+      - "release/**"
   merge_group:
   workflow_dispatch:
 
@@ -187,7 +187,16 @@ jobs:
 
   status-check:
     name: Status Check
-    needs: [format, clippy, web-check, build, unit-tests, format-qsc, integration-tests]
+    needs:
+      [
+        format,
+        clippy,
+        web-check,
+        build,
+        unit-tests,
+        format-qsc,
+        integration-tests,
+      ]
     runs-on: ubuntu-latest
     if: failure()
     steps:

.github/workflows/ci.yml

@@ -2,12 +2,12 @@ name: DevSkim
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [main]
   merge_group:
   workflow_dispatch:
   schedule:
     # set schedule to run at 2AM PT on Saturdays
-    - cron: '0 9 * * Sat'
+    - cron: "0 9 * * Sat"
 
 jobs:
   lint:

.github/workflows/devskim.yml

@@ -1,37 +1,39 @@
 name: fuzz
 run-name: Fuzz
 env:
-  OWNER_RDPATH: ./source                      # Rel path to the dir that contains the fuzzing infra (contains "fuzz" dir).
-  DURATION_SEC: 7200                          # Fuzzing run duration in seconds.
-  STDERR_LOG_FNAME: fuzz.stderr.log           # File name to redirect the fuzzing run's stderr to.
-  TMIN_LOG_FNAME: fuzz.tmin.log               # File name to redirect the fuzzing input minimization log to.
-  GH_ISSUE_TEMPLATE_RFPATH: .github/ISSUE_TEMPLATE/fuzz_bug_report.md
-                                              # GitHub issue template rel file path.
-  ARTIFACTS_RDPATH: fuzz/artifacts            # Fuzzing artifacts rel dir path.
-  SEEDS_RDPATH: fuzz/seed_inputs              # Fuzzing seed inputs rel dir path.
-  SEEDS_FNAME: list.txt                       # Fuzzing seed inputs list file name.
+  OWNER_RDPATH: ./source # Rel path to the dir that contains the fuzzing infra (contains "fuzz" dir).
+  DURATION_SEC: 7200 # Fuzzing run duration in seconds.
+  STDERR_LOG_FNAME: fuzz.stderr.log # File name to redirect the fuzzing run's stderr to.
+  TMIN_LOG_FNAME: fuzz.tmin.log # File name to redirect the fuzzing input minimization log to.
+  GH_ISSUE_TEMPLATE_RFPATH:
+    .github/ISSUE_TEMPLATE/fuzz_bug_report.md
+    # GitHub issue template rel file path.
+  ARTIFACTS_RDPATH: fuzz/artifacts # Fuzzing artifacts rel dir path.
+  SEEDS_RDPATH: fuzz/seed_inputs # Fuzzing seed inputs rel dir path.
+  SEEDS_FNAME: list.txt # Fuzzing seed inputs list file name.
 on:
-  workflow_dispatch:                          # Manual runs.
+  workflow_dispatch: # Manual runs.
   push:
     branches:
-      - main                                  # Development runs against main branch.
+      - main # Development runs against main branch.
     paths:
-      - 'source/compiler/**'                  # Run if the compiler was changed.
-      - 'source/fuzz/**'                      # Run if the fuzzing infra was changed.
-      - '.github/ISSUE_TEMPLATE/fuzz_bug_report.md'
-                                              # Run if the GitHub issue template was changed.
-      - '.github/workflows/fuzz.yml'          # Run if the workflow itself was changed.
-      - '!source/compiler/qsc_eval/**'        # Exclude the qsc_eval dir.
-      - '!source/compiler/qsc_codegen/**'     # Exclude the qsc_codegen dir.
+      - "source/compiler/**" # Run if the compiler was changed.
+      - "source/fuzz/**" # Run if the fuzzing infra was changed.
+      - ".github/ISSUE_TEMPLATE/fuzz_bug_report.md"
+        # Run if the GitHub issue template was changed.
+      - ".github/workflows/fuzz.yml" # Run if the workflow itself was changed.
+      - "!source/compiler/qsc_eval/**" # Exclude the qsc_eval dir.
+      - "!source/compiler/qsc_codegen/**" # Exclude the qsc_codegen dir.
 
 jobs:
   fuzz:
     name: Fuzzing
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]                   # Fuzzing is not supported on Win. The macos is temporarily removed
-                                              # because of low availability.
+        os:
+          [ubuntu-latest] # Fuzzing is not supported on Win. The macos is temporarily removed
+          # because of low availability.
         target_name: [qsharp, qasm]
 
     runs-on: ${{ matrix.os }}
@@ -211,7 +213,7 @@ jobs:
         if: failure()
         uses: JasonEtco/create-an-issue@v2
         env:
-          GITHUB_TOKEN:     ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           WORKFLOW_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
         with:
           filename: ${{ env.GH_ISSUE_TEMPLATE_RFPATH }}

.github/workflows/fuzz.yml

@@ -42,10 +42,10 @@ jobs:
           components: ${{ env.RUST_TOOLCHAIN_COMPONENTS }}
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.11'
+          python-version: "3.11"
       - uses: actions/setup-node@v3
         with:
-          node-version: '22.14.0'
+          node-version: "22.14.0"
       - uses: Swatinem/rust-cache@v2
       - name: Prereqs
         run: python ./prereqs.py --install

.github/workflows/publish-playground.yml

@@ -1,9 +1,7 @@
 package-lock.json
 __pycache__/
-.ado/
 .cargo/
 .devcontainer/
-.github/
 .pytest_cache/
 .vscode/
 .vscode-test-web/

.prettierignore

@@ -39,5 +39,9 @@
     "[typescriptreact]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode",
       "editor.formatOnSave": true
+    },
+    "[yaml]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode",
+      "editor.formatOnSave": true
     }
   }