Merge pull request #3 from qnrl/feature/codespacesSettings

Settings and extensions

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Visual Studio Code image with .NET
+
+# NOTE:
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/dotnet/.devcontainer/base.Dockerfile
+
+ARG VARIANT="6.0-bullseye-slim"
+FROM mcr.microsoft.com/vscode/devcontainers/dotnet:0-${VARIANT}

.devcontainer/container-build.ps1

@@ -0,0 +1,5 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Note:
+# This is run during container creation.

.devcontainer/container-start.ps1

@@ -0,0 +1,5 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Note:
+# This is run during container startup.

.devcontainer/devcontainer.json

@@ -1,59 +1,78 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
 {
-    "name": "Ubuntu",
-    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-    "image": "mcr.microsoft.com/devcontainers/base:jammy",
-    // Features to add to the dev container. More info: https://containers.dev/features.
-    "features": {
-        "ghcr.io/devcontainers/features/git:1": {
-			"ppa": true,
-			"version": "latest"
-		},
-        "ghcr.io/devcontainers/features/github-cli:1": {
-			"installDirectlyFromGitHubRelease": true,
-			"version": "latest"
-		},
-        "ghcr.io/devcontainers/features/powershell:1": {
-			"version": "latest",
-            "modules": "Az,PSRule.Rules.Azure"
-		},
-        "azure-cli": {
-			"version": "latest"
-		},
-		"ghcr.io/devcontainers/features/azure-cli:1": {
-			"installBicep": true,
-			"version": "latest"
-		},
-		"ghcr.io/devcontainers/features/dotnet:1": {
-			"runtimeOnly": true,
-			"version": "6"
-		}
+  "$schema": "https://raw.githubusercontent.com/devcontainers/spec/main/schemas/devContainer.schema.json",
+  "name": "PSRule Demo on Ubuntu Container",
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {
+      "ppa": true,
+      "version": "latest"
     },
-
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    // "forwardPorts": [],
-    // Use 'postCreateCommand' to run commands after the container is created.
-    // "postCreateCommand": "uname -a",
-    // Configure tool-specific properties.
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "ms-vscode.powershell",
-                "ms-azuretools.vscode-azureresourcegroups",
-                "ms-azuretools.vscode-bicep",
-                "editorconfig.editorconfig",
-                "bewhite.psrule-vscode-preview",
-                "shuworks.vscode-table-formatter",
-                "streetsidesoftware.code-spell-checker",
-                "wmaurer.change-case",
-                "esbenp.prettier-vscode",
-                "davidanson.vscode-markdownlint",
-                "vsls-contrib.codetour"
-            ]
-        }
-
+    "ghcr.io/devcontainers/features/github-cli:1": {
+      "installDirectlyFromGitHubRelease": true,
+      "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/powershell:1": {
+      "version": "latest",
+      "modules": "Az,PSRule.Rules.Azure"
     },
-    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-    "remoteUser": "vscode"
+    "azure-cli": {
+      "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/azure-cli:1": {
+      "installBicep": true,
+      "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/dotnet:1": {
+      "runtimeOnly": true,
+      "version": "6"
+    }
+  },
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "uname -a",
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-azuretools.vscode-docker",
+        "ms-vscode.powershell",
+        "bewhite.psrule-vscode-preview",
+        "msazurermtools.azurerm-vscode-tools",
+        "ms-azuretools.vscode-bicep",
+        "ms-azure-devops.azure-pipelines",
+        "shuworks.vscode-table-formatter",
+        "streetsidesoftware.code-spell-checker",
+        "wmaurer.change-case",
+        "esbenp.prettier-vscode",
+        "davidanson.vscode-markdownlint",
+        "vsls-contrib.codetour",
+        "ms-azuretools.vscode-azureresourcegroups",
+        "editorconfig.editorconfig"
+      ],
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "pwsh",
+        "terminal.integrated.profiles.linux": {
+          "pwsh": {
+            "path": "/opt/microsoft/powershell/7/pwsh"
+          }
+        },
+        "PSRule.notifications.showPowerShellExtension": false,
+        "PSRule.notifications.showChannelUpgrade": false
+      }
+    }
+  },
+  "onCreateCommand": "/opt/microsoft/powershell/7/pwsh -f .devcontainer/container-build.ps1",
+  "postStartCommand": "/opt/microsoft/powershell/7/pwsh -f .devcontainer/container-start.ps1",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "6.0-bullseye-slim"
+    }
+  },
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  "remoteUser": "vscode"
 }

