- 
- 
-
-
- 
-
-
- 
+
+
+
Preview PostScript and EPS files without leaving Visual Studio Code.
+ ++ Visual Studio Marketplace · + Open VSX · + Changelog · + Feedback
-
+ 
+
+1. Install [PostScript Preview from the Visual Studio Marketplace][marketplace-link] or [Open VSX][open-vsx-link].
+2. Install [Ghostscript](https://www.ghostscript.com/) and [Poppler](https://poppler.freedesktop.org/) for your operating system.
+3. Open a `.ps` or `.eps` file in Visual Studio Code.
+4. Select the preview icon in the editor title bar.
-## 🚀 Quick Start
+The Visual Studio Marketplace installs the companion [PostScript Language](https://marketplace.visualstudio.com/items?itemName=mxschmitt.postscript) extension automatically so Visual Studio Code can recognize PostScript files. Open VSX does not currently mirror that dependency; Open VSX and VSCodium users must first [download its VSIX](https://marketplace.visualstudio.com/_apis/public/gallery/publishers/mxschmitt/vsextensions/postscript/latest/vspackage) and run **Extensions: Install from VSIX...**.
-1. Install this extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=ahnafnafee.postscript-preview)
-2. Install [GhostScript](https://www.ghostscript.com/) and [Poppler](https://poppler.freedesktop.org/)
-3. Open any `.ps` or `.eps` file
-4. Click the preview icon in the editor title bar
+## Highlights
-## 📋 Requirements
+| | |
+| --- | --- |
+| **Live preview**- ⭐ If you find this extension useful, please star the repo and leave a review! -
+See the [testing guide](https://github.com/ahnafnafee/PostScript-Preview/blob/master/TESTING.md) for prerequisites, sample documents, and manual checks. + +## Credits + +- [mkvoya/eps-preview](https://github.com/mkvoya/eps-preview) — the original extension on which this project was based. +- [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom) — SVG pan and zoom controls. +- [Pickr](https://github.com/Simonwep/pickr) — the preview background color picker. + +## License + +PostScript Preview is available under the [MIT License][license-link]. + +If PostScript Preview is useful to you, consider [starring the repository][stars-link] or leaving a review on the [Visual Studio Marketplace][marketplace-link]. + +[marketplace-link]: https://marketplace.visualstudio.com/items?itemName=ahnafnafee.postscript-preview +[marketplace-version-shield]: https://vsmarketplacebadges.dev/version-short/ahnafnafee.postscript-preview.svg?style=for-the-badge +[marketplace-installs-shield]: https://vsmarketplacebadges.dev/installs-short/ahnafnafee.postscript-preview.svg?style=for-the-badge +[marketplace-rating-shield]: https://vsmarketplacebadges.dev/rating-short/ahnafnafee.postscript-preview.svg?style=for-the-badge +[open-vsx-link]: https://open-vsx.org/extension/ahnafnafee/postscript-preview +[open-vsx-shield]: https://img.shields.io/open-vsx/v/ahnafnafee/postscript-preview?label=Open%20VSX&style=for-the-badge +[tests-link]: https://github.com/ahnafnafee/PostScript-Preview/actions/workflows/test.yml +[tests-shield]: https://img.shields.io/github/actions/workflow/status/ahnafnafee/PostScript-Preview/test.yml?branch=master&label=tests&logo=github&style=for-the-badge +[codeql-link]: https://github.com/ahnafnafee/PostScript-Preview/actions/workflows/codeql-analysis.yml +[codeql-shield]: https://img.shields.io/github/actions/workflow/status/ahnafnafee/PostScript-Preview/codeql-analysis.yml?branch=master&label=CodeQL&logo=github&style=for-the-badge +[license-link]: https://github.com/ahnafnafee/PostScript-Preview/blob/master/LICENSE +[license-shield]: https://img.shields.io/github/license/ahnafnafee/PostScript-Preview?style=for-the-badge +[stars-link]: https://github.com/ahnafnafee/PostScript-Preview +[stars-shield]: https://img.shields.io/github/stars/ahnafnafee/PostScript-Preview?style=for-the-badge diff --git a/TESTING.md b/TESTING.md index 254fad1..486ae5f 100644 --- a/TESTING.md +++ b/TESTING.md @@ -6,24 +6,34 @@ This guide explains how to test the extension locally during development. Ensure you have the following installed: -1. **Node.js 24** (the active LTS release used by CI) -2. **GhostScript** (provides `ps2pdf`) +1. **Node.js 24** with Corepack (the active LTS release used by CI) +2. **Ghostscript** (provides `ps2pdf`; the extension invokes `gswin64c.exe` directly on Windows) 3. **Poppler** (provides `pdftocairo` and `pdfinfo`) ### Verify Prerequisites +On macOS or Linux: + ```bash -# Check if commands are available ps2pdf --help pdftocairo --help pdfinfo --help ``` +On Windows: + +```powershell +gswin64c -version +pdftocairo -v +pdfinfo -v +``` + ## Setup 1. Install dependencies: ```bash + corepack enable yarn install ``` @@ -102,19 +112,44 @@ Test files are located in `examples/`: - Edit and save the PostScript file - Preview should auto-update -## Running Tests +## Automated Tests + +Tests are grouped by the boundary they exercise: + +```text +src/test/ +├── unit/ # Pure logic; no VS Code host or native tools +├── integration/ # Extension behavior in a real VS Code host +└── runTest.ts # Downloads and launches the integration test host +``` + +Run the fast unit suite while developing pure preview behavior: + +```bash +yarn test:unit +``` + +Run the integration suite after installing Ghostscript and Poppler: + +```bash +yarn test:integration +``` + +Run the complete suite in the same order as CI: ```bash yarn test ``` +CI runs both suites on Node.js 24 across Ubuntu, Windows, and macOS. Linux integration tests use Xvfb to provide the display required by the Visual Studio Code test host. + ## Packaging Build a VSIX package for local installation: ```bash npm install -g @vscode/vsce -vsce package +vsce package --no-dependencies ``` Install the generated `.vsix` file via: @@ -139,20 +174,20 @@ 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` +4. Build package to verify: `vsce package --no-dependencies` ### Publish ```bash -vsce publish +vsce publish --no-dependencies ``` Or publish with a version bump: ```bash -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 +vsce publish --no-dependencies patch # 0.6.0 → 0.6.1 +vsce publish --no-dependencies minor # 0.6.0 → 0.7.0 +vsce publish --no-dependencies major # 0.6.0 → 1.0.0 ``` ### View Published Extension diff --git a/package.json b/package.json index 2e68c00..641f79c 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "postscript-preview", "displayName": "PostScript Preview", "description": "PostScript Preview is an extension that helps to preview EPS and PS files in Visual Studio Code.", - "version": "0.6.0", + "version": "0.6.1", "icon": "images/logo.png", "publisher": "ahnafnafee", "engines": { @@ -55,7 +55,7 @@ "postscript-preview.path.ps2pdf": { "type": "string", "default": "ps2pdf", - "description": "Path to ps2pdf executable (from GhostScript). Use this if ps2pdf is not in your system PATH." + "description": "Path to the ps2pdf executable from Ghostscript. On Windows, the default uses gswin64c.exe from PATH so conversion does not require a command shell." }, "postscript-preview.path.pdftocairo": { "type": "string", @@ -72,11 +72,13 @@ }, "scripts": { "vscode:prepublish": "yarn compile", - "compile": "tsc -p ./", + "clean": "node -e \"require('node:fs').rmSync('out', { recursive: true, force: true })\"", + "compile": "yarn clean && tsc -p ./", "lint": "eslint src", "watch": "tsc -watch -p ./", - "pretest": "yarn compile", - "test": "node ./out/test/runTest.js" + "test": "yarn compile && mocha --ui tdd --color --timeout 10000 \"out/test/unit/**/*.test.js\" && node ./out/test/runTest.js", + "test:unit": "yarn compile && mocha --ui tdd --color --timeout 10000 \"out/test/unit/**/*.test.js\"", + "test:integration": "yarn compile && node ./out/test/runTest.js" }, "devDependencies": { "@eslint/js": "^10.0.1", @@ -93,6 +95,7 @@ }, "resolutions": { "diff": "^9.0.0", + "glob": "^13.0.6", "serialize-javascript": "^7.1.1" }, "repository": { @@ -101,5 +104,6 @@ }, "sponsor": { "url": "https://github.com/sponsors/ahnafnafee" - } + }, + "packageManager": "yarn@4.18.0+sha512.fcb8716fe7cd0eece141ffc18b92193a9df9204c1ba83189c288835223fc0bbe64af473bab0d5e9927a7daeb5caf2bb07eb2787cc9338ca040ea125f2a1f2f7e" } diff --git a/src/extension.ts b/src/extension.ts index 0314fe5..72f774d 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -35,7 +35,7 @@ export function activate(context: vscode.ExtensionContext): void { if (!document) { console.log("No active document. Do nothing."); - return; + return false; } const filename = path.basename(document.fileName); @@ -53,7 +53,11 @@ export function activate(context: vscode.ExtensionContext): void { const mainFilePath = document.fileName; - generatePreview(mainFilePath, panel, channel); + const previewPath = generatePreview(mainFilePath, panel, channel); + if (!previewPath) { + panel.dispose(); + return false; + } channel.appendLine(`Watching ${filePath}`); // Handle messages from webview for page navigation @@ -128,6 +132,8 @@ export function activate(context: vscode.ExtensionContext): void { } channel.appendLine(`Stop watching ${filePath}`); }); + + return true; } ); diff --git a/src/pdf-info.ts b/src/pdf-info.ts new file mode 100644 index 0000000..d683fdf --- /dev/null +++ b/src/pdf-info.ts @@ -0,0 +1,7 @@ +/** + * Parse the page count reported by the `pdfinfo` command. + */ +export function parsePdfPageCount(output: string): number | undefined { + const pages = /^Pages:\s+(\d+)\s*$/m.exec(output); + return pages ? Number.parseInt(pages[1], 10) : undefined; +} diff --git a/src/postscript-command.ts b/src/postscript-command.ts new file mode 100644 index 0000000..b833461 --- /dev/null +++ b/src/postscript-command.ts @@ -0,0 +1,72 @@ +import * as path from "path"; + +export interface PostScriptConversionCommand { + executable: string; + args: string[]; +} + +function resolveWindowsGhostscriptExecutable( + configuredExecutable: string +): string | undefined { + const basename = path.win32.basename(configuredExecutable).toLowerCase(); + if ( + ["gswin64c", "gswin64c.exe", "gswin32c", "gswin32c.exe"].includes( + basename + ) + ) { + return configuredExecutable; + } + + if (!["ps2pdf", "ps2pdf.bat", "ps2pdf.cmd"].includes(basename)) { + return undefined; + } + + if ( + path.win32.isAbsolute(configuredExecutable) && + basename !== "ps2pdf" + ) { + return path.win32.resolve( + path.win32.dirname(configuredExecutable), + "..", + "bin", + "gswin64c.exe" + ); + } + + return "gswin64c.exe"; +} + +export function createPostScriptConversionCommand( + configuredExecutable: string, + inputPath: string, + outputPath: string, + platform: NodeJS.Platform = process.platform +): PostScriptConversionCommand { + const ghostscriptExecutable = + platform === "win32" + ? resolveWindowsGhostscriptExecutable(configuredExecutable) + : undefined; + + if (ghostscriptExecutable) { + return { + executable: ghostscriptExecutable, + args: [ + "-q", + "-P-", + "-dSAFER", + "-dBATCH", + "-dNOPAUSE", + "-sDEVICE=pdfwrite", + "-dCompatibilityLevel=1.4", + "-dEPSCrop", + `-sOutputFile=${outputPath}`, + inputPath, + ], + }; + } + + return { + executable: configuredExecutable, + args: ["-dEPSCrop", inputPath, outputPath], + }; +} diff --git a/src/preview.ts b/src/preview.ts index cdcb401..5634a8a 100644 --- a/src/preview.ts +++ b/src/preview.ts @@ -11,6 +11,8 @@ import os = require("os"); // biome-ignore lint/style/useNodejsImportProtocol: