AdvisorRulesPreview() — supabase Function Reference

Architecture documentation for the AdvisorRulesPreview() function in AdvisorRulesPreview.tsx from the supabase codebase.

Function tsx ContentManagement AccessControl calls 1

Entity Profile

ContentManagement→ AccessControl→ AdvisorRulesPreview() — supabase Function Reference

Dependency Diagram

graph TD
  30094090_954d_58b5_39d5_0cbe82febe3e["AdvisorRulesPreview()"]
  1597d34e_f769_5f6f_be1c_a9567b5dd0a6["useIsAdvisorRulesEnabled()"]
  30094090_954d_58b5_39d5_0cbe82febe3e -->|calls| 1597d34e_f769_5f6f_be1c_a9567b5dd0a6
  style 30094090_954d_58b5_39d5_0cbe82febe3e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/studio/components/interfaces/App/FeaturePreview/AdvisorRulesPreview.tsx lines 8–45

export const AdvisorRulesPreview = () => {
  const { ref } = useParams()
  const isAdvisorRulesEnabled = useIsAdvisorRulesEnabled()

  return (
    <div>
      <p className="text-sm text-foreground-light mb-4">
        Disable specific Advisor categories or rules to prevent them from showing up in Advisor
        reports or email notifications. This could be useful for rules that might not be applicable
        to your project.
      </p>
      <Image
        src={`${BASE_PATH}/img/previews/advisor-rule-preview.png`}
        width={1296}
        height={900}
        alt="api-docs-side-panel-preview"
        className="rounded border mb-4"
      />
      <div className="space-y-2 !mt-4">
        <p className="text-sm">Enabling this preview will:</p>
        <ul className="list-disc pl-6 text-sm text-foreground-light space-y-1">
          <li>
            Allow you to disable advisor rules for your project from the{' '}
            <InlineLink
              href={
                isAdvisorRulesEnabled
                  ? `/project/${ref}/advisors/rules/security`
                  : `/project/${ref}/advisors/security`
              }
            >
              Advisors section.
            </InlineLink>
          </li>
        </ul>
      </div>
    </div>
  )
}