.gitignore

@@ -15,7 +15,6 @@ packages/
 Tools/NuGet/
 updatablehelp/
 xhtml/
-**/settings.json
 StaleContentReport.*.csv
 .vscode/styles
 .vale/

.vscode/extensions.json

@@ -2,13 +2,19 @@
   // See https://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
   "recommendations": [
+    "ms-azuretools.vscode-docker",
     "ms-vscode.powershell",
     "bewhite.psrule-vscode-preview",
+    "msazurermtools.azurerm-vscode-tools",
+    "ms-azuretools.vscode-bicep",
+    "ms-azure-devops.azure-pipelines",
     "shuworks.vscode-table-formatter",
     "streetsidesoftware.code-spell-checker",
     "wmaurer.change-case",
     "esbenp.prettier-vscode",
     "davidanson.vscode-markdownlint",
-    "vsls-contrib.codetour"
+    "vsls-contrib.codetour",
+    "ms-azuretools.vscode-azureresourcegroups",
+    "editorconfig.editorconfig"
   ]
 }

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "workbench.colorTheme": "GitHub Dark",
+  "redhat.telemetry.enabled": true,
+  "powershell.integratedConsole.showOnStartup": false,
+  "powershell.integratedConsole.focusConsoleOnExecute": false,
+  "files.associations": {
+    "**/.pipelines/**/*.yaml": "azure-pipelines"
+  },
+  "yaml.format.singleQuote": true,
+  "files.insertFinalNewline": true,
+  "editor.insertSpaces": true,
+  "editor.detectIndentation": false,
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2,
+  "[powershell]": {
+    "editor.formatOnSave": false,
+    "editor.tabSize": 4
+  },
+}

.vscode/tasks.json

@@ -20,11 +20,6 @@
         "kind": "build",
         "isDefault": true
       },
-      "inputPath": "examples/",
-      "outcome": [
-        "Fail",
-        "Error",
-      ]
     }
   ]
 }

cspell.config.yaml

@@ -2,6 +2,7 @@ version: "0.2"
 ignorePaths:
   - .vscode/
   - devcontainer.json
+  - '**/settings.json'
   - cspell.config.yaml
 dictionaryDefinitions: []
 words:

ps-rule.yaml

@@ -1,10 +1,48 @@
-## YAML: Enable expansion for Bicep source files.
+#
+# PSRule for Azure configuration
+#
+
+# Please see the documentation for all configuration options:
+# https://aka.ms/ps-rule/options
+# https://aka.ms/ps-rule-azure/options
+
+# Configure binding for local rules.
+binding:
+  preferTargetInfo: true
+  targetType:
+  - type
+  - resourceType
+
+requires:
+  PSRule: '@pre >=2.9.0'
+  PSRule.Rules.Azure: '@pre >=1.27.3'
+
 configuration:
+  # Enable automatic expansion of JSON parameter files.
+  AZURE_PARAMETER_FILE_EXPANSION: true
+
+  # Enable automatic expansion of Azure Bicep source files.
   AZURE_BICEP_FILE_EXPANSION: true
+
+  # Configures the number of seconds to wait for build Bicep files.
+  AZURE_BICEP_FILE_EXPANSION_TIMEOUT: 10
+
+  # Enable automatic expansion of Bicep parameter files.
   AZURE_BICEP_PARAMS_FILE_EXPANSION: true
 
+    # Enable Bicep CLI checks.
+  AZURE_BICEP_CHECK_TOOL: true
+
+  # Configure the minimum version of the Bicep CLI.
+  AZURE_BICEP_MINIMUM_VERSION: '0.18.4'
+
 input:
   pathIgnore:
+  # Ignore other files in the repository.
+  - '.vscode/'
+  - '.github/'
+  - '*.md'
+
   # Exclude bicepconfig.json
   - 'bicepconfig.json'
 
@@ -16,9 +54,6 @@ include:
   module:
     - PSRule.Rules.Azure
 
-requires:
-  PSRule.Rules.Azure: 'v1.27.3'
-
 execution:
   aliasReference: Warn
   duplicateResourceId: Error