iodide-project/iodide

validate _all_ API args, break out API arg validation in #1703 into a little library that we can use to

Open

#1,760 opened on Apr 22, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (147 forks)batch import
good first issue

Repository metrics

Stars
 (1,483 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

following from @hamilton's nice file API argument validation in #1703, we should apply argument validation to all of the iodide API. in the process, we should break the argument validation into proptypes-style helper function

see: https://github.com/iodide-project/iodide/pull/1703#discussion_r274200088

export function loadFile(fileName, fetchType, variableName = undefined) {
  argType.validate({
    fileName: [fileName, argType.string],
    fetchType: [fetchType, argType.enum(FETCH_RETURN_TYPES)],
    variableName: [variableName, argType.string.optional]
  })
  return sendFileRequestToEditor(fileName, "LOAD_FILE", {
    fetchType
  }).request.then(handleResourceLoad(fetchType, variableName));
}

Contributor guide

Research direction
Examine the existing argument validation implemented in PR #1703 (file API validation). Understand the pattern used there, then identify all other API functions in the codebase that need similar validation. Implement a reusable validation library following the propTypes style example provided in the issue.
Tech stack
javascript
Domain
full stack
Issue type
Refactor
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.
Half day
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
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60