The root of the problem is the root: How to get a root at all times in a codebase (or no root at all)

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

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

評価

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

調査の方向性

ソースファイルやテストは指定されていません。まず Codebase クラスと、ScanCode TK --from-json および --strip-root の動作を確認します。virtual_root の扱いとパスの順序も含めて確認してください。POSIX、Windows、サブセット、プロジェクト間での利用におけるルートのセマンティクスを解決した、合意済みで文書化された仕様が完成すれば完了です。

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

説明

The root problem is this:

  1. ScanCode TK demands a single root named Resource in a Codebase
  2. ScanCode TK creates a fake "virtual_root" name if there is no common root in several scans (--from-json /VirtualCodebases)
  3. ScanCode.io does not have a single root for a project (or rather it has one which might be the "codebase" directory, but never reports it.
  4. on Windows there is no single root: each "drive" is its own root.
  5. on POSIX, there is a single root, but it has no name: this is name only "/" and it can have files and directories as children
  6. ScanCode TK and CommonCode generally ignore or even strip a leading slash therefore making the POSIX root moot
  7. When you "--strip-root" in ScanCode TK (leaving aside the possible loss of data attached to a root dir) it is potentially problematic to further read this with --from-json because we have no root anymore.
  8. Scanning a subset of paths or a collections of path in ScanCode is problematic because of this need for root
  9. The Codebase classes expect some sort order when creating Resources which may not make sense in all cases and may be overly restrictive as we cannot predict this sort order at all times
  10. Somethings are not entirely clear:
  • what is the different between a Codebase and a root Resource?
  • why could a Codebase not be just a collection of paths? And why do we even need a root?

We need to define a clean and well spec way to handle this across all projects

主要言語
Python
スター
4
フォーク
25
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

aboutcode-org/commoncode のほかの issue

aboutcode-org/commoncode の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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