JuliaDocs/Documenter.jl

Add `make` command to run prettier

Open

#2,529 opened on Jun 14, 2024

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

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

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

Research direction
Create a package.json in the root with prettier as a devDependency, add make targets to install npm dependencies and run prettier, then integrate into the project's build system.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90