add auto-generated warning in generated docs; update unit test (#140)

* add auto-generated warning in generated docs; update unit test * update test result * update test result on windows
kcl-lang · Aug 21, 2023 · 8fb20d7 · 8fb20d7
1 parent 55c6ba1
commit 8fb20d7
Show file tree

Hide file tree

Showing 23 changed files with 43 additions and 2 deletions.
diff --git a/pkg/tools/gen/gendoc_test.go b/pkg/tools/gen/gendoc_test.go
@@ -55,6 +55,8 @@ name of the person
 ## Source Files
 
 - [models.Person](models/person.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
 `,
 			expectWindows: `## Schema Person
 
@@ -72,6 +74,8 @@ name of the person
 ## Source Files
 
 - [models.Person](models\person.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
 `,
 		},
 	}
@@ -202,6 +206,9 @@ func CompareDir(a string, b string) error {
 				)
 			}
 		}
+		if len(linesA) < len(linesB) {
+			return fmt.Errorf("file content different, contains more lines in file %s:%v - %v:\n%s", aPath, len(linesA), len(linesB), strings.Join(linesB[len(linesA):], "\n"))
+		}
 	}
 	return nil
 }

diff --git a/pkg/tools/gen/templates/doc/packageDoc.gotmpl b/pkg/tools/gen/templates/doc/packageDoc.gotmpl
@@ -6,5 +6,5 @@
 {{range $index, $schema := sortSchemas .Schemas}}- [{{$schema.KclExtensions.XKclModelType.Type}}]({{$schema.KclExtensions.XKclModelType.Type}}.md)
 
 {{end -}}
-
-{{- end}}
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
+{{end}}
diff --git a/pkg/tools/gen/templates/doc/schemaDoc.gotmpl b/pkg/tools/gen/templates/doc/schemaDoc.gotmpl
@@ -18,4 +18,6 @@
 ## Source Files
 
 - [{{fullTypeName . }}]({{sourcePath .}})
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
 {{end}}
diff --git a/pkg/tools/gen/testdata/doc/pkg/unixlike/md/Container.md b/pkg/tools/gen/testdata/doc/pkg/unixlike/md/Container.md
@@ -14,3 +14,5 @@ The name of the long-running container.
 ## Source Files
 
 - [Container](container.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/unixlike/md/Server.md b/pkg/tools/gen/testdata/doc/pkg/unixlike/md/Server.md
@@ -100,3 +100,5 @@ See also: kusion_models/core/v1/workload_metadata.k.
 ## Source Files
 
 - [Server](server.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/unixlike/md/index.md b/pkg/tools/gen/testdata/doc/pkg/unixlike/md/index.md
@@ -6,3 +6,4 @@
 
 - [Server](Server.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/unixlike/md/k8s/Deployment.md b/pkg/tools/gen/testdata/doc/pkg/unixlike/md/k8s/Deployment.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [k8s.Deployment](k8s/deployment.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/unixlike/md/k8s/index.md b/pkg/tools/gen/testdata/doc/pkg/unixlike/md/k8s/index.md
@@ -4,3 +4,4 @@
 
 - [Deployment](Deployment.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/windows/md/Container.md b/pkg/tools/gen/testdata/doc/pkg/windows/md/Container.md
@@ -14,3 +14,5 @@ The name of the long-running container.
 ## Source Files
 
 - [Container](container.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/windows/md/Server.md b/pkg/tools/gen/testdata/doc/pkg/windows/md/Server.md
@@ -100,3 +100,5 @@ See also: kusion_models/core/v1/workload_metadata.k.
 ## Source Files
 
 - [Server](server.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/windows/md/index.md b/pkg/tools/gen/testdata/doc/pkg/windows/md/index.md
@@ -6,3 +6,4 @@
 
 - [Server](Server.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/windows/md/k8s/Deployment.md b/pkg/tools/gen/testdata/doc/pkg/windows/md/k8s/Deployment.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [k8s.Deployment](k8s\deployment.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/pkg/windows/md/k8s/index.md b/pkg/tools/gen/testdata/doc/pkg/windows/md/k8s/index.md
@@ -4,3 +4,4 @@
 
 - [Deployment](Deployment.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/unixlike/md/A.md b/pkg/tools/gen/testdata/doc/reimport/unixlike/md/A.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [A](a.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/unixlike/md/B.md b/pkg/tools/gen/testdata/doc/reimport/unixlike/md/B.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [B](b.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/unixlike/md/index.md b/pkg/tools/gen/testdata/doc/reimport/unixlike/md/index.md
@@ -6,3 +6,4 @@
 
 - [B](B.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/unixlike/md/k8s/Deployment.md b/pkg/tools/gen/testdata/doc/reimport/unixlike/md/k8s/Deployment.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [k8s.Deployment](k8s/deployment.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/unixlike/md/k8s/index.md b/pkg/tools/gen/testdata/doc/reimport/unixlike/md/k8s/index.md
@@ -4,3 +4,4 @@
 
 - [Deployment](Deployment.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/windows/md/A.md b/pkg/tools/gen/testdata/doc/reimport/windows/md/A.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [A](a.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/windows/md/B.md b/pkg/tools/gen/testdata/doc/reimport/windows/md/B.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [B](b.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/windows/md/index.md b/pkg/tools/gen/testdata/doc/reimport/windows/md/index.md
@@ -6,3 +6,4 @@
 
 - [B](B.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/windows/md/k8s/Deployment.md b/pkg/tools/gen/testdata/doc/reimport/windows/md/k8s/Deployment.md
@@ -12,3 +12,5 @@
 ## Source Files
 
 - [k8s.Deployment](k8s\deployment.k)
+
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
diff --git a/pkg/tools/gen/testdata/doc/reimport/windows/md/k8s/index.md b/pkg/tools/gen/testdata/doc/reimport/windows/md/k8s/index.md
@@ -4,3 +4,4 @@
 
 - [Deployment](Deployment.md)
 
+<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,3 +14,5 @@ The name of the long-running container.
		## Source Files

		- [Container](container.k)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -100,3 +100,5 @@ See also: kusion_models/core/v1/workload_metadata.k.
		## Source Files

		- [Server](server.k)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@

		- [Server](Server.md)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,5 @@
		## Source Files

		- [k8s.Deployment](k8s/deployment.k)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,3 +4,4 @@

		- [Deployment](Deployment.md)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@

		- [B](B.md)

		<!-- Auto generated by kcl-doc tool, please do not edit. -->