[RFC]: Add lint support for enforcing header filename conventions
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- javascript
- 領域
- documentation, tooling
調査の方向性
まず package.json のメタデータとパッケージの include フォルダーを調べ、パッケージ名、プライマリヘッダー、プライベートヘッダーがどのように表現されているかを確認します。snakecase のファイル名規則を文書化し、その後 lint ルールの対象範囲と、個別の include-guard の動作を定義します。完了条件は、規則が文書化され、プライベート include にフラグを立てずに、意図した違反が検出されることです。
索引モデルが issue の本文から書いたものです。
説明
A package's primary header file and its include guard needs to match the package name, except for being in snakecase, rather than kebabcase.
We have this convention so that end users have a consistent rule for how to convert a package name to a header include path. If packages are allowed to deviate from that convention, end users would need to explicitly look up the include path for each package they wanted to use, which just creates unnecessary friction.
We should both (a) document and (b) create a lint rule for enforcing filenames and potentially support separate linting for enforcing include guards (although this may be tied to us getting clang linting up and running).
When linting filenames, we'd need to distinguish between the main include and additional includes which are intended to be private. For the latter, these are allowed to have any name (e.g., see ndarray/base/unary). What should be the case is that if a package has an include folder, there should always be a header file having a path matching the package name, with the file basename being the base package name converted to snakecase. I cannot think of an exception to this rule. And if we ever needed to make an exception, we could consider, at some point in the future, adding an associated config option to a package's package.json which allows disabling the lint rule.
Created via /stdlib todo from stdlib-js/stdlib#11830 by @kgryte.
- 主要言語
- JavaScript
- スター
- 6k
- フォーク
- 1.3k
- 平均マージ
- 1日 8時間
- マージ済み PR（30日）
- 586
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stdlib-js/stdlib のほかの issue
-
Fix JavaScript lint errors対応中かも @lb1192176991-lab が 2 日前に担当しました。 オープンGood First Issue
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
stdlib-js/stdlib#15831 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
`@stdlib/string/base/percent-encode` produces malformed encoding and silently drops characters対応中かも @barbierajput378-pixel が 7 日前に担当しました。 オープンBug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
stdlib-js/stdlib#15595 · コメント 6 件 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: kumaraswamy/kurtosis returns non-excess kurtosis (missing −3)対応中かも @Planeshifter が 7 日前に担当しました。 オープンBug Statistics
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stdlib-js/stdlib#15461 · コメント 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: rayleigh/mgf returns wrong values due to misplaced parenthesis対応中かも @anandkaranubc が 9 日前に担当しました。 オープンBug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stdlib-js/stdlib#15456 · コメント 6 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
@stdlib/array/fixed-endian-factory allows misaligned byte offsets and fractional lengths対応中かも @kanikasharma-18 が 22 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
stdlib-js/stdlib#15193 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
stdlib-js/stdlib の issue をすべて見る
似ている issue
-
[quality] useFocusTrap's Shift+Tab wrap and non-Tab/non-Escape key arms are never driven end to end対応中かも @hivecommons-hive が今日担当しました。 オープンagent/quality hive/covered-by-pr hive/hosted-available-lke648397-260827-5n31 quality testing
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
agentic-workflows
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
githubnext/gh-aw-workshop#4220 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
JuliusBrussee/caveman#1189 ·
メンテナーはふだん 1 日以内に返信
-
priority:low ready-for-dev
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
OpenHands/extensions#738 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
invoiceninja/invoiceninja#13320 ·
メンテナーはふだん 1 日以内に返信