Extended reader proposal

[ultmaster]

No description provided.

[Copilot]

Pull Request Overview

This PR lays the groundwork for an extended POML reader by introducing new reader subclasses, a segment interface with a stubbed segmentation function, and a detailed design proposal document.

• Add scaffolding for PureTextReader, PomlReader, MetaReader, and DispatchReader classes
• Define a Segment interface and stub out createSegments
• Include an extended POML format design spec and update VSCode settings

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/poml/reader/text.tsx	Adds PureTextReader subclass of Reader
packages/poml/reader/segment.ts	Defines Segment interface and unimplemented createSegments
packages/poml/reader/poml.tsx	Adds PomlReader subclass of Reader
packages/poml/reader/meta.ts	Adds MetaReader subclass (missing export)
packages/poml/reader/index.tsx	Adds DispatchReader subclass (missing export)
packages/poml/reader/base.tsx	Introduces base Reader class with abstract methods
docs/proposals/poml_extended.md	New design spec for extended POML file format
.vscode/settings.json	Adds typescriptreact editor tab size setting

Comments suppressed due to low confidence (3)

packages/poml/reader/segment.ts:20

• The createSegments function is currently unimplemented and will throw an error at runtime. Provide an implementation or at least add a TODO and corresponding tests to cover this behavior.

  throw new Error('createSegments is not implemented yet');

packages/poml/reader/meta.ts:3

• The MetaReader class is not exported, so it cannot be imported elsewhere. Add export before the class declaration.

class MetaReader extends Reader {

packages/poml/reader/index.tsx:3

• The DispatchReader class is not exported, preventing external usage. Add export before the class declaration.

class DispatchReader extends Reader {

[Copilot]

[nitpick] The PureTextReader class is empty and doesn’t override required methods. Implement or stub out react, getHoverToken, and getCompletions to clarify intended behavior.

Suggested change

	export class PureTextReader extends Reader {
	export class PureTextReader extends Reader {
	/**
	* React to changes or events.
	* Placeholder method. Requires implementation.
	*/
	react(event: any): void {
	// TODO: Implement the react method
	console.log("React method called with event:", event);
	}
	/**
	* Get the token to display on hover.
	* Placeholder method. Requires implementation.
	*/
	getHoverToken(position: any): string | null {
	// TODO: Implement the getHoverToken method
	console.log("getHoverToken method called with position:", position);
	return null;
	}
	/**
	* Get completion suggestions.
	* Placeholder method. Requires implementation.
	*/
	getCompletions(context: any): string[] {
	// TODO: Implement the getCompletions method
	console.log("getCompletions method called with context:", context);
	return [];
	}

[Copilot]

Use “Metadata” (uncountable) instead of “Metadatas”. Consider revising to “Metadata is information that is useful…”.

Suggested change

	Metadatas are information that is useful when parsing and rendering the file, such as context variables, stylesheets, version information, file paths, etc.
	Metadata is information that is useful when parsing and rendering the file, such as context variables, stylesheets, version information, file paths, etc.

[cursor]

Bug: Reader Class Mismatches Interface Methods

The Reader class implementation in packages/poml/reader/base.tsx does not align with the Reader interface defined in the docs/proposals/poml_extended.md design document. Specifically:

• The documented read(segment: Segment, context: PomlContext?) method is implemented as react(context?: PomlContext), with the segment parameter being passed to the Reader's constructor instead of the method.
• The documented getHoverToken(segment: Segment, offset: number) method is implemented as getHoverToken(offset: number), missing the segment parameter.

packages/poml/reader/base.tsx#L28-L35

poml/packages/poml/reader/base.tsx

Lines 28 to 35 in b28c535

	public react(context?: PomlContext): React.ReactElement {
	throw new Error('Method react() not implemented');
	}
	public getHoverToken(offset: number): PomlToken | undefined {
	throw new Error('Method getHoverToken() not implemented');
	}

docs/proposals/poml_extended.md#L184-L189

poml/docs/proposals/poml_extended.md

Lines 184 to 189 in b28c535

	```typescript
	interface Reader {
	read(segment: Segment, context: PomlContext?): React.ReactElement;
	getHoverToken(segment: Segment, offset: number): PomlToken | undefined;
	getCompletions(offset: number): PomlToken[];
	}

Fix in Cursor • Fix in Web

---

BugBot free trial expires on July 22, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