OAI / OAI/tools.openapis.org

Add environment variable validation to `validate-metadata.js`

Open
#34 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

data enhancement
Dominant language
JavaScript
Stars
177
Forks
87
Avg merge
1m
Merged PRs (30d)
1

Description

User Story

As a developer of the Tooling project I want to ensure that environment variables are validated before the rest of the build executes

Detailed Requirement

Currently when a build kicks off the first step is to validate that environment variables are present, which is executed by validate-metadata.js. Currently any validation of the values is performed downstream.

To make processing more efficient this should be moved upstream so that initialisation and type checking can be performed before any further steps.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading lib/transform/validate-metadata.js and tracing where environment-variable presence is currently checked before the build. Compare that flow with the downstream value validation, then identify the existing build entry point or tests that exercise metadata validation. Done means initialization and type checking occur before later build steps without changing the intended validation behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.