Support nested folders in `config/queries/` for query organization

オープン
#218 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
sql, typescript
領域
backend, tooling

調査の方向性

まず、plugins/server/utils.js の AppManager.getAppQuery()、getQueries() と、typegen の generateQueriesFromDescribe() を読み、続いてそれらの flat readdir と path.basename の扱いを調べます。ネストされた .sql ファイルが安定した相対 query key に解決され、validation が選択した separator を受け入れ、type generation と frontend lookup がドキュメント化された例をカバーすれば完了です。

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

説明

Support nested folders in config/queries/ for query organization

Problem

As the number of SQL queries in a project grows, config/queries/ becomes a flat bag of files with no way to organize them by feature or domain. The only option is naming conventions (e.g. nego_chart_data.sql, trip_summary.sql), which doesn't scale well and provides no structural separation.

Current behavior

  • AppManager hardcodes queriesDir to path.resolve(process.cwd(), "config/queries")
  • fs.readdir() is non-recursive — subdirectories are silently ignored
  • Query key validation (/^[a-zA-Z0-9_-]+$/) rejects any delimiter that could encode a path
  • generate-types (typegen) also uses flat readdir + path.basename

Proposed behavior

Allow queries to live in subdirectories:

config/queries/
  negotiations/
    chart_data.sql
    spend_summary.sql
  dashboard/
    trip_summary.sql
    trips_by_day.sql
  docs/
    annotations.obo.sql

Query key derivation would use the relative path with a separator (e.g. / or .):

  • negotiations/chart_data or negotiations.chart_data

Frontend usage:

useAnalyticsQuery('negotiations/chart_data', params)

Minimal change required

The fix is small — roughly 3-4 locations need updating:

  1. AppManager.getAppQuery() — change fs.readdir() to fs.readdir(dir, { recursive: true }) and adjust filename matching to include relative subdirectory paths
  2. getQueries() in plugins/server/utils.js — same recursive readdir change
  3. generateQueriesFromDescribe() in typegen — derive query names from relative paths instead of just path.basename()
  4. Query key validation regex — allow / or . as a path separator

Workarounds

Currently using prefix naming (nego_*, trip_*) which works but doesn't provide IDE folder navigation or structural grouping benefits.

主要言語
TypeScript
スター
119
フォーク
36
平均マージ
4日 16時間
マージ済み PR(30日)
37

環境構築

はじめの一歩

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

databricks/appkit のほかの issue

databricks/appkit の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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