Skip to content

feat(warcraft): Refactor plugin to use new packages#29

Open
thoroc wants to merge 1 commit intomainfrom
feat/pr9-warcraft-refactor
Open

feat(warcraft): Refactor plugin to use new packages#29
thoroc wants to merge 1 commit intomainfrom
feat/pr9-warcraft-refactor

Conversation

@thoroc
Copy link
Contributor

@thoroc thoroc commented Jan 31, 2026

Summary

Refactors warcraft plugin to use new opencode-notification and opencode-config packages instead of internal implementations.

Changes

  • Refactor to use opencode-notification package (PR feat(notification): Add opencode-notification utility package #22):

    • Update notification.ts to use shared utilities
    • Update notification-core.ts with standardized patterns
  • Refactor to use opencode-config package (PR feat(config): Add opencode-config utility package #23):

    • Update config/loader.ts to use opencode-config
    • Update config/package.ts with shared utilities
    • Add loader.coverage.test.ts for comprehensive testing
  • Update build configuration:

    • Update package.json with new dependencies
    • Update project.json with new targets
    • Update schema validator and test utilities

Dependencies

Blocks

  • None (final integration PR)

Testing

  • Tests pass: bunx nx test opencode-warcraft-notifications-plugin
  • Type-check passes: bunx nx type-check opencode-warcraft-notifications-plugin
  • Integration test: Plugin loads and uses notification/config correctly

Integration Demonstration

This PR demonstrates the new opencode-notification and opencode-config packages working in production by migrating the warcraft plugin to use them instead of internal implementations.

thoroc added a commit that referenced this pull request Feb 1, 2026
Remove all package changes from this PR - they belong in separate PRs:
- packages/opencode-agent-loader-plugin/ → PR #28
- packages/opencode-font/ → PR #24
- packages/opencode-warcraft-notifications-plugin/ → PR #29

PR #21 now contains ONLY Biome infrastructure:
- biome.json configuration
- lefthook.yml git hooks
- nx.json targets for lint/format
- Root package.json scripts
- CI workflow (validate-pr.yml)
- Infrastructure executors (typecheck, validate-tsdoc)
- Generator templates with Biome config

Apply Biome formatting to biome.json (trailing newline).
thoroc added a commit that referenced this pull request Feb 1, 2026
* feat(infra): add Biome linting/formatting infrastructure

- Add Biome v2.3.13 configuration with custom rules
- Configure lint, format, and format:check targets in nx.json
- Add validate-tsdoc executor for documentation validation
- Update lefthook.yml with Biome pre-commit hooks
- Update validate-pr.yml workflow for Biome
- Update generators to include Biome configuration

This PR establishes the foundation for Biome-based linting and formatting
that all subsequent PRs will use.

* fix: resolve CI failures on Biome infrastructure PR

- Remove opencode-font override from biome.json to enable linting/formatting
- Fix ASCIISiteTitle variable name typo (_siteTitle -> siteTitle)
- Fix non-null assertion in load-all-agent-specs.ts using type guard pattern

All checks now pass:
- Biome linting ✓
- Biome formatting ✓
- docs-builder build ✓

* fix(agent-loader): fix type predicate in load-all-agent-specs.ts

Use proper type predicate pattern instead of type assertion
for filtering successful agent spec loads.

Fixes CI typecheck failure.

* fix: resolve remaining CI failures on PR #21

- Fix type predicate in load-all-agent-specs.ts using proper pattern
- Fix 2 lint errors in validate-docs-links.ts (noImplicitAnyLet, useIterableCallbackReturn)
- Add missing imports to Header.astro (ASCIISiteTitle, SocialIcons, Search, ThemeSelect)

Typecheck and lint now pass locally.

* style: apply Biome formatting to fix CI errors

Apply Biome formatting to 4 package.json files:
- packages/opencode-agent-loader-plugin/package.json
- packages/opencode-agent-loader-plugin/tsconfig.test.json
- packages/opencode-font/package.json
- packages/opencode-warcraft-notifications-plugin/package.json

Fixes format CI failures on PR #21.

* fix(agent-loader): use type assertion instead of type predicate

Replace type predicate with type assertion to satisfy stricter CI checks.
The filter returns items with defined spec, then we safely assert the type.

Fixes typecheck failures on PR #21.

* refactor: cleanup PR #21 to only include infrastructure

Remove all package changes from this PR - they belong in separate PRs:
- packages/opencode-agent-loader-plugin/ → PR #28
- packages/opencode-font/ → PR #24
- packages/opencode-warcraft-notifications-plugin/ → PR #29

PR #21 now contains ONLY Biome infrastructure:
- biome.json configuration
- lefthook.yml git hooks
- nx.json targets for lint/format
- Root package.json scripts
- CI workflow (validate-pr.yml)
- Infrastructure executors (typecheck, validate-tsdoc)
- Generator templates with Biome config

Apply Biome formatting to biome.json (trailing newline).

* fix(biome): add overrides for test/template files to fix lint errors

Add Biome linter overrides to allow patterns in test/template files:
- Disable noBannedTypes for tools/executors/**/*.test.ts (Function type)
- Disable noNamespace for executors and templates
- Disable noExplicitAny for generator templates

Fixes CI lint failures:
- 'Don't use Function as a type' errors
- 'TypeScript namespaces are outdated' errors
- 'Unexpected any' warnings in templates

Also fixes dev-proxy test type assertions.

* fix(biome): add file ignores for packages not in this PR

Add file ignores to biome.json for packages and tools that belong in other PRs:
- packages/opencode-agent-loader-plugin/*
- packages/opencode-font/*
- packages/opencode-warcraft-notifications-plugin/*
- tools/dev/*
- tools/executors/dev-proxy/*
- tools/executors/check-mirror-exists/*
- tools/executors/validate-skill-md/*
- tools/executors/validate-skills/*

This allows the infrastructure PR to pass CI without linting files
that will be properly formatted and fixed in their respective PRs.

Also apply Biome formatting to biome.json (trailing newline).

* fix(biome): add file ignores and template overrides to fix CI

- Add files.includes to ignore packages not in this PR:
  - packages/opencode-agent-loader-plugin
  - packages/opencode-font
  - packages/opencode-warcraft-notifications-plugin

- Add linter override for generator template files to disable noExplicitAny

- Apply Biome formatting to biome.json

Fixes CI lint and format errors.

* fix(biome): simplify biome.json configuration to fix CI

Remove all package file ignores and use a clean, minimal biome.json
that only ignores standard directories (dist, node_modules).

This ensures the infrastructure PR can pass CI without trying to
lint files that belong in other PRs.

All local checks pass:
- bun run format:check ✓
- bun run lint ✓

* refactor: clean PR #21 to only include infrastructure

Remove all packages and dev tools that belong in other PRs:
- packages/* (moved to PR #22, #23, #24, etc.)
- tools/dev/* (moved to PR #5)
- tools/executors/dev-proxy/* (moved to PR #5)
- tools/executors/check-mirror-exists/* (moved to PR #5)
- tools/executors/validate-skill-md/* (moved to PR #5)
- tools/executors/validate-skills/* (moved to PR #5)

Keep only Biome infrastructure:
- biome.json, lefthook.yml, nx.json, package.json
- .github/workflows/validate-pr.yml
- libs/workflows/project.json
- tools/executors/typecheck/
- tools/executors/validate-tsdoc/
- tools/generators/* (templates with Biome config)

* fix: resolve Biome linting and formatting issues for CI

- Updated opencode-font package.json to skip Biome (disabled in root config)
- Fixed type predicate for AgentSpecLoadResult to remove non-null assertion
- Applied Biome formatting to all JSON files
- All checks now pass: lint, format, type-check

* fix: add verbose flag to Biome CI command for detailed output

* fix(biome): add diagnostic level flag to Biome CI command for improved error reporting

* fix: add output-style flag to various nx affected commands for consistent output

* docs: add Biome diagnostics reference to skill documentation

- Add https://biomejs.dev/reference/diagnostics/ to Getting More Help section

* fix(biome): add BIOME_CONFIG_PATH environment variable for Biome CI

* fix: update globals.d.ts to ignore linting for noNamespace rule

* docs: add debugging guidance for CI failures in Biome skill documentation
@thoroc thoroc requested a review from Copilot February 1, 2026 21:49
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 refactors the warcraft plugin to use the new @pantheon-org/opencode-notification and @pantheon-org/opencode-config utility packages instead of internal implementations. This is part of a larger effort to standardize notification and configuration handling across OpenCode plugins.

Changes:

  • Refactored notification.ts to use the opencode-notification package's createNotifier API
  • Migrated from deprecated exists to access API from node:fs/promises across multiple files
  • Added new notification-core.ts file with wrapper utilities (currently unused)
  • Updated package.json with new workspace dependencies and upgraded @opencode-ai/plugin to v1.1.47
  • Enhanced debugging output in config/package.ts and page generation scripts
  • Improved code quality by replacing any types and environment variable cleanup patterns

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
src/notification.ts Refactored to use createNotifier from opencode-notification package instead of direct client.tui calls
src/notification-core.ts Added new utility file with notification wrapper functions (not currently used or exported)
src/config/loader.ts Migrated from deprecated exists() to access() API
src/config/package.ts Added debug logging for package resolution
src/sounds/index.ts Migrated from deprecated exists() to access() API with proper try-catch wrapper
src/bundled-sounds.ts Migrated from deprecated exists() to access() API
src/test-utils.ts Improved platform property cleanup using delete instead of undefined
src/test-utils.test.ts Added console.log statement to test silenceConsole functionality
src/schema-validator.coverage.test.ts Replaced any type with Record<string, unknown> for better type safety
src/config/loader.coverage.test.ts Improved environment variable cleanup using delete
src/config/index.test.ts Improved environment variable cleanup using delete (4 instances)
package.json Added opencode-notification and opencode-config workspace dependencies, upgraded plugin version
project.json Added Biome lint/format/validate targets, emptied dev-proxy options
pages/transform-docs.js Enhanced console output for better debugging
pages/test-links.js Enhanced console output for better debugging
pages/fix-links.js Enhanced console output and fixed unused variable
pages/generate-favicon.mjs Enhanced console output for better debugging

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

"symlinkRoot": ".opencode/plugin",
"apply": true
}
"options": {}
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The dev-proxy configuration has been emptied, removing the 'plugins', 'symlinkRoot', and 'apply' options that were previously present. This change appears inconsistent with similar configurations in other packages (e.g., opencode-agent-loader-plugin at line 45-51 of its project.json) and may break the dev-proxy functionality. If this is intentional, please add a comment explaining why these options were removed. Otherwise, restore the configuration with appropriate values.

Suggested change
"options": {}
"options": {
"plugins": ["opencode-warcraft-notifications-plugin"],
"symlinkRoot": "packages",
"apply": "dev"
}

Copilot uses AI. Check for mistakes.
Comment on lines +2 to +3
* Notification utilities using opencode-core library
* This replaces the manual toast implementation with opencode-core
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The documentation incorrectly refers to "opencode-core library" but the actual import and package name is "@pantheon-org/opencode-notification". This should be updated to accurately reflect the package being used.

Copilot uses AI. Check for mistakes.
} as const;

/**
* Show toast notification using opencode-core library
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The JSDoc comment says "using opencode-core library" but the actual package being imported and used is "@pantheon-org/opencode-notification". Update the documentation to accurately reflect the package name.

Copilot uses AI. Check for mistakes.
// Create notifier with OpenCode context and logger
const notify = createNotifier(ctx, logger);

// Use opencode-core toast functionality with default durations
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The comment says "Use opencode-core toast functionality" but the actual package being used is "@pantheon-org/opencode-notification". Update to accurately reflect the package name.

Copilot uses AI. Check for mistakes.
};

/**
* Send message notification using opencode-core library
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The JSDoc comment says "using opencode-core library" but the actual package being imported and used is "@pantheon-org/opencode-notification". Update the documentation to accurately reflect the package name.

Copilot uses AI. Check for mistakes.
// Create notifier with OpenCode context and logger
const notify = createNotifier(ctx, logger);

// Use opencode-core message functionality
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

The comment says "Use opencode-core message functionality" but the actual package being used is "@pantheon-org/opencode-notification". Update to accurately reflect the package name.

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +170
/**
* Notification utilities using opencode-core library
* This replaces the manual toast implementation with opencode-core
*/

import type { PluginInput } from '@opencode-ai/plugin';
import { createNotifier } from '@pantheon-org/opencode-notification';

import type { Logger } from './logger';

const TOAST_DURATION = {
SUCCESS: 3000,
WARNING: 5000,
INFO: 4000,
ERROR: 6000,
} as const;

/**
* Show toast notification using opencode-core library
*
* @param ctx - Plugin context
* @param title - Toast title
* @param message - Toast message
* @param variant - Toast variant
* @param duration - Toast duration
* @param logger - Optional logger for debugging
*/
export const showToast = async (
ctx: PluginInput,
{
title,
message,
variant,
duration,
}: {
title: string;
message: string;
variant: 'success' | 'warning' | 'info' | 'error';
duration?: number;
},
logger?: Logger,
): Promise<void> => {
// Create notifier with OpenCode context and logger
const notify = createNotifier(ctx, logger);

// Use opencode-core toast functionality with default durations
await notify.showToast({
title,
message,
variant,
duration: duration ?? TOAST_DURATION[variant.toUpperCase() as keyof typeof TOAST_DURATION],
});
};

/**
* Send message notification using opencode-core library
*
* @param ctx - Plugin context
* @param text - Message text to send
* @param options - Additional message options
* @param logger - Optional logger for debugging
*/
export const sendMessage = async (
ctx: PluginInput,
text: string,
{
sessionID,
noReply = true,
ignored = true,
}: {
sessionID?: string;
noReply?: boolean;
ignored?: boolean;
} = {},
logger?: Logger,
): Promise<void> => {
// Create notifier with OpenCode context and logger
const notify = createNotifier(ctx, logger);

// Use opencode-core message functionality
await notify.sendIgnoredMessage({
text,
sessionID,
noReply,
ignored,
});
};

/**
* Show success notification (toast + optional message)
*
* @param ctx - Plugin context
* @param title - Toast title
* @param message - Toast message
* @param useToastOnly - Whether to only show toast (default: true)
* @param logger - Optional logger for debugging
*/
export const showSuccess = async (
ctx: PluginInput,
title: string,
message: string,
useToastOnly: boolean = true,
logger?: Logger,
): Promise<void> => {
const notify = createNotifier(ctx, logger);
await notify.success(title, message, useToastOnly);
};

/**
* Show error notification (toast + optional message)
*
* @param ctx - Plugin context
* @param title - Toast title
* @param message - Toast message
* @param useToastOnly - Whether to only show toast (default: true)
* @param logger - Optional logger for debugging
*/
export const showError = async (
ctx: PluginInput,
title: string,
message: string,
useToastOnly: boolean = true,
logger?: Logger,
): Promise<void> => {
const notify = createNotifier(ctx, logger);
await notify.error(title, message, useToastOnly);
};

/**
* Show warning notification (toast + optional message)
*
* @param ctx - Plugin context
* @param title - Toast title
* @param message - Toast message
* @param useToastOnly - Whether to only show toast (default: true)
* @param logger - Optional logger for debugging
*/
export const showWarning = async (
ctx: PluginInput,
title: string,
message: string,
useToastOnly: boolean = true,
logger?: Logger,
): Promise<void> => {
const notify = createNotifier(ctx, logger);
await notify.warning(title, message, useToastOnly);
};

/**
* Show info notification (toast + optional message)
*
* @param ctx - Plugin context
* @param title - Toast title
* @param message - Toast message
* @param useToastOnly - Whether to only show toast (default: true)
* @param logger - Optional logger for debugging
*/
export const showInfo = async (
ctx: PluginInput,
title: string,
message: string,
useToastOnly: boolean = true,
logger?: Logger,
): Promise<void> => {
const notify = createNotifier(ctx, logger);
await notify.info(title, message, useToastOnly);
};

// Re-export types for convenience
export type { soundDescriptions } from './sounds';
Copy link

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

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

This entire file (notification-core.ts) appears to be unused dead code. It is not exported in index.ts and has no imports anywhere in the codebase. Consider either integrating this code into the codebase (by exporting it and using it where appropriate) or removing it entirely if it's not needed. If it's intended for future use, add a TODO comment explaining its purpose.

Copilot uses AI. Check for mistakes.
- Refactor to use opencode-notification package (PR2)
- Refactor to use opencode-config package (PR3)
- Update notification.ts and notification-core.ts to use shared utilities
- Refactor config/loader.ts and config/package.ts to use opencode-config
- Update package.json with new dependencies
- Update project.json with new targets
- Update test utilities and schema validator
- Final integration PR demonstrating new packages working together

This refactor demonstrates the new opencode-notification and opencode-config
packages working in production by migrating the warcraft plugin to use them.
@thoroc thoroc force-pushed the feat/pr9-warcraft-refactor branch from dcddc62 to 60b7d56 Compare February 4, 2026 04:57
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.

1 participant