cpprefjp / crsearch Goto Github PK

View Code? Open in Web Editor NEW

3.0 3.0 4.0 2.22 MB

cpprefjp と boostjp をいい感じに検索するウィジェット

License: MIT License

JavaScript 65.83% Shell 1.32% Dockerfile 0.06% SCSS 26.44% Handlebars 6.34%

crsearch's People

Contributors

Stargazers

Watchers

Forkers

yumetodo kariya-mitsuru akinomyoga raclamusi

crsearch's Issues

npmリポジトリの dist が超絶古い…

npm リポジトリに登録されているパッケージの dist ディレクトリ配下のファイル群がコミット 416710f（console.log 死すべし慈悲は無い）の物のままです。
kunai では dist 配下のファイルは参照していないので問題は無いのですが、ちょっと気持ち悪い…

Symbol類をローカルで保持する

今のcrsearch.js内では、定数を全体的に Symbol.for('名前') に依存している。これはどこで書いても重複しないという利点があるものの、グローバルな定数になってしまうため、同等なことを「Databaseクラスのインスタンスのユニーク性（crsearch.jsonの仕様を参照）」の範囲で解決できるように、Databaseクラスの内部で定数のファクトリを持つ実装に変更する。

refs: cpprefjp/site#477

ヘッダが結果として出た場合にグルーピングがバラバラ

元々あったやつ→自分自身がグループ対象になっている
e42c12a で対応したやつ→ (no header) 表示

死ぬほどだるいけどヘッダは全部まとめて (headers) という表示で別のグループにしたい

CIのアップデート頻度を上げたい

@melpon

今はおそらく cpprefjp/site と合わせて更新されているはずで、最長１日とかだと思うのですが、 crsearch がエンバグした場合に最悪丸１日検索が動かないということが起こり得る上に、jsのエラーに引っ張られて左のツリービューや、Googleサイト内検索も死ぬ可能性が少しあります。

できれば crsearch だけ即時（push トリガー）か、最長でも１５分くらいで本番にデプロイされるようにして貰いたいのですが、お願いできますか？

編集者向けページやスタブがクイックジャンプの検索結果に表示される

crsearch/js/crsearch/namespace.js

Lines 72 to 80 in 5c177e0

    
           for (let [id, idx] of this.indexes) { 
        
             if (q.filters.size && !Array.from(q.filters).some((f) => { return idx.id.type === f })) continue 
        
             if ( 
        
               Array.from(q.frags.and).every(function(idx, q) { return Index.ambgMatch(idx, q) }.bind(null, idx)) && 
        
               !Array.from(q.frags.not).some(function(idx, q) { return Index.ambgMatch(idx, q) }.bind(null, idx)) 
        
             ) { 
        
               ++found_count

オブジェクトとしては持ってる。

crsearch/js/crsearch/index.js

Line 24 in ec35b6c

this.nojump = !!json.nojump

元々これは、 cpprefjp/site_generator#28 (comment) で追加された。しかし、kunaiにおけるサイドバーツリーではそもそも nojump があるか無いかに関わらず全てのページを表示するのが目的だったため、この属性を見に行く処理が存在しなかった。

その結果としてクイックジャンプ（crsearch）の方で編集者向け資料などが表示されている

蛇足：

これは個数制限付きの検索処理。実装が悪いせいで N * O(N log N) （たぶん）になっているが、本来はO(N log N)にできる。しかし、全体の個数が高々2800個しかないので問題になっていない

キーボードショートカットのヘルプ表示

? 押下でオンスクリーン表示
デフォルトヘルプに (1.) について記載

<string -> 表示される
<vector -> 無い
<bitset -> 無い

これは元データ的にどうしようもないと思うので、crsearch.jsで対応

スマホ表示で狭くなった時に検索ボックスが見づらい

少なくともパンくずの上か下にflexできちんとwrapさせてあげたい

<から入力を始めた時に２文字目以降が無条件でAND対象になる

9740cbf の regression 🤔

例えば、 <a -> <cassert, <cmath とかがヒットする、splitするのが早すぎ

	for (let [id, idx] of this.indexes) {
	if (q.filters.size && !Array.from(q.filters).some((f) => { return idx.id.type === f })) continue

	if (
	Array.from(q.frags.and).every(function(idx, q) { return Index.ambgMatch(idx, q) }.bind(null, idx)) &&
	!Array.from(q.frags.not).some(function(idx, q) { return Index.ambgMatch(idx, q) }.bind(null, idx))

	) {
	++found_count