jbolda / jbolda/covector

edit package files in place

Open
#236 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
89
Forks
14
Avg merge
6h 9m
Merged PRs (30d)
4

Description

Currently, the package files (and changelogs) are parsed into a representation such as an AST, mutated and converted back. This relies on the library we are using to round trip non-destructively, that is, do this process without changing parts of the file that we didn't modify.

We want to look at possibly editing the string directly, and kind of shimming in our change instead. We can perhaps still use this libraries to help, but not depend on them doing a round trip. This should address many of the issues we are seeing and major versions of dependencies changing expectations.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how package files and changelogs are parsed, mutated, and converted back. Compare that flow with the proposed direct string-editing approach; done should mean changes are inserted without depending on non-destructive round trips or specific dependency-version behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.