cube-js/cube

[Feature Request] Eslint rules to assist writing schemas

Open

#3,680 opened on Nov 17, 2021

View on GitHubContributor guide
 (2 comments) (3 reactions) (0 assignees)Rust (1,965 forks)batch import
help wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (PR metrics pending)

Description

Some assistance would be great when writing schemas. Since schemas are js files, eslint and/or typescript would help avoid typos and inform about mandatory keys.

Contributor guide

Research direction
Investigate how to create custom ESLint rules by studying the ESLint plugin API and looking at examples of similar rules for schema validation.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
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.
1-2 days
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
JavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65