Skip to content

TESTING.md

Latest commit

 

History

History
166 lines (110 loc) · 3.48 KB

TESTING.md

File metadata and controls

166 lines (110 loc) · 3.48 KB

Testing PostScript Preview Extension

This guide explains how to test the extension locally during development.

Prerequisites

Ensure you have the following installed:

  1. Node.js (v14 or later)
  2. GhostScript (provides ps2pdf)
  3. Poppler (provides pdftocairo and pdfinfo)

Verify Prerequisites

# Check if commands are available
ps2pdf --help
pdftocairo --help
pdfinfo --help

Setup

  1. Install dependencies:

    yarn install

  2. Compile TypeScript:

    yarn compile

Running the Extension

Method 1: VS Code Debugger (Recommended)

  1. Open the project in VS Code
  2. Press F5 or go to Run → Start Debugging
  3. A new VS Code window will open ("[Extension Development Host]")
  4. In the new window, open a .ps or .eps file
  5. Click the preview icon in the editor title bar

Method 2: Watch Mode

For continuous development with auto-compilation:

yarn watch

Then press F5 to launch the Extension Development Host.

Test Files

Test files are located in examples/:

File Purpose
sample.eps Sample EPS file
basic_shapes.ps Basic single-page PostScript
triangle_grid.ps PostScript with shapes and grid
multipage.ps 3-page document for testing navigation

Features to Test

1. Basic Preview

  • Open examples/basic_shapes.ps
  • Click preview icon → Preview should appear

2. Multi-Page Navigation

  • Open examples/multipage.ps
  • Verify Prev/Next buttons appear
  • Test page navigation and direct page input

3. Console Output

  • Open examples/multipage.ps
  • Preview the file
  • Open Output panel (Ctrl+Shift+U)
  • Select "PostScript-Preview" → Should show GhostScript output

4. Custom Paths Configuration

  • Open Settings (Ctrl+,)
  • Search "postscript-preview"
  • Verify 3 path settings appear

5. Zoom & Background

  • Use +/- buttons for zoom
  • Click color picker to change background
  • Test "Hide Controls" button

6. Auto-Refresh

  • Preview a file
  • Edit and save the PostScript file
  • Preview should auto-update

Running Tests

yarn test

Packaging

Build a VSIX package for local installation:

npm install -g @vscode/vsce
vsce package

Install the generated .vsix file via: Extensions → ⋯ → Install from VSIX...

Publishing to VS Code Marketplace

Prerequisites

  1. Create a Personal Access Token (PAT) - see official instructions

  2. Login to vsce:

    vsce login ahnafnafee

Release Checklist

Before publishing a new version:

  1. Update version in package.json
  2. Update CHANGELOG.md with new features/fixes
  3. Compile and test locally (yarn compile + F5)
  4. Build package to verify: vsce package

Publish

vsce publish

Or publish with a version bump:

vsce publish patch  # 0.5.0 → 0.5.1
vsce publish minor  # 0.5.0 → 0.6.0
vsce publish major  # 0.5.0 → 1.0.0

View Published Extension

https://marketplace.visualstudio.com/manage

Debugging Tips

  • Use console.log() statements in TypeScript code
  • View debug output in Debug Console panel when running with F5
  • Check the Output panel for "PostScript-Preview" logs