@codemod/arm-detect-prod-debug-settings

Disable production-unsafe debug settings in Azure Resource Manager (ARM) templates and embedded ARM resource objects.

Installation

bash
Copy
# Install from registry
npx codemod@latest @codemod/arm-detect-prod-debug-settings

# Or run locally
npx codemod@latest workflow run -w .

Usage

This codemod rewrites ARM deployment templates and embedded ARM object literals when they contain resource-template markers such as $schema, resources, apiVersion, or ARM resource type values.

It makes these source rewrites:

• debugSetting.detailLevel -> "none"
• debugSetting.enabled -> false
• detailedErrorLoggingEnabled -> false
• failedRequestTracingEnabled -> false
• httpLoggingEnabled -> false
• remoteDebuggingEnabled -> false
• requestTracingEnabled -> false

Targeted files:

• .json ARM templates
• .js, .mjs, .cjs, .ts, .jsx, .tsx files that embed ARM template/resource objects

Preserve/no-op cases:

• Non-ARM JSON or object literals with similarly named keys stay unchanged
• Settings already at safe values stay unchanged
• Unrelated local variables such as const requestTracingEnabled = true stay unchanged

Example:

json
Copy
{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2022-09-01",
      "properties": {
        "debugSetting": {
          "detailLevel": "requestContent,responseContent",
          "enabled": true
        }
      }
    }
  ]
}

becomes:

json
Copy
{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2022-09-01",
      "properties": {
        "debugSetting": {
          "detailLevel": "none",
          "enabled": false
        }
      }
    }
  ]
}

Development

bash
Copy
# Test the transformation
pnpm test

# Validate the workflow
npx codemod@latest workflow validate -w .

# Publish to registry
npx codemod@latest login
npx codemod@latest publish

License

MIT