Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

6.3 KB
Raw Blame
import { humanFormat } from '@inkeep/open-knowledge-core/config/errors';
import {
  DEFAULT_LINKS_VALIDATION,
  DEFAULT_SUPPRESS_LOG_LINK_ADVISORIES,
  type LinksValidationSetting,
} from '@inkeep/open-knowledge-core/markdown/lint';
import { Trans, useLingui } from '@lingui/react/macro';
import { toast } from 'sonner';
import { Label } from '@/components/ui/label';
import {
  Select,
  SelectContent,
  SelectItem,
  SelectTrigger,
  SelectValue,
} from '@/components/ui/select';
import { Switch } from '@/components/ui/switch';
import { useConfigContext } from '@/lib/config-provider';
import { SettingsSectionHeader } from './SettingsSectionHeader';

export function ContentRulesSection() {
  const { t } = useLingui();
  const { projectConfig, projectSynced, projectBinding } = useConfigContext();
  const bindingReady = projectSynced && projectBinding !== null;
  const linksSetting: LinksValidationSetting =
    projectConfig?.validation?.links ?? DEFAULT_LINKS_VALIDATION;
  const indicatorsOn = projectConfig?.validation?.fileTreeIndicators !== false;
  const suppressLogLinksOn =
    projectConfig?.validation?.suppressLogLinkAdvisories ?? DEFAULT_SUPPRESS_LOG_LINK_ADVISORIES;

  function write(patch: {
    links?: LinksValidationSetting;
    fileTreeIndicators?: boolean;
    suppressLogLinkAdvisories?: boolean;
  }): void {
    if (projectBinding === null) {
      toast.error(t`Content rules not yet loaded — try again in a moment`);
      return;
    }
    const result = projectBinding.patch({ validation: patch });
    if (!result.ok) {
      toast.error(t`Failed to save content rules — ${humanFormat(result.error)}`);
    }
  }

  return (
    <section
      aria-labelledby="settings-content-rules-title"
      className="space-y-4"
      data-testid="settings-content-rules"
      data-field="section:content-rules"
    >
      <SettingsSectionHeader
        titleId="settings-content-rules-title"
        title={<Trans>Content rules</Trans>}
        scope="project"
        level="block"
      >
        <Trans>How validation findings surface across the project.</Trans>
      </SettingsSectionHeader>

      <div className="divide-y rounded-md border">
        <div className="flex items-center justify-between gap-3 px-3 py-3">
          <div className="min-w-0">
            <Label htmlFor="settings-content-rules-links" className="text-sm font-medium">
              <Trans>Broken internal links</Trans>
            </Label>
            <p
              id="settings-content-rules-links-description"
              className="text-1sm text-muted-foreground"
            >
              <Trans>
                How missing project-local documents, files, and images are reported in Problems,
                editor diagnostics, audits, and agent tools.
              </Trans>
            </p>
          </div>
          <Select
            value={linksSetting}
            onValueChange={(next) => write({ links: next as LinksValidationSetting })}
            disabled={!bindingReady}
          >
            <SelectTrigger
              id="settings-content-rules-links"
              aria-describedby="settings-content-rules-links-description"
              className="w-36 shrink-0"
              data-testid="settings-content-rules-links"
            >
              <SelectValue />
            </SelectTrigger>
            <SelectContent>
              <SelectItem value="off">
                <Trans>Don't show</Trans>
              </SelectItem>
              <SelectItem value="warning">
                <Trans>Warning</Trans>
              </SelectItem>
              <SelectItem value="error">
                <Trans>Error</Trans>
              </SelectItem>
            </SelectContent>
          </Select>
        </div>

        <div className="flex items-center justify-between gap-3 px-3 py-3">
          <div className="min-w-0">
            <Label htmlFor="settings-content-rules-log-links" className="text-sm font-medium">
              <Trans>Ignore broken links in log.md</Trans>
            </Label>
            <p
              id="settings-content-rules-log-links-description"
              className="text-1sm text-muted-foreground"
            >
              <Trans>
                Leave the broken links written inside a log.md or log.mdx at any folder depth out of
                Problems, file explorer indicators, editor diagnostics, audits, and agent write
                advisories. What counts is the file a link is written in, not the file it points at,
                and LOG.md is an ordinary document. The Links panel and the editor still show them.
              </Trans>
            </p>
          </div>
          <Switch
            id="settings-content-rules-log-links"
            aria-describedby="settings-content-rules-log-links-description"
            checked={suppressLogLinksOn}
            disabled={!bindingReady}
            onCheckedChange={(next) => write({ suppressLogLinkAdvisories: next })}
            data-testid="settings-content-rules-log-links"
          />
        </div>

        <div className="flex items-center justify-between gap-3 px-3 py-3">
          <div className="min-w-0">
            <Label htmlFor="settings-content-rules-indicators" className="text-sm font-medium">
              <Trans>Problem indicators in the file explorer</Trans>
            </Label>
            <p
              id="settings-content-rules-indicators-description"
              className="text-1sm text-muted-foreground"
            >
              <Trans>
                Tint and badge files that have lint or link problems, without opening them.
              </Trans>
            </p>
          </div>
          <Switch
            id="settings-content-rules-indicators"
            aria-describedby="settings-content-rules-indicators-description"
            checked={indicatorsOn}
            disabled={!bindingReady}
            onCheckedChange={(next) => write({ fileTreeIndicators: next })}
            data-testid="settings-content-rules-indicators"
          />
        </div>
      </div>

      <p
        className="text-sm text-muted-foreground"
        data-testid="settings-content-rules-plugins-note"
      >
        <Trans>
          Lint plugins — which rule families run and their per-rule settings — are configured on
          their own tab under This project → Plugins.
        </Trans>
      </p>
    </section>
  );
}