JuliaDocs/Documenter.jl

Add `make` command to run prettier

Open

#2529 opened on Jun 14, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Type: Maintenancegood first issue

Description

  1. I think we could add a npm package.json into the root of the repo, that would install prettier.
  2. We could add make targets to (1) instantiate the package.json and (2) to actually run prettier

https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment-2165219642, https://github.com/JuliaDocs/Documenter.jl/issues/2528

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetoolingbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
Node.jsmakefamiliarity with Documenter.jl build process
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the existing Makefile in the repository root (if any) and the referenced discussions in PR #2514 and issue #2528. Determine whether a package.json should be added at root and define make targets to install prettier and run it. Consider whether to integrate with existing build scripts or CI. Provide a concrete implementation plan.