more fixes

Author: mydea

docs/platforms/javascript/config.yml

@@ -3,6 +3,7 @@ platformTitle: JavaScript
 caseStyle: camelCase
 supportLevel: production
 sdk: 'sentry.javascript.browser'
+language: typescript
 categories:
   - javascript
   - browser

docs/platforms/python/apis.mdx

@@ -0,0 +1,75 @@
+---
+title: APIs
+description: "Learn more about APIs of the SDK."
+customCanonicalTag: "/platforms/python/apis/"
+sidebar_order: 3
+---
+
+This page shows all available to-level APIs of the SDK. You can use them like this:
+
+```javascript
+import * as Sentry from "@sentry/browser";
+
+Sentry.setTag("tag", "value");
+```
+
+## Available Options
+
+<TableOfContents ignoreIds={["available-options"]} />
+
+## Capturing Events
+
+<SdkApi
+  name="captureException"
+  signature={`capture_exception(exception: Exception, hint: Optional[CaptureContext] = None) -> EventId`}
+  parameters={[
+    {
+      name: "exception",
+      required: true,
+      type: "unknown",
+      description: "The exception to capture. This is usually an Error object.",
+    },
+    {
+      name: "captureContext",
+      type: {
+        name: "CaptureContext",
+        properties: [
+          {
+            name: "user",
+            type: {
+              name: "User",
+              properties: [
+                { name: "id", type: "string | number" },
+                { name: "email", type: "string" },
+                { name: "ip_address", type: "string" },
+                { name: "username", type: "string" },
+              ],
+            },
+          },
+          {
+            name: "level",
+            type: '"fatal" | "error" | "warning" | "log" | "info" | "debug"',
+          },
+          {
+            name: "extra",
+            type: "Record<string, unknown>",
+            description:
+              "Additional data that should be sent with the exception.",
+          },
+          {
+            name: "tags",
+            type: "Record<string, string>",
+            description:
+              "Additional tags that should be sent with the exception.",
+          },
+          { name: "contexts", type: "Record<string, Record<string, unknown>>" },
+          { name: "fingerprint", type: "string[]" },
+        ],
+      },
+      description:
+        "A hint object containing additional information about the exception.",
+    },
+  ]}
+>
+  Capture an exception event and send it to Sentry.
+</SdkApi>

docs/platforms/python/index.mdx

@@ -5,6 +5,7 @@ caseStyle: snake_case
 supportLevel: production
 sdk: sentry.python
 showIntegrationsInSearch: true
+language: python
 categories:
   - server
   - serverless

src/components/apiExamples/apiExamples.tsx

@@ -1,14 +1,7 @@
 'use client';
 
 import {Fragment, useEffect, useState} from 'react';
-import {jsx, jsxs} from 'react/jsx-runtime';
 import {Clipboard} from 'react-feather';
-import {toJsxRuntime} from 'hast-util-to-jsx-runtime';
-import {Nodes} from 'hastscript/lib/create-h';
-import bash from 'refractor/lang/bash.js';
-import json from 'refractor/lang/json.js';
-import typescript from 'refractor/lang/typescript.js';
-import {refractor} from 'refractor/lib/core.js';
 
 import {type API} from 'sentry-docs/build/resolveOpenAPI';
 
@@ -17,10 +10,7 @@ import styles from './apiExamples.module.scss';
 
 import {CodeBlock} from '../codeBlock';
 import {CodeTabs} from '../codeTabs';
