astro-better-declarative-screenshots 0.4.1 → 0.4.2

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Better Static Sites
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# astro-better-declarative-screenshots
+
+Astro components that render committed screenshot PNGs in your docs site. No Playwright, no Docker, no heavy dependencies.
+
+## Install
+
+```sh
+npm install astro-better-declarative-screenshots
+```
+
+## What it does
+
+- Declare screenshots and highlights inline in MDX
+- Reads committed PNG files and renders them at build time
+- Pairs with `astro-better-generate-screenshots`, which produces the PNGs
+
+## Documentation
+
+Full documentation, including configuration and examples, is at
+[https://better-static-sites.github.io/content/declarative-screenshots](https://better-static-sites.github.io/content/declarative-screenshots).
+
+This package is published from the [Better Static Sites monorepo](https://github.com/better-static-sites/better-static-sites.github.io); the directory it lives in has a combined README covering it and its sibling package.

package/package.json

@@ -1,16 +1,31 @@
 {
   "name": "astro-better-declarative-screenshots",
-  "version": "0.4.1",
+  "version": "0.4.2",
+  "description": "Astro components that render committed screenshot PNGs in your docs site",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/better-static-sites/better-static-sites.github.io.git",
+    "directory": "astro-better-declarative-screenshots/use-screenshots"
+  },
+  "homepage": "https://better-static-sites.github.io",
+  "bugs": {
+    "url": "https://github.com/better-static-sites/better-static-sites.github.io/issues"
+  },
   "type": "module",
   "exports": {
     ".": "./index.mjs",
     "./Screenshot.astro": "./Screenshot.astro",
     "./Highlight.astro": "./Highlight.astro"
   },
-  "peerDependencies": {
-    "astro": ">=4.0.0"
-  },
+  "files": [
+    "index.mjs",
+    "*.astro",
+    "src/"
+  ],
   "dependencies": {
     "zod": "^3.23.0"
+  },
+  "peerDependencies": {
+    "astro": ">=4.0.0"
   }
 }

package/tests/config.test.mjs

@@ -1,96 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import { loadConfig } from '../src/config.mjs';
-import { mkdirSync, writeFileSync, rmSync } from 'fs';
-import path from 'path';
-import os from 'os';
-
-let tmpDir;
-
-beforeEach(() => {
-  tmpDir = path.join(os.tmpdir(), `config-test-${Math.random().toString(36).slice(2)}`);
-  mkdirSync(tmpDir, { recursive: true });
-});
-
-afterEach(() => {
-  rmSync(tmpDir, { recursive: true, force: true });
-});
-
-function writeConfig(content) {
-  writeFileSync(path.join(tmpDir, 'screenshot.config.mjs'), content);
-}
-
-describe('loadConfig', () => {
-  it('throws when no config file exists', async () => {
-    await expect(loadConfig(tmpDir)).rejects.toThrow(/No screenshot.config.mjs/);
-  });
-
-  it('loads a minimal valid config (no docker)', async () => {
-    writeConfig(`
-export default {
-  baseUrl: 'http://localhost:9011',
-};
-`);
-    const config = await loadConfig(tmpDir);
-    expect(config.baseUrl).toBe('http://localhost:9011');
-    expect(config.docker).toBeUndefined();
-    // defaults applied
-    expect(config.browser).toBe('webkit');
-    expect(config.outputDir).toBe('./src/assets/screenshots');
-    expect(config.colorScheme).toBe('light');
-  });
-
-  it('loads a config with docker settings', async () => {
-    writeConfig(`
-export default {
-  baseUrl: 'http://localhost:9011',
-  docker: {
-    healthcheck: { url: 'http://localhost:9011/api/status' },
-  },
-};
-`);
-    const config = await loadConfig(tmpDir);
-    expect(config.docker.healthcheck.url).toBe('http://localhost:9011/api/status');
-  });
-
-  it('applies window defaults', async () => {
-    writeConfig(`export default { baseUrl: 'http://localhost:9011' };`);
-    const config = await loadConfig(tmpDir);
-    expect(config.window.width).toBe(1280);
-    expect(config.window.height).toBe(800);
-  });
-
-  it('applies chrome defaults', async () => {
-    writeConfig(`export default { baseUrl: 'http://localhost:9011' };`);
-    const config = await loadConfig(tmpDir);
-    expect(config.chrome.style).toBe('safari-macos');
-    expect(config.chrome.showUrl).toBe(true);
-    expect(config.chrome.shadowBlur).toBe(40);
-  });
-
-  it('accepts a custom outputDir', async () => {
-    writeConfig(`
-export default {
-  baseUrl: 'http://localhost:9011',
-  outputDir: 'public/screenshots',
-};
-`);
-    const config = await loadConfig(tmpDir);
-    expect(config.outputDir).toBe('public/screenshots');
-  });
-
-  it('rejects an invalid baseUrl', async () => {
-    writeConfig(`export default { baseUrl: 'not-a-url' };`);
-    await expect(loadConfig(tmpDir)).rejects.toThrow(/invalid/i);
-  });
-
-  it('accepts beforeScreenshot as a function', async () => {
-    writeConfig(`
-export default {
-  baseUrl: 'http://localhost:9011',
-  beforeScreenshot: async (page, spec) => {},
-};
-`);
-    const config = await loadConfig(tmpDir);
-    expect(typeof config.beforeScreenshot).toBe('function');
-  });
-});

package/tests/naming.test.mjs

@@ -1,72 +0,0 @@
-import { describe, it, expect, beforeEach } from 'vitest';
-import { deriveName } from '../src/naming.mjs';
-
-describe('deriveName', () => {
-  it('converts URL path segments to a slug', () => {
-    expect(deriveName('/admin/group/add')).toBe('admin-group-add');
-  });
-
-  it('strips leading slash', () => {
-    expect(deriveName('/admin')).toBe('admin');
-  });
-
-  it('handles root path', () => {
-    expect(deriveName('/')).toBe('screenshot');
-  });
-
-  it('handles full URLs', () => {
-    expect(deriveName('http://localhost:9011/admin/group')).toBe('admin-group');
-  });
-
-  it('ignores query string and hash', () => {
-    expect(deriveName('/admin/group?tab=members#section')).toBe('admin-group');
-  });
-
-  it('appends selector slug for single highlight', () => {
-    const result = deriveName('/admin/group', [{ selector: '#group-name' }]);
-    expect(result).toBe('admin-group-group-name');
-  });
-
-  it('appends multiple selector slugs', () => {
-    const result = deriveName('/admin/group', [
-      { selector: '.group-name' },
-      { selector: '#submit-btn' },
-    ]);
-    expect(result).toBe('admin-group-group-name-submit-btn');
-  });
-
-  it('handles complex selectors', () => {
-    const result = deriveName('/admin', [{ selector: 'input[type="text"]' }]);
-    expect(result).toBe('admin-input-type-text');
-  });
-
-  it('resolves simple collisions with numeric suffix', () => {
-    const used = new Set();
-    const a = deriveName('/admin/group', [], used);
-    const b = deriveName('/admin/group', [], used);
-    const c = deriveName('/admin/group', [], used);
-    expect(a).toBe('admin-group');
-    expect(b).toBe('admin-group-1');
-    expect(c).toBe('admin-group-2');
-  });
-
-  it('mutates the used set', () => {
-    const used = new Set();
-    deriveName('/admin', [], used);
-    expect(used.has('admin')).toBe(true);
-  });
-
-  it('handles path segments with special chars', () => {
-    expect(deriveName('/foo/bar_baz.html')).toBe('foo-bar-baz-html');
-  });
-
-  it('handles multi-part class selector', () => {
-    const result = deriveName('/page', [{ selector: '.foo .bar' }]);
-    expect(result).toBe('page-foo-bar');
-  });
-
-  it('empty highlights have no effect on the name', () => {
-    expect(deriveName('/admin/group', [])).toBe('admin-group');
-    expect(deriveName('/admin/group', [{ selector: undefined }])).toBe('admin-group');
-  });
-});