JuliaDocs/Documenter.jl

Add `make` command to run prettier

Open

#2.529 geöffnet am 14. Juni 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (910 Stars) (513 Forks)batch import
Type: Maintenancegood first issue

Beschreibung

  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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Node.jsmakefamiliarity with Documenter.jl build process
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.