Refactoring

Author: AndreasArvidsson

packages/common/src/index.ts

@@ -93,6 +93,7 @@ export * from "./types/TreeSitter";
 export * from "./types/tutorial.types";
 export * from "./util";
 export * from "./util/camelCaseToAllDown";
+export * from "./util/capitalize";
 export * from "./util/clientSupportsFallback";
 export * from "./util/CompositeKeyDefaultMap";
 export * from "./util/CompositeKeyMap";

packages/common/src/util/capitalize.ts

@@ -0,0 +1,3 @@
+export function capitalize(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}

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

@@ -1,4 +1,4 @@
-import Language from "./Language";
+import { Language } from "./components/Language";
 
 # C
 

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

@@ -1,4 +1,4 @@
-import Language from "./Language";
+import { Language } from "./components/Language";
 
 # Clojure
 

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

@@ -1,10 +1,10 @@
 import React from "react";
-import ScopeSupport from "./ScopeSupport";
+import { ScopeSupport } from "./ScopeSupport";
 
 interface Props {
   languageId: string;
 }
 
-export default function Language({ languageId }: Props) {
+export function Language({ languageId }: Props) {
   return <ScopeSupport languageId={languageId} />;
 }

packages/cursorless-org-docs/src/docs/user/languages/Language.tsx renamed to packages/cursorless-org-docs/src/docs/user/languages/components/Language.tsx

@@ -0,0 +1,76 @@
+import {
+  ScopeSupportFacetLevel,
+  languageScopeSupport,
+  scopeSupportFacets,
+} from "@cursorless/common";
+import React from "react";
+import { ScopeSupportForLevel } from "./ScopeSupportForLevel";
+
+interface Props {
+  languageId: string;
+}
+
+export function ScopeSupport({ languageId }: Props): JSX.Element {
+  const scopesSorted = [...scopeSupportFacets].sort();
+  const scopeSupport = languageScopeSupport[languageId] ?? {};
+
+  const supportedScopes = scopesSorted.filter(
+    (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.supported,
+  );
+  const supportedLegacyScopes = scopesSorted.filter(
+    (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.supportedLegacy,
+  );
+  const unsupportedScopes = scopesSorted.filter(
+    (facet) => scopeSupport[facet] === ScopeSupportFacetLevel.unsupported,
+  );
+  const unspecifiedScopes = scopesSorted.filter(
+    (facet) => scopeSupport[facet] == null,
+  );
+
+  return (
+    <>
+      <ScopeSupportForLevel
+        facets={supportedScopes}
+        title={"Supported facets"}
+        description={"These facets are supported"}
+      />
+
+      <ScopeSupportForLevel
+        facets={supportedLegacyScopes}
+        title={"Supported Legacy facets"}
+        description={
+          "These facets are supported with the legacy implementation and should be migrated to the new implementation"
+        }
+      />
+
+      <ScopeSupportForLevel
+        facets={unsupportedScopes}
+        title={"Unsupported facets"}
+        description={
+          <>
+            These facets are not supported yet and needs a developer to
+            implement them. <br />
+            We would happily accept
+            [contributions](https://www.cursorless.org/docs/contributing/adding-a-new-scope).
+          </>
+        }
+      />
+
+      <ScopeSupportForLevel
+        facets={unspecifiedScopes}
+        title={"Unspecified facets"}
+        description={
+          <>
+            These facets are unspecified <br />
+            <i>
+              Note that in many instances we actually do support these scopes,
+              but we have not yet updated `languageScopeSupport` to reflect this
+              fact. We would happily accept
+              [contributions](https://www.cursorless.org/docs/contributing/adding-a-new-scope).
+            </i>
+          </>
+        }
+      />
+    </>
+  );
+}

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

@@ -0,0 +1,95 @@
+import {
+  camelCaseToAllDown,
+  capitalize,
+  groupBy,
+  type ScopeSupportFacet,
+  type ScopeSupportFacetInfo,
+  scopeSupportFacetInfos,
+  type ScopeType,
+  type SimpleScopeTypeType,
+} from "@cursorless/common";
+import React from "react";
+
+interface Props {
+  facets: ScopeSupportFacet[];
+  title: string;
+  description: React.ReactNode;
+}
+
+export function ScopeSupportForLevel({
+  facets,
+  title,
+  description,
+}: Props): JSX.Element | null {
+  if (facets.length === 0) {
+    return null;
+  }
+  const facetInfos = facets.map(
+    (facet): AugmentedFacetInfo => ({
+      facet,
+      ...scopeSupportFacetInfos[facet],
+    }),
+  );
+  const scopeGroups: Map<string, AugmentedFacetInfo[]> = groupBy(
+    facetInfos,
+    (facetInfo) => serializeScopeType(facetInfo.scopeType),
+  );
+  const scopeTypes = Array.from(scopeGroups.keys()).sort();
+  return (
+    <div>
+      <h3>{title}</h3>
+      <p>{description}</p>
+
+      {scopeTypes.map((scopeType) => {
+        const facetInfos = scopeGroups.get(scopeType) ?? [];
+        return (
+          <div key={scopeType}>
+            <h4>{prettifyScopeType(scopeType)}</h4>
+            <ul>
+              {facetInfos.map((facetInfo) => {
+                return (
+                  <li key={facetInfo.facet}>
+                    <b title={facetInfo.facet}>
+                      {prettifyFacet(facetInfo.facet)}
+                    </b>
+                    : {facetInfo.description}
+                  </li>
+                );
+              })}
+            </ul>
+          </div>
+        );
+      })}
+    </div>
+  );
+}
+
+interface AugmentedFacetInfo extends ScopeSupportFacetInfo {
+  facet: ScopeSupportFacet;
+}
+
+function prettifyScopeType(scopeType: string): string {
+  return capitalize(camelCaseToAllDown(scopeType));
+}
+
+function prettifyFacet(facet: ScopeSupportFacet): string {
+  const parts = facet.split(".").map(camelCaseToAllDown);
+  if (parts.length === 1) {
+    return capitalize(parts[0]);
+  }
+  const isIteration = parts[parts.length - 1] === "iteration";
+  if (isIteration) {
+    parts.pop();
+  }
+  const name = capitalize(parts.slice(1).join(" "));
+  return isIteration ? `${name} (iteration)` : name;
+}
+
+function serializeScopeType(
+  scopeType: SimpleScopeTypeType | ScopeType,
+): string {
+  if (typeof scopeType === "string") {
+    return scopeType;
+  }
+  return scopeType.type;
+}

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

@@ -1,4 +1,4 @@
-import Language from "./Language";
+import { Language } from "./components/Language";
 
 # C++
 

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

@@ -1,4 +1,4 @@
-import Language from "./Language";
+import { Language } from "./components/Language";
 
 # C#