Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial Toolkit Scaffold #34

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Initial Toolkit Scaffold #34

wants to merge 9 commits into from

Conversation

josephfusco
Copy link
Member

@josephfusco josephfusco commented Feb 5, 2025 •
edited
Loading

This PR sets up the foundational structure for the Headless WordPress Toolkit, establishing key components and development workflows.

Changes

  • 📦 Set up monorepo structure with PNPM workspaces
  • 🛠️ Created initial CLI package (@hwp/cli)
  • 🔌 Added base WordPress plugin (hwp-cli)
  • 🧪 Configured E2E testing with Playwright
  • 📝 Added comprehensive documentation
  • 🚀 Included basic example implementation

Technical Details

  • Uses ES Modules throughout (no TypeScript)
  • Implements WordPress VIP coding standards for PHP
  • Configured local development environment with wp-env
  • Added development scripts for common tasks
  • Set up E2E test infrastructure

Testing

  1. Clone the repository
  2. Run pnpm install
  3. Start the dev environment: pnpm dev
  4. Verify CLI works: pnpm dlx @hwp/cli status

Solves #33

@josephfusco josephfusco requested a review from a team as a code owner February 5, 2025 17:16
@josephfusco josephfusco linked an issue Feb 5, 2025 that may be closed by this pull request
Scaffold Implement #33
Open
moonmeister
moonmeister requested changes Feb 5, 2025
View reviewed changes
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/basic-cli/.env.example Outdated Show resolved Hide resolved
packages/README.md
Comment on lines +7 to +8
- `@hwp/cli`: Command-line interface for managing HWP plugins and tools
- `@hwp/test-e2e`: End-to-end tests for headless WordPress sites
Copy link
Member

Choose a reason for hiding this comment

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

I am generally confused about these. We've never talked about a test suite for HWP sites. What is it for? Why not wait to add it when we're actually working on it?

packages/cli/package.json
@@ -0,0 +1,25 @@
{
"name": "@hwp/cli",
"version": "1.0.0",
Copy link
Member

Choose a reason for hiding this comment

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

maybe 0.0.1 on the version?

packages/cli/package.json Outdated Show resolved Hide resolved
packages/test-e2e/package.json Outdated Show resolved Hide resolved
packages/test-e2e/test-results/.last-run.json Outdated Show resolved Hide resolved
plugins/hwp-cli/README.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

what does this do that we can't accomplish normally?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@moonmeister moonmeister moonmeister requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Scaffold Implement
2 participants
@josephfusco @moonmeister