kytta/shareon

Generate screenshot automatically

Open

#148 opened on Apr 21, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (25 forks)auto 404
devdocsenhancementgood first issue

Repository metrics

Stars
 (477 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the screenshot in the README is created manually by me. The process can be easily automated, though. So far, my steps are:

  1. Start dev server
  2. Select element with the buttons (.specimen)
  3. Make a screenshot of node
  4. Resize
  5. Save

But I think this all can be replaced with Playwright and Sharp.

import { firefox } from 'playwright';

const browser = await firefox.launch();
const context = await browser.newContext();
const page = await context.newPage();
await page.goto('https://localhost:5173/');
const buffer = await page.locator('.shareon.specimen').screenshot();
// TODO: learn Sharp

Then, put it into CI and run on icon/button changes. Can be a nice weekend project.

Contributor guide

Research direction
Set up Playwright to capture screenshots of the share buttons and use Sharp to resize, then integrate the script into CI via GitHub Actions.
Tech stack
javascriptnodejsplaywright
Domain
testingdocumentationci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60