@jay-framework/jay-stack-cli 0.9.0 → 0.11.0

package/README.md

@@ -14,16 +14,68 @@ npm install @jay-framework/stack-cli
 
 ## Usage
 
-### Basic Usage
+### Commands
 
-Simply run the CLI from your project root:
+#### `jay-stack dev [path]`
+
+Start the development server:
 
 ```bash
-@jay-framework/@jay-framework/jay-cli
+jay-stack dev              # Start dev server in current directory
+jay-stack dev ./my-project # Start dev server in specified directory
 ```
 
 This will start both the development server and editor server with default configuration.
 
+#### `jay-stack validate [path]`
+
+Validate all `.jay-html` and `.jay-contract` files in the project without creating output files:
+
+```bash
+jay-stack validate              # Validate files in pagesBase from config
+jay-stack validate ./src/pages  # Validate files in specified directory
+jay-stack validate --verbose    # Show per-file validation status
+jay-stack validate --json       # Output results as JSON (for CI/tooling)
+```
+
+This command is useful for:
+
+- **CI pipelines**: Returns exit code 1 on validation errors
+- **Development workflow**: Quick syntax checking without running the dev server
+- **Vite integration**: Validate generated `.jay-html` files
+
+Example output:
+
+```
+✅ Jay Stack validation successful!
+
+Scanned 12 .jay-html files, 5 .jay-contract files
+No errors found.
+```
+
+Or with errors:
+
+```
+❌ Jay Stack validation failed
+
+Errors:
+  ❌ src/pages/product/page.jay-html
+     jay file should have exactly one jay-data script, found 2
+
+1 error(s) found, 11 file(s) valid.
+```
+
+#### `jay-stack validate-plugin [path]`
+
+Validate a Jay Stack plugin package:
+
+```bash
+jay-stack validate-plugin              # Validate plugin in current directory
+jay-stack validate-plugin ./my-plugin  # Validate plugin in specified directory
+jay-stack validate-plugin --verbose    # Show detailed validation output
+jay-stack validate-plugin --strict     # Treat warnings as errors (for CI)
+```
+
 ### Configuration
 
 The CLI uses a `.jay` configuration file (YAML format) to customize port ranges for both servers. Create a `.jay` file in your project root:
@@ -143,15 +195,29 @@ The CLI is built using:
 - **get-port** - Automatic port discovery
 - **Vite** - Build tool integration
 
-## Future Enhancements
+## CLI Reference
+
+| Command                            | Description                              |
+| ---------------------------------- | ---------------------------------------- |
+| `jay-stack dev [path]`             | Start the development server             |
+| `jay-stack validate [path]`        | Validate jay-html and jay-contract files |
+| `jay-stack validate-plugin [path]` | Validate a plugin package                |
+
+### Validate Command Options
+
+| Option          | Description                     |
+| --------------- | ------------------------------- |
+| `-v, --verbose` | Show per-file validation status |
+| `--json`        | Output results as JSON          |
 
-**Note**: The CLI currently does not accept command-line parameters. This will change in future versions to support:
+### Validate-Plugin Command Options
 
-- Custom pages directory path
-- Custom TypeScript configuration file
-- Custom output directory
-- Additional server configuration options
-- Development vs production modes
+| Option             | Description                            |
+| ------------------ | -------------------------------------- |
+| `-v, --verbose`    | Show detailed validation output        |
+| `--strict`         | Treat warnings as errors (for CI)      |
+| `--local`          | Validate local plugins in src/plugins/ |
+| `--generate-types` | Generate .d.ts files for contracts     |
 
 ## Related Packages
 

package/dist/index.d.ts

@@ -1,4 +1,9 @@
-import { PublishMessage, PublishResponse, SaveImageMessage, SaveImageResponse, HasImageMessage, HasImageResponse } from '@jay-framework/editor-protocol';
+import { PublishMessage, PublishResponse, SaveImageMessage, SaveImageResponse, HasImageMessage, HasImageResponse, GetProjectInfoMessage, GetProjectInfoResponse } from '@jay-framework/editor-protocol';
+
+interface StartDevServerOptions {
+    projectPath?: string;
+}
+declare function startDevServer(options?: StartDevServerOptions): Promise<void>;
 
 interface JayConfig {
     devServer?: {
@@ -6,6 +11,7 @@ interface JayConfig {
         pagesBase?: string;
         componentsBase?: string;
         publicFolder?: string;
+        configBase?: string;
     };
     editorServer?: {
         portRange?: [number, number];
@@ -16,10 +22,11 @@ declare function loadConfig(): JayConfig;
 declare function getConfigWithDefaults(config: JayConfig): Required<JayConfig>;
 declare function updateConfig(updates: Partial<JayConfig>): void;
 
-declare function createEditorHandlers(config: Required<JayConfig>, tsConfigPath: string): {
+declare function createEditorHandlers(config: Required<JayConfig>, tsConfigPath: string, projectRoot: string): {
     onPublish: (params: PublishMessage) => Promise<PublishResponse>;
     onSaveImage: (params: SaveImageMessage) => Promise<SaveImageResponse>;
     onHasImage: (params: HasImageMessage) => Promise<HasImageResponse>;
+    onGetProjectInfo: (params: GetProjectInfoMessage) => Promise<GetProjectInfoResponse>;
 };
 
-export { type JayConfig, createEditorHandlers, getConfigWithDefaults, loadConfig, updateConfig };
+export { type JayConfig, type StartDevServerOptions, createEditorHandlers, getConfigWithDefaults, loadConfig, startDevServer, updateConfig };