@doccov/spec 0.24.0 → 0.24.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
declare const SCHEMA_VERSION = "1.0.0";
|
|
2
|
+
declare const SCHEMA_URL = "https://unpkg.com/@doccov/spec/schemas/v1.0.0/doccov.schema.json";
|
|
1
3
|
type DriftType = "param-mismatch" | "param-type-mismatch" | "return-type-mismatch" | "generic-constraint-mismatch" | "optionality-mismatch" | "deprecated-mismatch" | "visibility-mismatch" | "async-mismatch" | "property-type-drift" | "example-drift" | "example-syntax-error" | "example-runtime-error" | "example-assertion-failed" | "broken-link";
|
|
2
4
|
type DriftCategory = "structural" | "semantic" | "example";
|
|
3
5
|
declare const DRIFT_CATEGORIES: Record<DriftType, DriftCategory>;
|
|
@@ -27,7 +29,7 @@ type ExampleAnalysis = {
|
|
|
27
29
|
runtimeDrifts?: ExampleRuntimeDrift[];
|
|
28
30
|
};
|
|
29
31
|
type MissingDocRule = "description" | "params" | "returns" | "examples" | "throws";
|
|
30
|
-
type DocCovSpecVersion = "1.0
|
|
32
|
+
type DocCovSpecVersion = "0.1.0";
|
|
31
33
|
type DocCovSpec = {
|
|
32
34
|
$schema?: string;
|
|
33
35
|
doccov: DocCovSpecVersion;
|
|
@@ -79,8 +81,6 @@ type ExportAnalysis = {
|
|
|
79
81
|
/** Example validation results */
|
|
80
82
|
examples?: ExampleAnalysis;
|
|
81
83
|
};
|
|
82
|
-
declare const SCHEMA_VERSION = "1.0.0";
|
|
83
|
-
declare const SCHEMA_URL = "https://unpkg.com/@doccov/spec/schemas/v1.0.0/doccov.schema.json";
|
|
84
84
|
type DocCovSchemaVersion = "1.0.0" | "latest";
|
|
85
85
|
declare const LATEST_VERSION: DocCovSchemaVersion;
|
|
86
86
|
type DocCovSpecError = {
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
// src/constants.ts
|
|
2
|
+
var SCHEMA_VERSION = "1.0.0";
|
|
3
|
+
var SCHEMA_URL = "https://unpkg.com/@doccov/spec/schemas/v1.0.0/doccov.schema.json";
|
|
1
4
|
// src/types.ts
|
|
2
5
|
var DRIFT_CATEGORIES = {
|
|
3
6
|
"param-mismatch": "structural",
|
|
@@ -25,9 +28,6 @@ var DRIFT_CATEGORY_DESCRIPTIONS = {
|
|
|
25
28
|
semantic: "Deprecation, visibility, or reference issues",
|
|
26
29
|
example: "@example code has errors or doesn't work correctly"
|
|
27
30
|
};
|
|
28
|
-
// src/constants.ts
|
|
29
|
-
var SCHEMA_VERSION = "1.0.0";
|
|
30
|
-
var SCHEMA_URL = "https://unpkg.com/@doccov/spec/schemas/v1.0.0/doccov.schema.json";
|
|
31
31
|
// src/validate.ts
|
|
32
32
|
import Ajv from "ajv/dist/2020.js";
|
|
33
33
|
import addFormats from "ajv-formats";
|