miraclx/freyr-js

Use trunk version in the git repo

Open

#352 opened on Sep 19, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (2,279 stars) (154 forks)user submission
enhancementgood first issue

Description

It's hard to distinguish between a version of freyr installed from the package registries or one run from github. Would be useful to have the git revision in the freyr header for more helpful debugging.

Contributor guide

Tech stack
javascriptnodejs
Domain
clideveloper experiencetooling
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-3 hours
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.js basicsGit basicsUnderstanding of package.json version field
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the existing build process in package.json and scripts (e.g., build script, version command). Investigate how the current version string is generated (likely from package.json). Then, integrate `git describe tags` or `git rev parse HEAD` during build to embed the commit hash into the CLI header. Check if there's a build step that sets a global constant or reads a file. The issue suggests modifying the header output to include the revision. Consider using a prebuild step to generate a version.ts file with the hash.