Skip to content

Conversation

@ultmaster
Copy link
Contributor

@ultmaster ultmaster commented Jun 19, 2025

This pull request introduces enhancements to documentation, new example files demonstrating POML features, and updates to the codebase to improve usability and functionality. The most important changes include updates to the README.md for better clarity, the addition of several POML examples showcasing diverse use cases, and improvements to the Visual Studio Code extension and CLI commands for better configuration handling.

Documentation Updates:

  • README.md: Updated instructions for installing the Visual Studio Code extension and added details on configuring language model settings.
  • examples/README.md: Added an overview of the POML example library, organized examples by difficulty, and provided guidelines for contributing.

New POML Examples:

Beginner examples:

Intermediate examples:

Advanced examples:

Codebase Enhancements:

Visual Studio Code extension:

CLI improvements:

  • packages/poml/cli.ts: Added a cwd option to specify the working directory, enhancing flexibility for file-based operations.

@ultmaster ultmaster requested a review from Copilot June 19, 2025 10:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses several user experience issues by improving file path resolution, adding asynchronous finalization in tests, and enhancing language model settings verification. Key changes include:

  • Enhancements to file handling using an optional working directory (cwd) in the CLI and index functions.
  • Addition of a finalizer in tests to support lingering async operations and improved language model settings checks in the VS Code command.
  • New and updated examples in the examples folder, including one incomplete function in the 301_generate_poml.poml file.

Reviewed Changes

Copilot reviewed 21 out of 30 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/poml/tests/index.test.tsx Added fs/path imports, afterAll finalizer, and dynamic test generation for examples compilation.
packages/poml/index.ts Introduced cwd support for working directory resolution and updated file path handling.
packages/poml/cli.ts Added a new cwd option in the CLI arguments.
packages/poml-vscode/command/testCommand.ts Added language model settings verification with error reporting.
examples/* Various updates including new assets, JSON/CSV data changes, and updated POML examples (one incomplete function noted).
README.md Revised installation instructions and configuration guidance.

/* Write a entertaining story that is engaging, imaginative and captivating for the audience. */
<span whiteSpace="trim">
function storyteller() {
return
Copy link

Copilot AI Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation of the 'storyteller' function appears incomplete. Consider providing a proper return value or implementation to prevent unexpected runtime behavior.

Suggested change
return
return {{storyteller.replace(/^/gm, ' ').trimStart()}};

Copilot uses AI. Check for mistakes.
@ultmaster ultmaster merged commit 3971fa2 into main Jun 19, 2025
3 checks passed
@ultmaster ultmaster deleted the user-experience-0618 branch July 9, 2025 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants