Dependicus API Reference
    Preparing search index...

    Class BasicCompliancePlugin

    Threshold-based compliance plugin.

    You provide policy definitions and a function that maps dependencies to policy IDs; the plugin handles columns, sections, and issue spec generation. It composes with ownership plugins — each plugin contributes its own fields to the merged LinearIssueSpec.

    See the Compliance docs for usage examples.

    Implements

    Index

    Constructors

    Properties

    columns: CustomColumn[]
    groupings: GroupingConfig[]
    name: "basic-compliance" = 'basic-compliance'

    Methods

    • Produce compliance-related fields for a Linear issue.

      Target version selection: If the policy has a major threshold, target is the absolute latest. If only minor, target is the latest within the current major. If only patch, target is the latest within the current minor. This prevents the issue from asking teams to jump to a new major when their policy only covers minor/patch updates. When a newer major exists beyond the target, availableMajorVersion is set so the issue can mention it informatively.

      Returns a partial LinearIssueSpec (no teamId/assignment/group/ownerLabel — those come from a separate ownership plugin).

      Parameters

      Returns
          | Partial<
              {
                  assignment?: | { type: "unassigned" }
                  | { assigneeId: string; type: "delegate" };
                  availableMajorVersion?: string;
                  daysOverdue?: number;
                  descriptionSections?: { body: string; title: string }[];
                  group?: string;
                  ownerLabel?: string;
                  policy?:
                      | { type: "skip" }
                      | { rateLimitDays?: number; type: "fyi" }
                      | { rateLimitDays?: number; type: "dueDate" };
                  targetVersion?: string;
                  teamId: string;
                  thresholdDays?: number;
              },
          >
          | undefined