Add npm package build and publish flow by ultmaster · Pull Request #36 · microsoft/poml

ultmaster · 2025-07-01T06:52:47Z

This pull request introduces significant changes to enhance the functionality of the poml library, improve dependency management, and replace the pdf-parse library with pdfjs-dist for PDF handling. Additionally, it includes updates to build configurations and test cases to ensure compatibility and maintainability.

New Features and Enhancements:

Added poml npm package: Created a new npm package for the Prompt Orchestration Markup Language (POML), including its build scripts, dependencies, and CLI support. (packages/poml-build/package.json, packages/poml-build/rollup.confg.js, packages/poml-build/tsconfig.json, packages/poml/cli.ts) [1] [2] [3] [4]

Dependency and Library Updates:

Replaced pdf-parse with pdfjs-dist: Migrated from pdf-parse to pdfjs-dist for PDF parsing, adding utility functions pdfParse and getNumPages in packages/poml/util/pdf.ts. Updated related imports and logic in document.tsx to use the new library. (packages/poml/util/pdf.ts, packages/poml/components/document.tsx) [1] [2]
Updated package.json dependencies: Added new dependencies like @rollup/plugin-commonjs, @rollup/plugin-json, and pdfjs-dist. Upgraded several dev dependencies, including @typescript-eslint and typescript. (package.json) [1] [2]

Build and Configuration Changes:

Updated workflows for npm package publishing: Modified .github/workflows/publish.yml to build, pack, and publish the poml npm package on Ubuntu. (.github/workflows/publish.yml)
Webpack and .vscodeignore updates: Adjusted configurations to include pdfjs-dist and exclude pdf-parse in the build and packaging process. (webpack.config.cli.js, webpack.config.extension.js, vscodeignore.js) [1] [2] [3]

Codebase Refactoring and Testing:

Refactored type definitions and imports: Replaced interfaces with type aliases for flexibility and cleaned up unnecessary ESLint comments. (packages/poml/writer.ts, packages/poml/util/xmlContentAssist.js) [1] [2] [3]
Test improvements: Enhanced test cases by suppressing irrelevant warnings and updating assertions for better reliability. (packages/poml/tests/util.test.tsx, packages/poml/tests/writer.test.tsx) [1] [2] [3]## Summary

add npm package configuration for packages/poml
provide tsconfig for building the package
add npm scripts for building, packing and publishing the library
extend publish.yml workflow to pack and publish the npm package

Testing

npm run build-webview
npm run build-cli
npm run lint
npm test
python -m pytest python/tests

https://chatgpt.com/codex/tasks/task_e_686378fcbccc832e982df1c701717dbd

…dd-github-actions-for-npm-package

Copilot

Pull Request Overview

Adds build and publish flow for the poml npm package, including configuration, build scripts, and CI workflow extensions

Extended webpack configs and .vscodeignore to accommodate pdfjs-dist and canvas
Introduced a new pdf.ts utility for PDF parsing via pdfjs-dist and updated document rendering
Added packages/poml-build setup (tsconfig, Rollup config, package.json) and CI steps to pack/publish the library

Reviewed Changes

Copilot reviewed 18 out of 22 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
webpack.config.extension.js	Added `pdfjs-dist` and `canvas` to externals
webpack.config.cli.js	Added `pdfjs-dist` and `canvas` externals to CLI build
vscodeignore.js	Updated `.vscodeignore` generation and rootPackages comment
packages/poml/writer.ts	Changed empty option interfaces to `any` types
packages/poml/util/xmlContentAssist.js	Simplified ESLint disable comments
packages/poml/util/pdf.ts	New PDF parsing utility using `pdfjs-dist`
packages/poml/components/document.tsx	Switched from `pdf-parse` to `pdfParse` and `getNumPages`
packages/poml/tests/writer.test.tsx	Overrode and restored `console.warn` in one test
packages/poml/tests/util.test.tsx	Broadened test matcher for loading output
packages/poml/index.ts	Exported types separately
packages/poml/cli.ts	Added Node.js shebang for CLI
packages/poml-build/tsconfig.json	New TS config for building the package
packages/poml-build/rollup.confg.js	Rollup setup for ESM/CJS outputs
packages/poml-build/package.json	npm metadata, scripts, dependencies for publishing `poml`
package.json (root)	Updated devDependencies and overrides
.vscodeignore (root)	Updated to include `pdfjs-dist`
.github/workflows/publish.yml	Added CI steps to pack and publish the npm package

Comments suppressed due to low confidence (2)

.github/workflows/publish.yml:127

The 'pack-poml-lib' script isn't defined in the root package.json; either define this script or adjust the workflow to use the correct packaging command/path.

      run: npm run pack-poml-lib

packages/poml-build/rollup.confg.js:20

The comment says 'Turn off source maps for production' but sourcemap is enabled; update the comment to reflect the actual behavior or disable source maps if that was intended.

      sourcemap: true, // Turn off source maps for production

