@argos-ci/util 0.0.1-alpha.182 → 0.0.1-alpha.187

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/browser.d.ts CHANGED
@@ -1,12 +1,22 @@
1
1
  type ScreenshotMetadata = {
2
- url: string;
3
- viewport: {
2
+ url?: string;
3
+ viewport?: {
4
4
  width: number;
5
5
  height: number;
6
6
  };
7
- colorScheme: "light" | "dark";
8
- mediaType: "screen" | "print";
9
- browser: {
7
+ colorScheme?: "light" | "dark";
8
+ mediaType?: "screen" | "print";
9
+ test: {
10
+ id?: string;
11
+ title: string;
12
+ titlePath: string[];
13
+ location?: {
14
+ file: string;
15
+ line: number;
16
+ column: number;
17
+ };
18
+ } | null;
19
+ browser?: {
10
20
  name: string;
11
21
  version: string;
12
22
  };
package/dist/index.d.ts CHANGED
@@ -1,16 +1,30 @@
1
+ /**
2
+ * Get the top level of the git repository.
3
+ */
4
+ declare function getGitRepositoryPath(): Promise<string>;
1
5
  /**
2
6
  * Read the version from a package.json file.
3
7
  */
4
8
  declare function readVersionFromPackage(pkgPath: string): Promise<string>;
5
9
  type ScreenshotMetadata = {
6
- url: string;
7
- viewport: {
10
+ url?: string;
11
+ viewport?: {
8
12
  width: number;
9
13
  height: number;
10
14
  };
11
- colorScheme: "light" | "dark";
12
- mediaType: "screen" | "print";
13
- browser: {
15
+ colorScheme?: "light" | "dark";
16
+ mediaType?: "screen" | "print";
17
+ test: {
18
+ id?: string;
19
+ title: string;
20
+ titlePath: string[];
21
+ location?: {
22
+ file: string;
23
+ line: number;
24
+ column: number;
25
+ };
26
+ } | null;
27
+ browser?: {
14
28
  name: string;
15
29
  version: string;
16
30
  };
@@ -42,4 +56,4 @@ declare function readMetadata(screenshotPath: string): Promise<ScreenshotMetadat
42
56
  declare function getScreenshotName(name: string, options?: {
43
57
  viewportWidth?: number;
44
58
  }): string;
45
- export { readVersionFromPackage, ScreenshotMetadata, getMetadataPath, writeMetadata, readMetadata, getScreenshotName };
59
+ export { getGitRepositoryPath, readVersionFromPackage, ScreenshotMetadata, getMetadataPath, writeMetadata, readMetadata, getScreenshotName };
package/dist/index.mjs CHANGED
@@ -1,5 +1,28 @@
1
+ import { exec } from 'node:child_process';
1
2
  import { readFile, writeFile } from 'node:fs/promises';
2
3
 
4
+ let cached;
5
+ /**
6
+ * Get the top level of the git repository.
7
+ */ function getGitRepositoryPath() {
8
+ if (!cached) {
9
+ cached = new Promise((resolve, reject)=>{
10
+ exec("git rev-parse --show-toplevel", (error, stdout, stderr)=>{
11
+ if (error) {
12
+ reject(error);
13
+ return;
14
+ }
15
+ if (stderr) {
16
+ reject(stderr);
17
+ return;
18
+ }
19
+ resolve(stdout.trim());
20
+ });
21
+ });
22
+ }
23
+ return cached;
24
+ }
25
+
3
26
  // Cache the version to avoid reading the file multiple times.
4
27
  const versionCache = new Map();
5
28
  /**
@@ -62,4 +85,4 @@ const versionCache = new Map();
62
85
  return parts.join(" ");
63
86
  }
64
87
 
65
- export { getMetadataPath, getScreenshotName, readMetadata, readVersionFromPackage, writeMetadata };
88
+ export { getGitRepositoryPath, getMetadataPath, getScreenshotName, readMetadata, readVersionFromPackage, writeMetadata };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/util",
3
3
  "description": "Set of utilities used across all Argos SDKs",
4
- "version": "0.0.1-alpha.182+8a2e9db",
4
+ "version": "0.0.1-alpha.187+b2cbada",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -36,5 +36,5 @@
36
36
  "devDependencies": {
37
37
  "@types/node": "^16.0.0"
38
38
  },
39
- "gitHead": "8a2e9db6427071708c3d701a3230f228b1216893"
39
+ "gitHead": "b2cbadab77b42d32946e7ed315290e9b9bd7d245"
40
40
  }