@codecov/bundler-plugin-core - npm Package Compare versions

Comparing version 0.0.1-beta.4 to 0.0.1-beta.5

dist/index.d.ts

@@ -32,24 +32,2 @@ import * as unplugin from 'unplugin';
     }>>;
-    sentry: z.ZodOptional<z.ZodObject<{
-        sentryOnly: z.ZodDefault<z.ZodBoolean>;
-        authToken: z.ZodString;
-        isEnabled: z.ZodDefault<z.ZodBoolean>;
-        org: z.ZodOptional<z.ZodString>;
-        project: z.ZodOptional<z.ZodString>;
-        environment: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        sentryOnly: boolean;
-        authToken: string;
-        isEnabled: boolean;
-        org?: string | undefined;
-        project?: string | undefined;
-        environment?: string | undefined;
-    }, {
-        authToken: string;
-        sentryOnly?: boolean | undefined;
-        isEnabled?: boolean | undefined;
-        org?: string | undefined;
-        project?: string | undefined;
-        environment?: string | undefined;
-    }>>;
 }, "strip", z.ZodTypeAny, {
@@ -69,10 +47,2 @@ apiUrl: string;
     } | undefined;
-    sentry?: {
-        sentryOnly: boolean;
-        authToken: string;
-        isEnabled: boolean;
-        org?: string | undefined;
-        project?: string | undefined;
-        environment?: string | undefined;
-    } | undefined;
 }, {
@@ -92,10 +62,2 @@ bundleName: string;
     } | undefined;
-    sentry?: {
-        authToken: string;
-        sentryOnly?: boolean | undefined;
-        isEnabled?: boolean | undefined;
-        org?: string | undefined;
-        project?: string | undefined;
-        environment?: string | undefined;
-    } | undefined;
 }>;
@@ -143,18 +105,50 @@
 }
+/** Configuration ptions for the Codcov bundler plugin. */
 interface Options {
+    /**
+     * The upload token to use for uploading the bundle analysis information.
+     *
+     * This value can either be an global upload token or a repo token.
+     * - The global upload token can be found under the organization settings page.
+     * - The repo token can be found under the repo settings page under the general tab.
+     */
     uploadToken?: string;
+    /**
+     * The api url used to fetch the upload url.
+     *
+     * Only required if self-hosting codecov.
+     *
+     * Defaults to `https://api.codecov.io`.
+     */
     apiUrl?: string;
+    /**
+     * The amount of times the upload function will retry to upload bundle analysis information.
+     *
+     * Defaults to `3`
+     */
     retryCount?: number;
+    /**
+     * When enabled information will not be uploaded to Codecov.
+     *
+     * Defaults to `false`
+     */
     dryRun?: boolean;
+    /**
+     * The name for the bundle being built.
+     *
+     * Required for uploading bundle analysis information.
+     *
+     * The name must match the pattern `/^[\w\d_:/@\.{}\[\]$-]+$/`.
+     *
+     * Example: `@codecov/rollup-plugin`
+     */
     bundleName?: string;
+    /**
+     * Whether you would like bundle analysis to be enabled. *
+     *
+     * Defaults to `false`
+     */
     enableBundleAnalysis?: boolean;
+    /** Override values for passing custom information to API. */
     uploadOverrides?: UploadOverrides;
-    sentry?: {
-        sentryOnly?: boolean;
-        isEnabled?: boolean;
-        authToken?: string;
-        org?: string;
-        project?: string;
-        environment?: string;
-    };
 }
@@ -165,7 +159,13 @@ type BundleAnalysisUploadPlugin = (args: BundleAnalysisUploadPluginArgs) => UnpluginOptions & {
 };
+/** A set of overrides that are passed to Codecov. */
 interface UploadOverrides {
+    /** Specify the branch manually. */
     branch?: string;
+    /** Specify the build number manually. */
     build?: string;
+    /** Specify the pull request number manually. */
     pr?: string;
+    /** Specify the commit SHA manually. */
     sha?: string;
+    /** Specify the slug manually. */
     slug?: string;
@@ -172,0 +172,0 @@ }

package.json

 {
   "name": "@codecov/bundler-plugin-core",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.5",
   "description": "Official Codecov Bundler Plugin Core",
@@ -38,8 +38,10 @@ "author": "Codecov",
     "@types/semver": "^7.5.6",
+    "codecovProdRollupPlugin": "npm:@codecov/rollup-plugin@0.0.1-beta.3",
     "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
     "msw": "^2.1.5",
-    "codecovProdRollupPlugin": "npm:@codecov/rollup-plugin@0.0.1-beta.2",
     "testdouble": "^3.20.1",
     "testdouble-jest": "^2.0.0",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.25.12",
     "typescript": "^5.3.3",
@@ -64,4 +66,5 @@ "unbuild": "^2.0.0"
     "test:unit": "jest",
-    "test:unit:ci": "jest --coverage"
+    "test:unit:ci": "JEST_JUNIT_OUTPUT_NAME='bundler-plugin-core.junit.xml' jest --coverage --reporters=jest-junit",
+    "generate:typedoc": "typedoc --options ./typedoc.json"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

318842

increased by129.74%

Number of package files

10

increased by25%

Number of medium supply chain risk alerts

7

decreased by-12.5%

Worsened metrics

Dev dependency count

15

increased by15.38%

Lines of code

437

decreased by-90.66%

Number of low quality alerts

3

increased by50%

No dependency changes