Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/skip-version-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-grab": minor
---

Add `skipVersionCheck` option to opt out of the npm version check and silence the "outdated" console warning.
2 changes: 1 addition & 1 deletion packages/react-grab/src/core/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ export const init = (rawOptions?: Options): ReactGrabAPI => {
}
hasInited = true;

logIntro();
logIntro({ skipVersionCheck: initialOptions.skipVersionCheck });

// eslint-disable-next-line @typescript-eslint/no-unused-vars -- need to omit enabled from settableOptions to avoid circular dependency
const { enabled: _enabled, ...settableOptions } = initialOptions;
Expand Down
3 changes: 2 additions & 1 deletion packages/react-grab/src/core/log-intro.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { LOGO_SVG } from "./logo-svg.js";
import { isExtensionContext } from "../utils/is-extension-context.js";

export const logIntro = () => {
export const logIntro = (options?: { skipVersionCheck?: boolean }) => {
try {
const version = process.env.VERSION;
const logoDataUri = `data:image/svg+xml;base64,${btoa(LOGO_SVG)}`;
Expand All @@ -10,6 +10,7 @@ export const logIntro = () => {
`background: #330039; color: #ffffff; border: 1px solid #d75fcb; padding: 4px 4px 4px 24px; border-radius: 4px; background-image: url("${logoDataUri}"); background-size: 16px 16px; background-repeat: no-repeat; background-position: 4px center; display: inline-block; margin-bottom: 4px;`,
"",
);
if (options?.skipVersionCheck) return;
if (navigator.onLine && version && !isExtensionContext()) {
fetch(`https://www.react-grab.com/api/version?source=browser&v=${version}&t=${Date.now()}`, {
referrerPolicy: "origin",
Expand Down
6 changes: 6 additions & 0 deletions packages/react-grab/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,12 @@ export interface Options {
* @default true
*/
freezeReactUpdates?: boolean;
/**
* Whether to skip the version check that logs a warning when a newer
* version of React Grab is available on npm.
* @default false
*/
skipVersionCheck?: boolean;
}

export interface SettableOptions extends Options {
Expand Down
3 changes: 3 additions & 0 deletions packages/react-grab/src/utils/get-script-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ const parseOptionsFromJson = (rawValue: unknown): Partial<Options> | null => {
if (typeof rawValue.freezeReactUpdates === "boolean") {
parsedOptions.freezeReactUpdates = rawValue.freezeReactUpdates;
}
if (typeof rawValue.skipVersionCheck === "boolean") {
parsedOptions.skipVersionCheck = rawValue.skipVersionCheck;
}

if (Object.keys(parsedOptions).length === 0) return null;
return parsedOptions;
Expand Down