bloktor-config-recommended

Official recommended rule preset for Bloktor. Enables all 39 built-in rules with sensible defaults — warn for advisory checks, error for structural and safety issues.

Usage

import { defineConfig } from "bloktor";
import recommended from "bloktor-config-recommended";

export default defineConfig({
  space: 12345,
  region: "eu",
  extends: [recommended]
});

Rules

| Rule | Severity | Non-default options | |---|---|---| | schema/no-orphan-bloks | error | | | schema/no-untyped-bloks | error | | | schema/no-deprecated-fields | error | | | schema/require-field-description | warn | | | schema/max-fields | warn | max: 25 | | schema/no-redundant-fields | warn | | | hierarchy/no-circular-refs | error | | | hierarchy/max-nesting-depth | warn | max: 4 | | hierarchy/require-root | error | | | hierarchy/no-isolated-nestables | error | | | naming/component-convention | warn | convention: "snake_case" | | naming/field-convention | warn | convention: "snake_case" | | naming/no-generic-names | warn | | | naming/require-display-name | warn | | | config/require-preview-url | warn | | | config/require-workflow | warn | | | config/no-open-permissions | error | | | config/require-languages | warn | | | config/no-empty-datasources | warn | | | config/require-datasource-dimension | warn | | | config/no-unconstrained-assets | warn | | | config/require-richtext-toolbar | warn | | | config/no-unrestricted-richtext | error | | | best-practice/require-blok-group | warn | | | best-practice/no-empty-groups | warn | | | best-practice/no-duplicate-display-names | warn | | | best-practice/require-tab-structure | warn | minFields: 12 | | best-practice/require-blok-min-max | warn | defaultMin: 0, defaultMax: 10 | | best-practice/no-single-field-bloks | warn | | | best-practice/prefer-nestable-for-reuse | warn | minReferences: 2 | | best-practice/no-text-for-richtext | warn | | | best-practice/group-related-fields | warn | minPrefixFields: 2 | | drift/cross-space-components | error | | | drift/cross-space-datasources | error | | | drift/cross-space-roles | warn | | | drift/cross-space-workflows | warn | | | drift/schema-git-sync | error | | | drift/types-schema-sync | error | | | drift/require-migration-for-breaking | error | |

Overriding rules

export default defineConfig({
  extends: [recommended],
  rules: {
    "schema/max-fields": ["warn", { max: 30 }],
    "naming/component-convention": "off"
  }
});

See the Rule Reference for full option descriptions.