Green-Software-Foundation / Green-Software-Foundation/if

Implement tree object validation

Open
#1,106 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
183
Forks
51
PR merge metrics
No merged PRs in 30d

Description

**What**

Implement an additional level of validation to catch errors in `manifest.tree`.

**Why**

As a user, I want to be sure that the manifest I have implemented, doesn't have any structural mistakes.
Currently, the `manifest.tree` object is not validated, so it requires an additional layer of scrutiny to avoid mistakes.

**SoW (scope of work)**

Implement zod validation for checking tree object structure.

- [ ] documentation updated
- [ ] test cases added

**Acceptance criteria**

**Given** (Setup): Describes the initial state of the system or the preconditions for a change.
We have a manifest with an invalid tree structure.
**When** (Action): Describes the specific action or behavior that is being tested/changed.
Running Impact framework on the manifest with invalid tree structure.
**Then** (Assertion): Defines the expected outcome or behavior of the system after the action in the "When" step is performed.
The framework should error out.

Contributor guide

Open the contributing guide

Research direction

Start at the manifest.tree validation entry point in the Impact framework and inspect how existing manifest validation is structured. Add the tree-structure validation, update the documentation, and add test cases showing that an invalid tree causes the framework to error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.