Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

3.4 KB
Raw Blame
#!/usr/bin/env ts-node
;['.scss', '.css', '.svg', '.png', '.jpg', '.jpeg', '.gif'].forEach((ext) => {
    require.extensions[ext] = () => {}
})

import * as fs from 'fs'
import * as path from 'path'

import { SURVEY_SDK_REQUIREMENTS, SurveySdkType } from '../../src/scenes/surveys/surveyVersionRequirements'

const SDK_INFO: Record<SurveySdkType, { name: string; docsUrl: string }> = {
    'posthog-js': { name: 'JavaScript Web', docsUrl: '/docs/libraries/js' },
    'posthog-react-native': { name: 'React Native', docsUrl: '/docs/libraries/react-native' },
    'posthog-ios': { name: 'iOS', docsUrl: '/docs/libraries/ios' },
    'posthog-android': { name: 'Android', docsUrl: '/docs/libraries/android' },
    posthog_flutter: { name: 'Flutter', docsUrl: '/docs/libraries/flutter' },
}

const SDK_ORDER: SurveySdkType[] = [
    'posthog-js',
    'posthog-react-native',
    'posthog-ios',
    'posthog-android',
    'posthog_flutter',
]

function generateMarkdown(): string {
    const lines: string[] = [
        '---',
        'title: SDK feature support',
        'sidebar: Docs',
        'showTitle: true',
        '---',
        '',
        "import { IconCheck, IconWrench, IconX } from '@posthog/icons'",
        '',
        'Not all survey features are available on every SDK. Web has the most complete support, while mobile SDKs have some limitations.',
        '',
        'For setup instructions, see the [installation guides](/docs/surveys/installation).',
        '',
    ]

    const headerCells = ['Feature', ...SDK_ORDER.map((sdk) => `[${SDK_INFO[sdk].name}](${SDK_INFO[sdk].docsUrl})`)]

    // Build all data rows first to calculate column widths
    const dataRows: string[][] = []
    for (const req of SURVEY_SDK_REQUIREMENTS) {
        const cells: string[] = [req.feature]

        for (const sdk of SDK_ORDER) {
            const minVersion = req.sdkVersions[sdk]
            const unsupported = req.unsupportedSdks.find((u) => u.sdk === sdk)

            if (minVersion) {
                cells.push(`<IconCheck className="w-4 h-4 inline text-green" /> ${minVersion}+`)
            } else if (unsupported) {
                if (unsupported.issue === false) {
                    cells.push(`<IconX className="w-4 h-4 inline text-red" />`)
                } else {
                    cells.push(
                        `<a href="${unsupported.issue}"><IconWrench className="w-4 h-4 inline text-muted" /></a>`
                    )
                }
            } else {
                cells.push('—')
            }
        }

        dataRows.push(cells)
    }

    // Calculate column widths (max of header and all data cells)
    const colWidths = headerCells.map((header, i) => {
        const dataMax = Math.max(...dataRows.map((row) => row[i].length))
        return Math.max(header.length, dataMax)
    })

    // Format rows with padding
    const formatRow = (cells: string[]): string =>
        '| ' + cells.map((cell, i) => cell.padEnd(colWidths[i])).join(' | ') + ' |'

    lines.push(formatRow(headerCells))
    lines.push('| ' + colWidths.map((w) => '-'.repeat(w)).join(' | ') + ' |')

    for (const row of dataRows) {
        lines.push(formatRow(row))
    }

    return lines.join('\n')
}

const outputPath = path.resolve(__dirname, '../../../docs/published/docs/surveys/sdk-feature-support.mdx')
const content = generateMarkdown()

fs.writeFileSync(outputPath, content + '\n', 'utf-8')