Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

CLI: rethink step validation

オープン
  • 何か問題がありますか？
#1,407 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
typescript
領域
cli

調査の方向性

CLI の現在の workflow-structure 検証エントリーポイントから始め、既存の JSON schema を確認します。共通のポータビリティスキーマに対するバージョン選択と、オプションの --validate フラグを含め、提案された 3 つのアプローチを比較します。検証ポリシーが、タイプミスの検出と新しい workflow キーとの互換性を区別できる程度に明確に定義されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

CLI DevX

The CLI has logic to validate the structure of a workflow.

The idea here is that if a user mis-types a key like "adapatator", the CLI will catch the error and flag them.

What with all the focus on sync and portability, it's way more likely that a workflow will be machine generated now, and so won't have those typos.

But if the app adds a new key to the workflow, the CLI will refuse to execute it - even if it's a step it doesn't care about.

I would like to think about the following options:

  • Use the common portability spec schema to validate against. The app does have a JSON schema. If the workflow or owning project has aversion, use that, else use latest. This relates to https://github.com/OpenFn/lightning/issues/4734
  • Add a --validate flag which will validate a workflow for you, if you want it (a bit like a circle CI yaml linter app)
  • only validate keys that the CLI cares about, and ignore the rest
主要言語
TypeScript
スター
21
フォーク
23
平均マージ
1日 4時間
マージ済み PR（30日）
20

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenFn/kit のほかの issue

OpenFn/kit の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。