@diplodoc/tabs-extension 3.10.8-transform5.1 → 3.10.8-transform5.3

package/README.md

@@ -89,6 +89,57 @@ Options:
   Example: `my-own-class and-other-class`<br>
   Default: `undefined`<br>
 
+### Colon directive syntax
+
+Legacy `{% list tabs %}` remains the standalone default. Opt in at factory
+creation with `transform({directiveSyntax: 'enabled'})` to accept both forms,
+or use `directiveSyntax: 'only'` for colon directives only. The default
+`'disabled'` retains the legacy-only, core-rule host contract; enabling a
+directive requires a Markdown-it host with the block and inline capabilities
+used by `@diplodoc/directive`.
+
+```markdown
+:::tabs {variant=radio group="shared"}
+
+- First
+
+  First body.
+
+- Second {selected}
+
+  Second body.
+
+:::
+```
+
+The body uses the same Markdown lists and selected markers as legacy tabs.
+`variant` is `regular` (the default), `radio`, `dropdown`, or `accordion`;
+`group`, if present, must be nonempty. A valid but disabled variant falls back
+to regular. Titles, destinations, unknown or repeated attributes, `#id` and
+`.class` are unsupported. Invalid parameters remain ordinary Markdown. An
+optional `onDiagnostic({line, reason})` reports rejected parameters with a
+one-based line; it is not a general Markdown validator and does not promise a
+diagnostic for every malformed or unclosed marker. Directive attributes do not
+require general Markdown attributes to be enabled.
+
+### Inspect legacy boundaries
+
+The pure `@diplodoc/tabs-extension/plugin` entry exports
+`recognizeTabsBoundary(tokens, index)` alongside `transform`. Pass original
+normalized block tokens before semantic core plugins run. The helper returns a
+readonly observation with a copied line map and raw source marker, or
+`undefined` when the candidate is not a recognized legacy boundary. An opening
+reports whether a variant or group was authored; an authored group includes its
+raw spelling and the value decoded by the existing Tabs parser. Unknown,
+repeated, or ambiguous parameters are reported as unsupported. Missing group
+and variant are distinct from explicitly authored defaults.
+
+This observes one edge at a time, including unclosed openings. It does not pair
+boundaries, validate nesting or body eligibility, allocate a default group ID,
+render tokens, or modify the input. A caller that rewrites source must verify
+matching scopes and renderer equivalence separately; line maps refer to the
+parser's normalized input, not original byte offsets.
+
 ## API
 
 ### Syntax

package/build/plugin/directive.d.ts

@@ -0,0 +1,18 @@
+import type { BlockContentState, DirectiveBlockState, DirectiveInlineState, DirectiveParserHost } from '@diplodoc/directive';
+import { TabsVariants } from '../common';
+export type TabsDirectiveDiagnostic = {
+    line: number;
+    reason: string;
+};
+export type TabsMarker = {
+    kind: 'open';
+    end: object;
+    variant: TabsVariants;
+    group?: string;
+} | {
+    kind: 'close';
+};
+export declare function installTabsDirective<B extends DirectiveBlockState & BlockContentState<B>, I extends DirectiveInlineState>(md: DirectiveParserHost<B, I>, markers: WeakMap<object, TabsMarker>, onDiagnostic?: (diagnostic: TabsDirectiveDiagnostic) => void): void;
+export declare function validateTabsMarkers(tokens: readonly {
+    type: string;
+}[], markers: WeakMap<object, TabsMarker>): void;

package/build/plugin/find.d.ts

@@ -5,6 +5,17 @@ import type { StateCore, Token } from './markdown-it';
  */
 import type { RuntimeTab, TabsProps } from './types';
 import type { IDGenerator } from '@diplodoc/utils';
+export type TabsBoundaryToken = {
+    readonly type: string;
+    readonly content: string;
+    readonly map: readonly [number, number] | null;
+};
+/**
+ * Allocate a default group even when a source provides an explicit group.
+ * @param generateID - Per-file ID generator
+ * @returns Generated default group
+ */
+export declare function defaultTabsGroup(generateID: IDGenerator): string;
 /**
  * Parse `{% list tabs group=... %}` content into variant and group id.
  * @param content - Raw tag content after "list tabs"
@@ -12,6 +23,34 @@ import type { IDGenerator } from '@diplodoc/utils';
  * @returns Parsed props (variant, group)
  */
 export declare function props(content: string, generateID: IDGenerator): TabsProps;
+export type TabsBoundary = {
+    readonly map: readonly [number, number] | null;
+    readonly raw: string;
+} & ({
+    readonly kind: 'open';
+    readonly variant: {
+        readonly present: false;
+    } | {
+        readonly present: true;
+        readonly raw: string;
+    };
+    readonly group: {
+        readonly present: false;
+    } | {
+        readonly present: true;
+        readonly raw: string;
+        readonly value: string;
+    };
+} | {
+    readonly kind: 'close' | 'unsupported';
+});
+/**
+ * Classify one original block edge without pairing it or validating the body.
+ * @param tokens - Original pre-semantic block tokens.
+ * @param i - Candidate paragraph index.
+ * @returns A copied boundary observation when recognized.
+ */
+export declare function recognizeTabsBoundary(tokens: readonly TabsBoundaryToken[], i: number): TabsBoundary | undefined;
 type Result = {
     step: number;
 } | {
@@ -32,7 +71,8 @@ export declare function tryToFindTabs(tokens: Token[], index: number): Result;
  * @param idx - Index after list open
  * @param closeTokenIdx - Index of {% endlist %} paragraph
  * @param TokenConstructor - Token constructor from the current MarkdownIt state
+ * @param end - Exclusive scan bound
  * @returns Array of RuntimeTab
  */
-export declare function findTabs(tokens: Token[], idx: number, closeTokenIdx: number, TokenConstructor: StateCore['Token']): RuntimeTab[];
+export declare function findTabs(tokens: Token[], idx: number, closeTokenIdx: number, TokenConstructor: StateCore['Token'], end: number): RuntimeTab[];
 export {};

package/build/plugin/index-node.d.ts

@@ -1,3 +1,9 @@
-import { type PluginOptions, type TabsPlugin } from './transform';
+import type { PluginOptions, TabsDirectivePlugin, TabsPlugin } from './transform';
 export * from './index';
-export declare function transform(options?: Partial<PluginOptions>): TabsPlugin;
+export declare function transform(options?: Partial<PluginOptions> & {
+    directiveSyntax?: 'disabled';
+}): TabsPlugin;
+export declare function transform(options: Partial<PluginOptions> & {
+    directiveSyntax: 'enabled' | 'only';
+}): TabsDirectivePlugin;
+export declare function transform(options: Partial<PluginOptions>): TabsDirectivePlugin;