@describe-me/core 0.6.1 → 0.8.0
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/types.d.ts +9 -0
- package/dist/types.js +7 -0
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -102,6 +102,13 @@ export interface TestRecord {
|
|
|
102
102
|
origin?: string;
|
|
103
103
|
}
|
|
104
104
|
export declare const META_KEY: "describeMe";
|
|
105
|
+
/**
|
|
106
|
+
* The Vitest tag that picks a test, a suite or a file for the docs when the
|
|
107
|
+
* plugin's `stories` is `'tagged'`. The viewer leaves it out of a test's tags.
|
|
108
|
+
*/
|
|
109
|
+
export declare const DOCS_TAG: "docs";
|
|
110
|
+
/** The Vitest tag that keeps a test, a suite or a file out of the docs, whatever `stories` says. */
|
|
111
|
+
export declare const NO_DOCS_TAG: "no-docs";
|
|
105
112
|
export type TestState = 'passed' | 'failed' | 'skipped' | 'pending';
|
|
106
113
|
export interface ManifestFrame {
|
|
107
114
|
id: string;
|
|
@@ -125,6 +132,8 @@ export interface ManifestTest {
|
|
|
125
132
|
/** suite names from outermost to innermost */
|
|
126
133
|
path: string[];
|
|
127
134
|
fullName: string;
|
|
135
|
+
/** Vitest tags, its own and inherited, when it has any. Absent in manifests written before 0.7. */
|
|
136
|
+
tags?: string[];
|
|
128
137
|
state: TestState;
|
|
129
138
|
duration?: number;
|
|
130
139
|
errors?: {
|
package/dist/types.js
CHANGED
|
@@ -21,6 +21,13 @@ export const ASSET_URL_PREFIX = 'describe-me-asset:';
|
|
|
21
21
|
*/
|
|
22
22
|
export const STYLE_URL_PREFIX = 'describe-me-style:';
|
|
23
23
|
export const META_KEY = 'describeMe';
|
|
24
|
+
/**
|
|
25
|
+
* The Vitest tag that picks a test, a suite or a file for the docs when the
|
|
26
|
+
* plugin's `stories` is `'tagged'`. The viewer leaves it out of a test's tags.
|
|
27
|
+
*/
|
|
28
|
+
export const DOCS_TAG = 'docs';
|
|
29
|
+
/** The Vitest tag that keeps a test, a suite or a file out of the docs, whatever `stories` says. */
|
|
30
|
+
export const NO_DOCS_TAG = 'no-docs';
|
|
24
31
|
/** The name adapters fall back to when a component has no usable name. */
|
|
25
32
|
export const ANONYMOUS_COMPONENT = 'Anonymous';
|
|
26
33
|
/** The `source` of every message the live preview page posts. */
|