-
-refractor.register(bash);
-refractor.register(json);
-refractor.register(typescript);
+import {codeToJsx} from '../highlightCode';
 
 const strFormat = (str: string) => {
   const s = str.trim();
@@ -34,10 +24,6 @@ type Props = {
   api: API;
 };
 
-const codeToJsx = (code: string, lang = 'json') => {
-  return toJsxRuntime(refractor.highlight(code, lang) as Nodes, {Fragment, jsx, jsxs});
-};
-
 export function ApiExamples({api}: Props) {
   const apiExample = [
     `curl ${api.server}${api.apiPath}`,

src/components/highlightCode.tsx

@@ -0,0 +1,40 @@
+import {Fragment} from 'react';
+import {jsx, jsxs} from 'react/jsx-runtime';
+import {toJsxRuntime} from 'hast-util-to-jsx-runtime';
+import {Nodes} from 'hastscript/lib/create-h';
+import bash from 'refractor/lang/bash.js';
+import c from 'refractor/lang/c.js';
+import cpp from 'refractor/lang/cpp.js';
+import csharp from 'refractor/lang/csharp.js';
+import go from 'refractor/lang/go.js';
+import java from 'refractor/lang/java.js';
+import json from 'refractor/lang/json.js';
+import kotlin from 'refractor/lang/kotlin.js';
+import objectivec from 'refractor/lang/objectivec.js';
+import php from 'refractor/lang/php.js';
+import python from 'refractor/lang/python.js';
+import ruby from 'refractor/lang/ruby.js';
+import rust from 'refractor/lang/rust.js';
+import swift from 'refractor/lang/swift.js';
+import typescript from 'refractor/lang/typescript.js';
+import {refractor} from 'refractor/lib/core.js';
+
+refractor.register(bash);
+refractor.register(json);
+refractor.register(typescript);
+refractor.register(python);
+refractor.register(java);
+refractor.register(c);
+refractor.register(cpp);
+refractor.register(kotlin);
+refractor.register(csharp);
+refractor.register(rust);
+refractor.register(swift);
+refractor.register(ruby);
+refractor.register(objectivec);
+refractor.register(php);
+refractor.register(go);
+
+export function codeToJsx(code: string, lang = 'json') {
+  return toJsxRuntime(refractor.highlight(code, lang) as Nodes, {Fragment, jsx, jsxs});
+}

src/components/nestedObject.tsx

@@ -1,17 +1,11 @@
 'use client';
 
 import {Fragment, useState} from 'react';
-import {jsx, jsxs} from 'react/jsx-runtime';
 import {MinusCircledIcon, PlusCircledIcon} from '@radix-ui/react-icons';
-import {toJsxRuntime} from 'hast-util-to-jsx-runtime';
-import {Nodes} from 'hastscript/lib/create-h';
-import {refractor} from 'refractor/lib/core.js';
 
+import {codeToJsx} from './highlightCode';
 import {ParameterDef} from './sdkApi';
 
-const codeToJsx = (code: string, lang = 'json') => {
-  return toJsxRuntime(refractor.highlight(code, lang) as Nodes, {Fragment, jsx, jsxs});
-};
 
 export function RenderNestedObject({
   name,
@@ -24,6 +18,8 @@ export function RenderNestedObject({
 }) {
   const [expanded, setExpanded] = useState(false);
 
+  // NOTE: For now, we always render the nested object in typescript
+
   return (
     <div>
       <div className="flex items-center gap-2">
@@ -50,14 +46,14 @@ export function RenderNestedObject({
               <div key={prop.name}>
                 {prop.description && (
                   <div>
-                    <code>{codeToJsx(`// ${prop.description}`, language)}</code>
+                    <code>{codeToJsx(`// ${prop.description}`, 'typescript')}</code>
                   </div>
                 )}
                 <div>
                   {typeof prop.type === 'string' ? (
                     <Fragment>
                       <code>{prop.name}{!prop.required ? '?' : ''}: </code>
-                      <code>{codeToJsx(prop.type, language)},</code>
+                      <code>{codeToJsx(prop.type, 'typescript')},</code>
                     </Fragment>
                   ) : (
                     <RenderNestedObject

src/components/sdkApi.tsx

@@ -1,15 +1,9 @@
-import {Fragment} from 'react';
-import {jsx, jsxs} from 'react/jsx-runtime';
-import {toJsxRuntime} from 'hast-util-to-jsx-runtime';
-import {Nodes} from 'hastscript/lib/create-h';
-import bash from 'refractor/lang/bash.js';
-import json from 'refractor/lang/json.js';
-import typescript from 'refractor/lang/typescript.js';
-import {refractor} from 'refractor/lib/core.js';
-
+import {getCurrentPlatform} from 'sentry-docs/docTree';
+import {serverContext} from 'sentry-docs/serverContext';
 import {PlatformCategory} from 'sentry-docs/types';
 
 import {Expandable} from './expandable';
+import {codeToJsx} from './highlightCode';
 import {RenderNestedObject} from './nestedObject';
 import {SdkDefinition} from './sdkDefinition';
 
@@ -35,32 +29,27 @@ type Props = {
   language?: string;
 };
 
-refractor.register(bash);
-refractor.register(json);
-refractor.register(typescript);
-
-const codeToJsx = (code: string, lang = 'json') => {
-  return toJsxRuntime(refractor.highlight(code, lang) as Nodes, {Fragment, jsx, jsxs});
-};
-
 export function SdkApi({
   name,
   children,
   signature,
   parameters = [],
-  // TODO: How to handle this default better?
-  language = 'typescript',
+  language,
   categorySupported = [],
 }: Props) {
+  const {rootNode, path} = serverContext();
+  const platform = getCurrentPlatform(rootNode, path);
+  const lang = language || platform?.language || 'typescript';
+
   return (
     <SdkDefinition name={name} categorySupported={categorySupported}>
-      <pre className="mt-2 mb-2 text-sm">{codeToJsx(signature, language)}</pre>
+      <pre className="mt-2 mb-2 text-sm">{codeToJsx(signature, lang)}</pre>
 
       {parameters.length ? (
         <Expandable title="Parameters">
           <div className="space-y-3">
             {parameters.map(param => (
-              <ApiParameterDef key={param.name} language={language} {...param} />
+              <ApiParameterDef key={param.name} language={lang} {...param} />
             ))}
           </div>
         </Expandable>

src/docTree.ts

@@ -263,6 +263,7 @@ function nodeToPlatform(n: DocNode): Platform {
     caseStyle,
     sdk: n.frontmatter.sdk,
     fallbackPlatform: n.frontmatter.fallbackPlatform,
+    language: n.frontmatter.language,
     categories: n.frontmatter.categories,
     keywords: n.frontmatter.keywords,
     guides,

src/types/platform.tsx

@@ -118,6 +118,8 @@ export interface PlatformConfig {
    * Keywords used for search etc.
    */
   keywords?: string[];
+  /** The name of the programming language that should be used for formatting the SDK API docs. */
+  language?: string;
   /**
    * The title of the platform as it should be displayed in the sidebar.
    * In most cases, you do not need to define this, as the title is used.