SolidOS / SolidOS/solid-ui

Proposal: Remove logging from Solid UI and add it as a module that is exposed through the data browser

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

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

enhancement
主要言語
TypeScript
スター
153
フォーク
46
平均マージ
1日 8時間
マージ済み PR(30日)
7

説明

I'm currently working on the log module, which exposes a set of methods that mostly do one of three things, depending on the environment:

  1. if the environment has the document object (e.g. is a browser), it will look for an element with id "status" and append lines to it with time, type of log message and the message whenever the methods are called with a message, or
  2. if the environment supports console (e.g. Node), it will use console.log to output the messages, or
  3. do nothing

(The other methods that do not log messages are various configuration methods.)

I think it's weird that the module is dependent on a global element somehow being available, and think it would be better to expose the API through a module that is exposed through the data browser, probably through the DataBrowserContext interface that is made available to views through methods such as render. (It is currently defined in pane-registry.)

Data browser implementations would handle logging differently, but expose the same API. This module could then be passed to methods in Solid UI that requires logging, making the need for log module in Solid UI obsolete.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

既存のログモジュールと、pane-registry の index.d.ts にある DataBrowserContext インターフェースを読み、render などのメソッドを通じてビューがどのようにコンテキストを受け取るかを追跡します。Solid UI がログモジュールのグローバルなステータス要素に依存しなくなり、データブラウザーが実装側で処理できる共通のロギング API を公開すれば完了です。

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

評価

技術スタック
typescript
領域
frontend
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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