the-draupnir-project/Draupnir

Relative dataPath directory support implementation is relative to install directory, not current working directory

Open

#241 opened on Feb 7, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (28 forks)auto 404
L1 Very FewP1 NuisanceT3 Workflow Issuegood first issue

Repository metrics

Stars
 (239 stars)
PR merge metrics
 (PR metrics pending)

Description

https://github.com/the-draupnir-project/Draupnir/blob/faee9367af5a3041368152d451e38c8d7be630dc/src/index.ts#L69

If a relative path is passed, it ends up evaluating to $DIST/../$DATA_PATH, rather than ./$DATA_PATH. This becomes an issue once you are not in the workspace (eg. you've installed Draupnir on nix, where it lives in /nix/store/awewaef3-draupnir-1.86.1/...)

Contributor guide

Research direction
Inspect src/index.ts line 69 to see how dataPath is calculated. Note that using a path relative to the module's directory ( dirname) causes the issue. The fix should resolve relative paths from the current working directory (process.cwd()) instead. Add a test to verify that running from a different directory produces the expected path.
Tech stack
typescript
Domain
backend
Issue type
Bug
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75