Added contributer docs component to show missing language scopes (#2978)

Fixes #2973

Author: AndreasArvidsson

packages/cursorless-org-docs/src/docs/contributing/MissingLanguageScopes.tsx

@@ -0,0 +1,80 @@
+import {
+  languageScopeSupport,
+  scopeSupportFacetInfos,
+  ScopeSupportFacetLevel,
+  scopeSupportFacets,
+  type ScopeSupportFacet,
+  type ScopeType,
+  type SimpleScopeTypeType,
+} from "@cursorless/common";
+import React from "react";
+
+export function MissingLanguageScopes(): React.JSX.Element[] {
+  return Object.keys(languageScopeSupport)
+    .sort()
+    .map((languageId) => <Language key={languageId} languageId={languageId} />);
+}
+
+function Language({
+  languageId,
+}: {
+  languageId: string;
+}): React.JSX.Element | null {
+  const scopeSupport = languageScopeSupport[languageId] ?? {};
+
+  const unsupportedFacets = scopeSupportFacets.filter(
+    (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.unsupported,
+  );
+  const unspecifiedFacets = scopeSupportFacets.filter(
+    (facet) => scopeSupport[facet] == null,
+  );
+
+  if (unsupportedFacets.length === 0 && unspecifiedFacets.length === 0) {
+    return null;
+  }
+
+  return (
+    <>
+      <h3>{languageId}</h3>
+      {renderFacets("Unsupported", unsupportedFacets)}
+      {renderFacets("Unspecified", unspecifiedFacets)}
+    </>
+  );
+}
+
+function renderFacets(
+  title: string,
+  facets: ScopeSupportFacet[],
+): React.JSX.Element | null {
+  const scopes = Array.from(
+    new Set(
+      facets.map((f) =>
+        serializeScopeType(scopeSupportFacetInfos[f].scopeType),
+      ),
+    ),
+  ).sort();
+
+  if (scopes.length === 0) {
+    return null;
+  }
+
+  return (
+    <>
+      {title} ({scopes.length})
+      <ul>
+        {scopes.map((scope) => {
+          return <li key={scope}>{scope}</li>;
+        })}
+      </ul>
+    </>
+  );
+}
+
+function serializeScopeType(
+  scopeType: SimpleScopeTypeType | ScopeType,
+): string {
+  if (typeof scopeType === "string") {
+    return scopeType;
+  }
+  return scopeType.type;
+}

packages/cursorless-org-docs/src/docs/contributing/adding-a-new-language.md

@@ -48,5 +48,5 @@ import { Language } from "./components/Language";
 
 # Java
 
-<Language languageId="java"></Language>
+<Language languageId="java" />
 ```

packages/cursorless-org-docs/src/docs/contributing/missing_language_scopes.mdx

@@ -0,0 +1,9 @@
+import { MissingLanguageScopes } from "./MissingLanguageScopes";
+
+# Missing language scopes
+
+The following languages have one or more missing (unsupported or not specified) scope facets and need a developer to have a look at them.
+
+[Adding a new scope](./adding-a-new-scope.md)
+
+<MissingLanguageScopes />

packages/cursorless-org-docs/src/docs/user/languages/c.mdx

@@ -2,4 +2,4 @@ import { Language } from "./components/Language";
 
 # C
 
-<Language languageId="c"></Language>
+<Language languageId="c" />

packages/cursorless-org-docs/src/docs/user/languages/clojure.mdx

@@ -2,4 +2,4 @@ import { Language } from "./components/Language";
 
 # Clojure
 
-<Language languageId="clojure"></Language>
+<Language languageId="clojure" />

packages/cursorless-org-docs/src/docs/user/languages/components/ScopeSupport.tsx

@@ -11,19 +11,19 @@ interface Props {
 }
 
 export function ScopeSupport({ languageId }: Props): React.JSX.Element {
-  const scopesSorted = [...scopeSupportFacets].sort();
+  const facetsSorted = [...scopeSupportFacets].sort();
   const scopeSupport = languageScopeSupport[languageId] ?? {};
 
-  const supportedScopes = scopesSorted.filter(
+  const supportedFacets = facetsSorted.filter(
     (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.supported,
   );
-  const supportedLegacyScopes = scopesSorted.filter(
+  const supportedLegacyFacets = facetsSorted.filter(
     (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.supportedLegacy,
   );
-  const unsupportedScopes = scopesSorted.filter(
+  const unsupportedFacets = facetsSorted.filter(
     (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.unsupported,
   );
-  const unspecifiedScopes = scopesSorted.filter(
+  const unspecifiedFacets = facetsSorted.filter(
     (facet) => scopeSupport[facet] == null,
   );
 
@@ -32,20 +32,20 @@ export function ScopeSupport({ languageId }: Props): React.JSX.Element {
       <h2>Scopes</h2>
 
       <ScopeSupportForLevel
-        facets={supportedScopes}
+        facets={supportedFacets}
         title="Supported facets"
         subtitle="These facets are supported"
         open
       />
 
       <ScopeSupportForLevel
-        facets={supportedLegacyScopes}
+        facets={supportedLegacyFacets}
         title="Supported Legacy facets"
         subtitle="These facets are supported with the legacy implementation and should be migrated to the new implementation"
       />
 
       <ScopeSupportForLevel
-        facets={unsupportedScopes}
+        facets={unsupportedFacets}
         title="Unsupported facets"
         subtitle="These facets are not supported yet and needs a developer to implement them"
         description={
@@ -59,7 +59,7 @@ export function ScopeSupport({ languageId }: Props): React.JSX.Element {
       />
 
       <ScopeSupportForLevel
-        facets={unspecifiedScopes}
+        facets={unspecifiedFacets}
         title="Unspecified facets"
         subtitle="These facets are unspecified"
         description={

packages/cursorless-org-docs/src/docs/user/languages/cpp.mdx

@@ -2,4 +2,4 @@ import { Language } from "./components/Language";
 
 # C++
 
-<Language languageId="cpp"></Language>
+<Language languageId="cpp" />

packages/cursorless-org-docs/src/docs/user/languages/csharp.mdx

@@ -6,4 +6,4 @@ import { Language } from "./components/Language";
 
 # C#
 
-<Language languageId="csharp"></Language>
+<Language languageId="csharp" />

packages/cursorless-org-docs/src/docs/user/languages/css.mdx

@@ -2,4 +2,4 @@ import { Language } from "./components/Language";
 
 # CSS
 
-<Language languageId="css"></Language>
+<Language languageId="css" />

packages/cursorless-org-docs/src/docs/user/languages/dart.mdx

@@ -2,4 +2,4 @@ import { Language } from "./components/Language";
 
 # Dart
 
-<Language languageId="dart"></Language>
+<Language languageId="dart" />