feat:

kamil-mrzyglod · kamil-mrzyglod · commit b6fdbce308a3 · 2024-04-19T13:16:35.000+02:00
diff --git a/Bicep.Docs.Tests/BasicTests.cs b/Bicep.Docs.Tests/BasicTests.cs
@@ -5,6 +5,12 @@ public class BasicTests
     [Test]
     public void Basic_WhenBicepFileIsProvided_DocumentationShouldBeGenerated()
     {
-        Program.Main(["--template", "templates/basic.bicep"]);
+        Program.Main(["--template", "templates/basic/basic.bicep"]);
+    }
+
+    [Test]
+    public void Basic_WhenJsonFileIsProvided_DocumentationShouldBeGenerated()
+    {
+        Program.Main(["--template", "templates/json/basic.json"]);
     }
 }
diff --git a/Bicep.Docs.Tests/templates/basic/basic.bicep b/Bicep.Docs.Tests/templates/basic/basic.bicep
@@ -1,5 +1,5 @@
 metadata BicepDocs = {
-  examplesDirectory: 'templates/examples'
+  examplesDirectory: 'templates/basic/examples'
 }
 
 @description('Name of the Azure Container Registry')
diff --git a/Bicep.Docs.Tests/templates/basic/examples/example1.bicep b/Bicep.Docs.Tests/templates/basic/examples/example1.bicep
diff --git a/Bicep.Docs.Tests/templates/json/basic.json b/Bicep.Docs.Tests/templates/json/basic.json
@@ -0,0 +1,87 @@
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "contentVersion": "1.0.0.0",
+  "metadata": {
+    "_generator": {
+      "name": "bicep",
+      "version": "0.26.54.24096",
+      "templateHash": "11197120595624797346"
+    },
+    "BicepDocs": {
+      "examplesDirectory": "templates/json/examples"
+    }
+  },
+  "parameters": {
+    "parAcrName": {
+      "type": "string",
+      "metadata": {
+        "description": "Name of the Azure Container Registry"
+      }
+    },
+    "parLocation": {
+      "type": "string",
+      "defaultValue": "[resourceGroup().location]",
+      "metadata": {
+        "description": "Location of the Azure Container Registry"
+      }
+    },
+    "parSku": {
+      "type": "string",
+      "defaultValue": "Basic",
+      "allowedValues": [
+        "Basic",
+        "Standard",
+        "Premium"
+      ],
+      "metadata": {
+        "description": "The SKU of the Azure Container Registry"
+      }
+    },
+    "parSqlName": {
+      "type": "string",
+      "metadata": {
+        "description": "Name of the Azure SQL Server"
+      }
+    },
+    "parSqlAdminLogin": {
+      "type": "securestring",
+      "metadata": {
+        "description": "Password for the Azure SQL Server admin user"
+      }
+    }
+  },
+  "resources": [
+    {
+      "type": "Microsoft.ContainerRegistry/registries",
+      "apiVersion": "2023-07-01",
+      "name": "[parameters('parAcrName')]",
+      "location": "[parameters('parLocation')]",
+      "sku": {
+        "name": "[parameters('parSku')]"
+      },
+      "properties": {
+        "adminUserEnabled": false
+      }
+    },
+    {
+      "type": "Microsoft.Sql/servers",
+      "apiVersion": "2021-11-01",
+      "name": "[parameters('parSqlName')]",
+      "location": "[parameters('parLocation')]",
+      "properties": {
+        "administratorLogin": "admin",
+        "administratorLoginPassword": "[parameters('parSqlAdminLogin')]"
+      }
+    }
+  ],
+  "outputs": {
+    "acrId": {
+      "type": "string",
+      "value": "[resourceId('Microsoft.ContainerRegistry/registries', parameters('parAcrName'))]"
+    },
+    "sqlId": {
+      "type": "string",
+      "value": "[resourceId('Microsoft.Sql/servers', parameters('parSqlName'))]"
+    }
+  }
+}
diff --git a/Bicep.Docs.Tests/templates/json/examples/example1.bicep b/Bicep.Docs.Tests/templates/json/examples/example1.bicep
@@ -0,0 +1,11 @@
+param parLocation string = 'polandcentral'
+
+module basic '../basic.bicep' = {
+  name: 'basic'
+  params: {
+    parAcrName: 'bicepdocsacr' 
+    parSqlAdminLogin: 'bicepdocsadmin'
+    parSqlName: 'bicepdocssql'
+    parLocation: parLocation
+  }
+}
diff --git a/Bicep.Docs/Program.cs b/Bicep.Docs/Program.cs
@@ -15,7 +15,7 @@ public static void Main(string[] args)
                 if (File.Exists(o.TemplatePath))
                 {
                     var file = new FileInfo(o.TemplatePath);
-                    var rawTemplate = BicepCompiler.Compile(file, CancellationToken.None);
+                    var rawTemplate = file.Extension == ".json" ? File.ReadAllText(o.TemplatePath) : BicepCompiler.Compile(file, CancellationToken.None);
 
 #if DEBUG
                     Console.WriteLine(rawTemplate);

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,12 @@ public class BasicTests`
`5`	`5`	`[Test]`
`6`	`6`	`public void Basic_WhenBicepFileIsProvided_DocumentationShouldBeGenerated()`
`7`	`7`	`{`
`8`		`- Program.Main(["--template", "templates/basic.bicep"]);`
	`8`	`+ Program.Main(["--template", "templates/basic/basic.bicep"]);`
	`9`	`+ }`
	`10`	`+`
	`11`	`+ [Test]`
	`12`	`+ public void Basic_WhenJsonFileIsProvided_DocumentationShouldBeGenerated()`
	`13`	`+ {`
	`14`	`+ Program.Main(["--template", "templates/json/basic.json"]);`
`9`	`15`	`}`
`10`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`metadata BicepDocs = {`
`2`		`- examplesDirectory: 'templates/examples'`
	`2`	`+ examplesDirectory: 'templates/basic/examples'`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`@description('Name of the Azure Container Registry')`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public static void Main(string[] args)`
`15`	`15`	`if (File.Exists(o.TemplatePath))`
`16`	`16`	`{`
`17`	`17`	`var file = new FileInfo(o.TemplatePath);`
`18`		`- var rawTemplate = BicepCompiler.Compile(file, CancellationToken.None);`
	`18`	`+ var rawTemplate = file.Extension == ".json" ? File.ReadAllText(o.TemplatePath) : BicepCompiler.Compile(file, CancellationToken.None);`
`19`	`19`
`20`	`20`	`#if DEBUG`
`21`	`21`	`Console.WriteLine(rawTemplate);`