Copilot · 2025-07-08T07:30:39Z

packages/poml-build/rollup.confg.js

@@ -0,0 +1,38 @@
+import commonjs from '@rollup/plugin-commonjs';


Filename 'rollup.confg.js' has a typo; it should be 'rollup.config.js' so Rollup can locate and use this configuration.

Copilot · 2025-07-08T07:30:39Z

vscodeignore.js

-const rootPackages = ['sharp', 'pdf-parse'];
+// For example:
+// const rootPackages = ['sharp', 'pdf-parse', 'pdfjs-dist'];
+const rootPackages = ['sharp'];


[nitpick] Since you've added pdfjs-dist and canvas as externals, consider including them in rootPackages so they aren't inadvertently ignored during shipping.

Suggested change

const rootPackages = ['sharp'];

const rootPackages = ['sharp', 'pdfjs-dist', 'canvas'];

Copilot · 2025-07-08T07:30:40Z

packages/poml/tests/writer.test.tsx

  });

  test('emptyMessages', () => {
+    // Turn off console.warn in this test case.


[nitpick] Consider using a try/finally block or Jest's setup/teardown hooks to ensure console.warn is always restored, even if the test throws an error.

Copilot · 2025-07-08T07:30:40Z

packages/poml/util/xmlContentAssist.js

+} = require('lodash');  // eslint-disable-line
+const { BaseXmlCstVisitor } = require('@xml-tools/parser');  // eslint-disable-line
+const { findNextTextualToken } = require('@xml-tools/common');  // eslint-disable-line


Using a generic eslint-disable-line can suppress unrelated warnings; consider specifying the exact rule(s) (e.g., @typescript-eslint/no-var-requires) to disable.

Suggested change

} = require('lodash'); // eslint-disable-line

const { BaseXmlCstVisitor } = require('@xml-tools/parser'); // eslint-disable-line

const { findNextTextualToken } = require('@xml-tools/common'); // eslint-disable-line

} = require('lodash'); // eslint-disable-line @typescript-eslint/no-var-requires

const { BaseXmlCstVisitor } = require('@xml-tools/parser'); // eslint-disable-line @typescript-eslint/no-var-requires

const { findNextTextualToken } = require('@xml-tools/common'); // eslint-disable-line @typescript-eslint/no-var-requires

Copilot · 2025-07-08T07:30:40Z

packages/poml/writer.ts

 }

-interface FreeOptions { }
+type FreeOptions = any;


[nitpick] Defining FreeOptions as any disables type safety; consider creating a more specific interface or extending an existing type to improve maintainability.

Suggested change

type FreeOptions = any;

interface FreeOptions {}

feat: add npm package build and publish

a27e39b

ultmaster added the codex label Jul 1, 2025 — with ChatGPT Codex Connector

ultmaster added 6 commits July 2, 2025 18:26

update package.json

b6176ba

.

d8614fe

add rollup

6600cb3

fix pdf-parse

f8578b6

still minor bugs

018c27c

update pdfjs-dist

cd640ca

ultmaster added the v0.1 label Jul 3, 2025

ultmaster added 9 commits July 3, 2025 23:40

.

cca8d6b

.

d1a099d

update package.json

c96f2df

relock

6380ad6

canvas is still here

0df1f76

update package lock

f9f388e

override jsdom dependency

8e4d853

Merge branch 'main' of https://github.com/microsoft/poml into codex/a…

e1f0881

…dd-github-actions-for-npm-package

upgrade typescript and fix console log and warn

27ac9d5

ultmaster marked this pull request as ready for review July 8, 2025 07:28

Copilot AI review requested due to automatic review settings July 8, 2025 07:28

Copilot AI reviewed Jul 8, 2025

View reviewed changes

ultmaster added 2 commits July 8, 2025 15:30

fix publish pipeline

2bd00fe

fix comments

a8d77a5

ultmaster merged commit 7ef3e14 into main Jul 8, 2025
4 checks passed

ultmaster deleted the codex/add-github-actions-for-npm-package branch August 27, 2025 00:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add npm package build and publish flow#36

Add npm package build and publish flow#36
ultmaster merged 18 commits intomainfrom
codex/add-github-actions-for-npm-package

ultmaster commented Jul 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 8, 2025

Uh oh!

Copilot AI Jul 8, 2025

Uh oh!

Copilot AI Jul 8, 2025

Uh oh!

Copilot AI Jul 8, 2025

Uh oh!

Copilot AI Jul 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1,38 @@
		import commonjs from '@rollup/plugin-commonjs';

	const rootPackages = ['sharp'];
	const rootPackages = ['sharp', 'pdfjs-dist', 'canvas'];

Conversation

ultmaster commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Features and Enhancements:

Dependency and Library Updates:

Build and Configuration Changes:

Codebase Refactoring and Testing:

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ultmaster commented Jul 1, 2025 •

edited

Loading