WordPress/gutenberg

Create Block: Add automated tests to scaffold

Open

#21360 opened on Apr 2, 2020

View on GitHub
 (3 comments) (4 reactions) (0 assignees)JavaScript (9,607 stars) (3,893 forks)batch import
Good First IssueNeeds Dev[Status] In Progress[Tool] Create Block[Type] Enhancement

Description

Is your feature request related to a problem? Please describe. In order to encourage users to write automated tests, the infrastructure for them should be included in the scaffold from create-block

Describe the solution you'd like Add an option for the esnext template that sets up automated tests that defaults to Y.

Describe alternatives you've considered The main alternative is documentation on how to add automated tests. While I think that's a good first step, scaffolding will ultimetely save time. Create-block is installed 70 times a week right now, if we save 5 minutes for each of those people, almost 6 hours a week will be saved. Across an entire year, that is over 12 days of time.

I also considered making it mandatory, but allowing it to be opted out makes sense to me since there is the possibility that someone may have no interest in automated tests or intends to structure them in a different way.

Contributor guide

Tech stack
javascriptnodejsreact
Domain
clitoolingtesting
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.
1-2 days
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.jsGutenberg block development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the create block package in the Gutenberg repository (packages/create block). Look at the existing esnext template and the scaffolding logic. The issue suggests adding an option for automated tests, defaulting to 'Y'. Investigate how other options are implemented (e.g., no wp scripts). Consider what test framework to use; Jest is commonly used in the project. Review any comments in the issue for additional context.