Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix broken doc links in FDC VS Code extension #8320

Merged
merged 2 commits into from
Mar 13, 2025
Merged
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
2 changes: 1 addition & 1 deletion firebase-vscode/webviews/SidebarApp.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ function DataConnect() {
<Spacer size="xsmall" />
<Label level={3}>
See also:{" "}
<a href="https://firebase.google.com/docs/data-connect/gp/web-sdk">
<a href="https://firebase.google.com/docs/data-connect/web-sdk">
Working with generated SDKs
</a>
</Label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function DataConnect() {
Configure a generated SDK.
<br></br>
See also:{" "}
<a href="https://firebase.google.com/docs/data-connect/gp/web-sdk">
<a href="https://firebase.google.com/docs/data-connect/web-sdk">
Working with generated SDKs
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/commands/dataconnect-sdk-generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export const command = new Command("dataconnect:sdk:generate")
`Run ${clc.bold("firebase init dataconnect:sdk")} to configure a generated SDK.`,
);
logger.warn(
`See https://firebase.google.com/docs/data-connect/gp/web-sdk for more details of how to configure generated SDKs.`,
`See https://firebase.google.com/docs/data-connect/web-sdk for more details of how to configure generated SDKs.`,
);
return;
}
Expand Down
2 changes: 1 addition & 1 deletion src/init/features/dataconnect/sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
connectorInfo: ConnectorInfo;
displayIOSWarning: boolean;
};
export async function doSetup(setup: Setup, config: Config): Promise<void> {

Check warning on line 38 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Missing JSDoc comment
const sdkInfo = await askQuestions(setup, config);
await actuate(sdkInfo);
logSuccess(
Expand Down Expand Up @@ -92,7 +92,7 @@
{ name: "Android (Kotlin)", value: Platform.ANDROID },
{ name: "Flutter (Dart)", value: Platform.FLUTTER },
];
targetPlatform = await promptOnce({

Check warning on line 95 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Unsafe assignment of an `any` value
message: "Which platform do you want to set up a generated SDK for?",
type: "list",
choices: platforms,
Expand All @@ -101,7 +101,7 @@
logSuccess(`Detected ${targetPlatform} app in directory ${appDir}`);
}

const connectorInfo: ConnectorInfo = await promptOnce({

Check warning on line 104 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Unsafe assignment of an `any` value
message: "Which connector do you want set up a generated SDK for?",
type: "list",
choices: connectorChoices,
Expand All @@ -116,10 +116,10 @@
);
if (targetPlatform === Platform.WEB) {
const unusedFrameworks = SUPPORTED_FRAMEWORKS.filter(
(framework) => !newConnectorYaml!.generate?.javascriptSdk![framework],

Check warning on line 119 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Forbidden non-null assertion

Check warning on line 119 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

This assertion is unnecessary since it does not change the type of the expression

Check warning on line 119 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Forbidden non-null assertion
);
if (unusedFrameworks.length > 0) {
const additionalFrameworks: { fdcFrameworks: (keyof SupportedFrameworks)[] } = await prompt(

Check warning on line 122 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Unsafe assignment of an `any` value
setup,
[
{
Expand All @@ -137,7 +137,7 @@
],
);
for (const framework of additionalFrameworks.fdcFrameworks) {
newConnectorYaml!.generate!.javascriptSdk![framework] = true;

Check warning on line 140 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Forbidden non-null assertion

Check warning on line 140 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

Forbidden non-null assertion

Check warning on line 140 in src/init/features/dataconnect/sdk.ts

View workflow job for this annotation

GitHub Actions / lint (20)

This assertion is unnecessary since it does not change the type of the expression
}
}
}
Expand Down Expand Up @@ -233,7 +233,7 @@
if (sdkInfo.connectorInfo.connectorYaml.generate?.swiftSdk && sdkInfo.displayIOSWarning) {
logBullet(
clc.bold(
"Please follow the instructions here to add your generated sdk to your XCode project:\n\thttps://firebase.google.com/docs/data-connect/gp/ios-sdk#set-client",
"Please follow the instructions here to add your generated sdk to your XCode project:\n\thttps://firebase.google.com/docs/data-connect/ios-sdk#set-client",
),
);
}
Expand Down
Loading