Skip to content

Added checkbox to decide if missing private scopes should be visible in the docs #2998

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 30, 2025
Merged

Added checkbox to decide if missing private scopes should be visible in the docs #2998

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 42 additions & 18 deletions packages/cursorless-org-docs/src/docs/contributing/MissingLanguageScopes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,34 @@ import {
} from "@cursorless/common";
import React, { useEffect, useState } from "react";

export function MissingLanguageScopes(): React.JSX.Element[] {
return Object.keys(languageScopeSupport)
.sort()
.map((languageId) => <Language key={languageId} languageId={languageId} />);
export function MissingLanguageScopes(): React.JSX.Element {
const [showPrivate, setShowPrivate] = useState(false);
const languageIds = Object.keys(languageScopeSupport).sort();

return (
<>
<label className="ml-1">
<input
type="checkbox"
checked={showPrivate}
onChange={(e) => setShowPrivate(e.target.checked)}
/>
Show private scopes
</label>

{languageIds.map((languageId) => (
<Language languageId={languageId} showPrivate={showPrivate} />
))}
</>
);
}

function Language({
languageId,
showPrivate,
}: {
languageId: string;
showPrivate: boolean;
}): React.JSX.Element | null {
const scopeSupport = languageScopeSupport[languageId] ?? {};

Expand All @@ -28,8 +46,10 @@ function Language({
const unspecifiedFacets = scopeSupportFacets.filter(
(facet) => scopeSupport[facet] == null,
);
const unsupportedScopes = facetsToScopes(unsupportedFacets, showPrivate);
const unspecifiedScopes = facetsToScopes(unspecifiedFacets, showPrivate);

if (unsupportedFacets.length === 0 && unspecifiedFacets.length === 0) {
if (unsupportedScopes.length === 0 && unspecifiedScopes.length === 0) {
return null;
}

Expand All @@ -42,30 +62,22 @@ function Language({
<a href={`../../user/languages/${languageId}`}>link</a>
</small>
</h3>
{renderFacets("Unsupported", unsupportedFacets)}
{renderFacets("Unspecified", unspecifiedFacets)}

{renderFacets("Unsupported", unsupportedScopes)}
{renderFacets("Unspecified", unspecifiedScopes)}
</>
);
}

function renderFacets(
title: string,
facets: ScopeSupportFacet[],
scopes: string[],
): React.JSX.Element | null {
const [open, setOpen] = useState(false);
const [scopes, setScopes] = useState<string[]>([]);

useEffect(() => {
const scopes = Array.from(
new Set(
facets.map((f) =>
serializeScopeType(scopeSupportFacetInfos[f].scopeType),
),
),
).sort();
setScopes(scopes);
setOpen(scopes.length < 4);
}, []);
}, [scopes]);

if (scopes.length === 0) {
return null;
Expand Down Expand Up @@ -98,6 +110,18 @@ function renderFacets(
);
}

function facetsToScopes(facets: ScopeSupportFacet[], showPrivate: boolean) {
return Array.from(
new Set(
facets.map((f) =>
serializeScopeType(scopeSupportFacetInfos[f].scopeType),
),
),
)
.filter((scope) => showPrivate || !scope.startsWith("private."))
.sort();
}

function serializeScopeType(
scopeType: SimpleScopeTypeType | ScopeType,
): string {
Expand Down
Loading