HN 日本語サマリー

← 一覧へ戻る
プログラミング

Sift: Lisp、Scheme、Emacs LispのためのLSP、Lint、フォーマッタ

Sift: LSP, Lint, Format Lisp, Scheme and Emacs Lisp (github.com)

75 pointsby jjba2310 コメント

要約

Siftは、Scheme、Emacs Lisp、Common Lisp向けのLSP(Language Server Protocol)クライアント、リンター、フォーマッタです。Lispコードをデータとして扱い、コメントや空白行を保持しながら、各Lisp方言の構文規則に厳密に従って整形・解析を行います。エディタ統合、CI/CDパイプライン、WebAssemblyビルドなど、多様な環境での利用を想定しています。

全文翻訳

Sift: Lisp、Scheme、Emacs LispのためのLSP、Lint、フォーマッタ

Scheme、Emacs Lisp、Common Lispのための冪等なフォーマッタ、ルールベースのリンター、言語サーバー

[画像: logo.svg]

[画像: https://github.com/jjba23/sift/actions/workflows/ci.yml/badge.svg] [画像: https://img.shields.io/badge/release-1.27.3-2f6f4f.svg] [画像: https://img.shields.io/badge/license-MIT-2f6f4f.svg] [画像: https://img.shields.io/badge/Guile-3.0%2B-1e5b3a.svg] [画像: https://img.shields.io/badge/Guix-channel-6f4e9c.svg] [画像: https://img.shields.io/badge/Nix-flake-5277c3.svg] [画像: https://img.shields.io/badge/LSP-server-2f6f4f.svg] [画像: https://img.shields.io/badge/rules-92-2f6f4f.svg]

siftはLispソースファイルを読み込み、その中の不正な点を報告し、空白を書き換えます。この書き換えはテキストに対する全域関数であり、不動点です。フォーマット済みのファイルをフォーマットしても変更されず、コメント、空行、#;のデータコメント、#.の読み込み時フォームは入力された場所にそのまま出力されます。これらのプロパティはすべてテストスイートで検証されており、静かに失効する約束ではありません。

3つの異なる方言が、それぞれ独自の規則によって読み込まれます。方言間の妥協ではなく、それぞれの規則に従います。例えば、角括弧は方言によってはベクトルであり、別の方言では節ですが、siftはそれらを平均化しません。

[画像: assets/sift-demo.gif]

[画像: assets/sift-lint-format.gif]

guix install sift または nix run でインストールするか、リポジトリをクローンして ./bin/sift version を実行してください。実装はGuile 3.0と標準ライブラリを使用しており、C言語への依存やビルドステップはありません。これはSchemeプログラムには不要だからです。sift doctor は、実行中のインタプリタ、ロードされたライブラリ、見つかったルールを報告します。

同じプログラムが言語サーバー(sift lsp)としても機能します。検出された問題、修正、フォーマットは一度計算され、標準出力へのテキストまたはLSP応答として配信されるため、Eglot経由のEmacs、Neovim、その他のプロトコルクライアントは、パイプラインが受け取るものと全く同じ情報を得られます。

MITライセンスの下で、1つの実行可能ファイルと1つのEmacsパッケージとして提供されます。基本的な考え方は、Lispプログラムは読み込み可能な構文を持つデータであり、それをデータとして扱うフォーマッタは正確かつ高速であるべきだというものです。

チェック、フォーマット、リント。 sift check は適用されるパッチを表示して終了コード1で終了します。sift format はフォーマットされたファイルを表示します。sift lint はトリガーされたルール、その重大度、位置を示します。エディタとパイプラインはこれらの同じ応答を受け取ります。この記録の各行は実際の出力であり、画像で読めるほど小さなファイルに対するものです。

対象読者と範囲

  • Lisp学習者。 各方言は独自の規則で読み込まれるため、学習者の前に立つツールは、フォーマッタが発明した第4の方言ではなく、学習中の言語の規約を強制します。
  • GuileおよびGuixのコードベース。 cond節が角括弧で書かれ、ビルドファイルがgexpsである場合、フォーマッタは再決定するのではなく、隣接するツリーと一致する必要があります。
  • Emacsパッケージ作成者。 FlymakeとCIの両方で、3つのプログラムではなく1つのプログラムから、ドキュメント文字列、lexical-binding、interactive、provideルールが必要です。
  • Common Lispプロジェクト。 パッケージプレフィックス、LOOPキーワードスタイル、末尾の括弧が規約であり、正規化されるのではなく保持されます。
  • ポリグロットLispリポジトリ。 3つずつではなく、1つの実行可能ファイル、1つの設定ファイル、1つのCIステップを取得できます。
  • エディタおよびツールの作成者。 検出結果をデータとして扱います:--format=json、--format=sarif、GitHubアノテーション、またはsift lsp。

ロスレスな書き換えが議論の全てであり、残りはそこから導かれます。変更箇所がチャンクとなる差分、範囲を置き換える修正、コードに異議を唱えることなく無効化できるルール。

プロパティと保証

  • バイト単位の正確な保持。 コメント、空行、#;のデータコメント、#.の読み込み時フォーム、#<...>オブジェクトは読み込まれた通りに正確に返されます。フォーマットは不動点です。2回目の実行は何も変更しません。テストスイートは、すべてのフィクスチャに対して保持と冪等性を主張します。
  • 方言は決定され、推測されない。 3つの異なる方言、1つのプログラム:文字リテラル、読み込みマクロ、#| ... |#ブロックコメント、#;データコメント、パッケージプレフィックス、LOOPおよびドキュメント文字列の規約は、妥協ではなく、方言独自の規則に従います。角括弧も同様です。これはEmacs Lispではベクトルであり、Schemeでは節です。また、#{ ... }#はシンボルであり、Guileのみが読み込みます。Guileはsiftが書かれている方言であり、そのリーダーが最もよく知っている方言です。他の2つは仕様から読み込まれます。
  • 3つのジョブ、3つのコマンド。 フォーマット、リント、修正は設計上分離されています:formatは表示し、--writeは書き込み、lintは報告し、lint --fixは修正し、ciはフォーマットの質問とリントの質問を1回のパスで、ツリーに触れることなく行います。
  • 92のルール、それぞれに理由がある。 各ルールには名前、安定したコード(SIFT012)、説明文、適用される方言、例、および独自のテストファイルがあります。sift explain RULEはプログラムから推論を読み込みます。doc/rules.orgはルールレコードから生成されるため、コードと説明のずれはありません。
  • 推測しない修正。 ルールの修正は正確に1つの範囲を置き換えます。実行されたすべての修正は、解析エラーを導入する可能性がある場合は破棄されます。区切り文字は発明されず、識別子は名前変更されません。
  • 抑制はコメントであり、コードの場所に留まる。 ;; sift:disable-next-line keyword-argumentsは1行のルールを無効にし、disableはその形式の残りの部分を無効にし、enableはそれを再度有効にします。抑制は設計上、行指向で形式スコープです。設定ファイル内の例外リストは、レビューが到達しないリストであり、範囲コメントは、それが書かれたコードよりも長く存続します。
  • 1つの言語サーバー、すべてのエディタ。 sift lspは標準入出力でLSPを話します:診断、クイックフィックス、フォーマット、定義への移動、およびすべての3つの異なる方言の参照。これには、標準ライブラリとそのインストール済みパッケージが定義する名前、実装がコンパイルしたパッケージが持つドキュメント、ほとんどのEmacsインストールが提供する圧縮ソース、アウトライン、補完、引数を名前付けるインレイヒント、シンボルまたはその下のルールを説明するホバー、インポート整理、モジュールを同期させたままのファイル名変更、バッファ保存時に方言固有のコンパイラからのセカンドオピニオンが含まれます。
  • 人間、エディタ、パイプライン向けの出力。 :makeやcompilation-modeが解析するコンパイルスタイルの行、構造を求めるエディタ向けのJSON、コードスキャン向けのSARIF 2.1.0、プルリクエスト向けのGitHubアノテーション、終了ステータスのみを気にするスクリプト向けのnull。
  • チェックイン可能な設定。 データでありコードではないYAML、システムからコマンドラインまでの4つのレイヤー、およびsift config show --verboseでどのレイヤーが優先されたかを報告します。
  • フック、ドクター、クエリ可能なカタログ。 sift install-hooksはpre-commitフックを書き込み、ciを実行します。sift doctorは、実行中のGuile、ロードされたライブラリ、見つかったルールの数、決定された設定レイヤーを報告します。sift list-checkersはカタログを表形式で表示し、sift explainはルールレコードから読み取られた1つのルールの推論を表示します。
  • MITライセンス。 フォーマッタはできるだけ多くのパイプラインに組み込まれるべきであり、ライセンスの問題はそれを妨げるコストであり、何も得られません。

ほとんどのリストは1つの決定から導かれます。Lispファイルは、ソース位置を持つフォームのツリーとして読み込まれ、テキスト行としてではなく、フォーマッタはそのツリーを元に戻します。範囲を置き換える修正、変更箇所がチャンクとなる差分はすべてそこから導かれます。リーダーとプリンタが逆演算であることは、Lispが持つ最も古いプロパティです。ここでの作業は、空白が移動する間、それらを逆のまま保つことです。

初めてのセッション

Guile 3.0のみが必要です。チェックアウト内のランチャーがプログラムを実行するため、クローンがあれば十分です。

git clone https://github.com/jjba23/sift.git
cd sift
./bin/sift version

修正が必要なファイル:

$ cat square.scm
(define (square x)
(* x x))

$ sift check square.scm
--- square.scm
+++ square.scm
@@ -1,2 +1,2 @@
 (define (square x)
-(* x x))
+  (* x x))
$ echo $?
1

checkは、パイプラインが尋ねる質問、つまり何か変更されるかどうかに、ステータスとパッチで答え、何も書き込みませんでした。変更を適用するには:

$ sift format --write square.scm
$ sift check square.scm; echo $?
0

何か言うべきことがあるファイル:

$ cat small.scm
(define (go)
  (if (ready?)
      (proceed)))

$ sift lint small.scm
small.scm:2:4: warning: [if-without-else] `if` has no else branch; `when` says it once
1 file checked, 1 warning, 0 errors

各行は file:line:column: severity: [rule] sentence の形式であり、コンパイルバッファ、CIログ、grepはすでに解析できます。提案も検出結果であり、深くネストされた本体は書き換えられるのではなく報告されます。

$ sift lint messy.scm
messy.scm:5:3: info: [wrap-in-let] this body form nests 10 deep; bind part of it
messy.scm:6:5: info: [wrap-in-let] this body form nests 9 deep; bind part of it
messy.scm:7:7: info: [wrap-in-let] this body form nests 8 deep; bind part of it
messy.scm:8:9: info: [wrap-in-let] this body form nests 7 deep; bind part of it
1 file checked, 0 warnings, 0 errors

ルールが何を意味するかを読むには、それを保持しているプログラムに尋ねてください:

$ sift explain if-without-else
CODE
SIFT012

NAME
if-without-else

DESCRIPTION
`if` with no else branch, where `when` expresses the intent

DIALECTS
scheme

SEVERITY
warning

FAILING EXAMPLE
(if (ready?) (go))

EXPECTED FIX
(when (ready?) (go))

ツールと環境が実行中のものについて意見が一致しない場合、プログラムに何が見えるかを尋ねることができます:

$ sift doctor
sift 1.27.3
  guile       3.0.11
  library     /home/joe/Hacking/sift/src
  rules       92
  dialects    scheme, elisp, cl

Compilers
  scheme available
  elisp available
  cl not found

Sources
  cache       /home/joe/.cache/sift/sources
  downloaded  0
  tools       curl, tar

Configuration
  project  /home/joe/project/sift.yaml

Settings that are not the default
  brackets: square   # /home/joe/project/sift.yaml
  severity: warning   # /home/joe/project/sift.yaml

Try `sift ci .' to check a tree, or `sift explain RULE' to read a rule.

さらに2つのコマンドが同じレコードから導かれます。fixはルールが同値として記述できる修正を適用し、残りを報告します:

$ cat messy.scm
(define (f) (let ((x 1)) x))
(define (g)
  (if a b))

$ sift fix messy.scm
1 file checked, 0 warnings, 0 errors

$ cat messy.scm
(define (f) 1)
(define (g)
  (when a b))

フォーマットはformatに属するため、フォーマットは行われません。フォーマットが移動する修正は、読みやすくするためのパッチのすべての行に触れることになります。ただし、インポートは整理されます。未使用のインポートは削除され、仕様はソートされます(両方ともデフォルトで有効)。sift.yamlのoptimize-importsまたはsort-importsでどちらか一方を無効にできます。ciはパイプラインによって要求される同じ2つの質問を、1つのコマンドと1つのステータスで行います:

$ sift ci .
--- ./go.scm
+++ ./go.scm
@@ -1,3 +1,3 @@
 (define (go)
-    (if (ready?)
-        (proceed)))
+  (if (ready?)
+    (proceed)))
./go.scm:2:6: warning: [if-without-else] `if` has no else branch; `when` says it once
1 file checked, 1 warning, 0 errors
$ echo $?
1

インストール

実行時にsiftはGuile 3.0以降を必要とし、それ以外は何も必要ありません。Emacsはオプションであり、エディタ部分のみです。

要件

要件必要性バージョン
Guileツール全体、実行時3.0+
gzip圧縮ソースのナビゲーション読み込み任意
curl, tarstdlibで名前が付けられたソースアーカイブの取得任意
Emacsemacs/sift.elのEmacsパッケージ28.1+
GuixまたはNixディストリビューションとしてのインストール任意
VimとNodeVimとVS Codeのテスト実行のみ任意
Veritasテストスイート実行のみdev

言語サーバーは、guild、emacs、sbclのいずれかがインストールされているかを確認し、セカンドオピニオンを求めます。存在しないコンパイラは単に無視され、compiler-diagnostics: falseでセカンドオピニオンが無効にならない限り、ツールは実行を拒否しません。

siftはLinuxとmacOSで動作します。キャッシュはプラットフォームに従います:$XDG_CACHE_HOME/sift(設定されている場合)、macOSでは/Library/Caches/sift、それ以外では$XDG_CACHE_HOME/siftまたは/.cache/siftです。上記のオプションツールはPATHで見つかります。不足しているツールは報告され、それが必要とする機能は、ツールが実行を拒否するのではなくスキップされます。

C言語への依存やビルドステップはなく、パッケージマネージャーもパスにありません。プログラムはSchemeソースであり、存在する任意のGuileによってロードされます。

チェックアウトから

git clone https://github.com/jjba23/sift.git
cd sift
./bin/sift version

bin/siftは小さなPOSIXシェルランチャーです。シンボリックリンクチェーンを自己解決し、兄弟のsrc/をGuileのロードパス(または設定されていれば$SIFT_LOAD_PATH)に配置し、引数を(sift cli)に渡します。ランチャーが不要な場合、プログラムは次のように縮小されます。

#!/usr/bin/env guile
!#
(use-modules (sift cli))
(exit (sift-main (cdr (program-arguments))))

GUILE_LOAD_PATHをsrc/にポイントして実行します。プレフィックスの場合、maak installはライブラリを$(prefix)/share/guile/site/3.0に、ランチャーを$(prefix)/binにコピーします。PREFIX=/usr/localがデフォルトであり、maak uninstallはその逆です。

初回実行時にGuileはライブラリをコンパイルし、標準エラーにいくつかの;;; note: ...行を出力します。これはGuileの自動コンパイルであり、siftではありません。キャッシュがウォームアップされると停止し、GUILE_AUTO_COMPILE=0で抑制されます。

Guixで

チェックアウトから、シェルコマンドはパッケージをビルドします。

guix shell -f guix.scm -- sift version
guix build -f guix.scm        # またはストアパスのみ

パッケージとしてインストールするには、guix-jointhefreeworldチャンネルが提供しています。

guix install sift

ランタイムとビルド入力の分割は意図的です。siftはライブラリとランチャーであり、Guileしか必要としません。Veritas、テストフレームワークは、スイートを実行するために必要であり、その理由からパッケージのネイティブ入力です。したがって、テストを実行しないマシンにsiftをインストールしても、テストフレームワークはインストールされません。

Nixで

リポジトリは独自の派生(derivation)を保持しているため、Nixはビルドにセカンドエクスプレッションを必要としません。

nix-build -E 'with import <nixpkgs> {}; callPackage ./default.nix { }'
./result/bin/sift version

また、flakeも保持しています。これは、ウェイがアタッチされた同じ派生です。パッケージ、アプリ、開発シェル、コンテナイメージが含まれます。

nix run .#sift -- version        # チェックアウト内
nix run git+https://github.com/jjba23/sift -- version
nix build .#sift                 # ./result/bin/sift
nix develop                      # siftがPATHにあるシェル
nix build .#docker               # ロード可能なイメージ、Linux上

flakeはLinuxとmacOS(x86_64-darwin、aarch64-darwin)の両方でビルドされます。これは、クロージャがGuileとSchemeのみであるためです。Macでは、nix run github:jjba23/siftがフォーマッタを実行する最も簡単な方法です。イメージはLinux専用の出力であり、Darwinでは壊れているのではなく存在しません。

nix-jointhefreeworld flakeは、このリポジトリ固有のdefault.nixからビルドされた同じパッケージを保持しています。

nix run git+https://github.com/jjba23/nix-jointhefreeworld#sift -- version

コンテナで

イメージにはDebianのGuile、ライブラリ、ランチャーが含まれており、それ以外は何もありません。コンテナ内にはビルドステップがありません。Schemeプログラムには不要だからです。チェックアウトからビルドするか、プルしてください。

docker build --tag sift .                  # または: podman build --tag sift .
docker run --rm --volume "$PWD:/src" sift check .

コンテナの作業ディレクトリは/srcなので、そこにマウントされたボリュームはsiftが読み取るツリーです。エントリポイントはsift自体なので、イメージの後の引数はsiftの引数です。プロジェクト全体の実行、パッチ、リント、言語サーバー(標準入出力上)はすべて同じように機能します。

docker run --rm --volume "$PWD:/src" sift ci .
docker run --rm --interactive --volume "$PWD:/src" sift lsp

maak package-dockerはタグがすでに付いた最初のコマンドであり、maak push-docker-latest / maak push-docker-tagはそれを公開します。これは、maak自体のファイルにある3つのタスクと同じです。イメージは、Nixとエンジンを持たないマシン用のflake出力でもあります。nix build .#dockerはtarballを書き込み、docker load < resultでロードします。

コンテナはパイプの反対側のために存在します。macOSでは、スクリプトが信頼できるGuileやGuixは存在しません。Docker Desktopは存在します。動作する1つのイメージと、それに対するテストは、それぞれ独自に検証する必要がある3つのインストール手順よりも安価です。

Emacsパッケージ

emacs/sift.elは依存関係のない単一ファイルです。Emacs 28.1以上が必要です。

(add-to-list 'load-path "/path/to/sift/emacs")
(require 'sift)

ファイルにはパッケージに必要なヘッダーが含まれているため、emacs/sift.elでM-x package-install-fileを実行することもできます。これはpackage-user-dirに配置されるコピーに対して機能します。

その後、何が有効になるかはプロジェクト次第です。Emacsの章には、Eglotありとなしの2つの構成と、変更可能な設定があります。

インストールの検証

sift version   # 番号と、プログラムが起動すること
sift doctor    # 実行中のGuile、ロードされたライブラリ、ルール、
               # 決定された設定

コマンドライン

すべてのコマンド、オプション、終了コードはdoc/cli.orgにあります。これはリファレンスです。要約すると、sift format、sift lint、sift checkはファイルまたは標準入力を受け取ります。sift ciはパイプライン向けのチェックとリントを1つのコマンドで行います。ステータスは、クリーンな場合は0、検出結果がある場合は1、使用法エラーまたは読み込めないファイルの場合は2です。

方言の決定方法

決定は順序付けられたテストシーケンスであり、最初に回答したものが勝ちます。

  1. --dialect、またはdialect設定。
  2. 拡張子:.scm、.ss、.sld、.slsはScheme。.elはEmacs Lisp。.lisp、.cl、.asd、.lspはCommon Lisp。
  3. シェバン:guileはScheme、sbcl、clisp、ecl、cclはCommon Lisp、emacsはEmacs Lisp。
  4. 最初の200行のマーカー:(in-package ...)または(defpackage ...)はCommon Lisp、(define-module ...)または(use-modules ...)はScheme、lexical-binding: tヘッダーはEmacs Lisp。
  5. それ以外の場合は、その旨が表示され、3つの異なる方言が名前付けされます。推測は回答に含まれません。方言を推測するツールは、いつかCommon LispファイルをSchemeとして書き換える可能性があり、その差分はコードのせいになります。

言語をすでに解決しているエディタは、これらすべてよりも情報を持っています。言語サーバーは、クライアントが送信する識別子(scheme、emacs-lisp、lisp)を受け取り、それに基づいて動作します。

フォーマット

フォーマッタは、行末と空白を正規化し、閉じ区切り文字を配置し、インデントを計算し、要求に応じて連続するインラインコメントを配置し、スタイルの制限内で空行を保持します。それ以外は何も変更されません。改行の位置、文字列の内容、エスケープ文字のスペルは作者に属します。この関数は決定的かつ冪等的であり、テストスイートはそれを確立するために各フィクスチャを2回フォーマットします。doc/formatting.orgがそのページです。2つのスタイル、3つのインデントルール、各方言の読み込み構文、および実行しない4つの項目が含まれています。

リント

ルールはレコードです:名前、コード、説明、適用される方言、重大度、プロシージャ、および例。ドライバーは方言が選択したものを実行し、リーダー自身の検出結果を追加し、抑制コメントを適用し、ソース順に出力します。カタログには92のルールがあり、doc/rules.orgにリストされています。doc/linting.orgは残りをカバーしています:修正が触れる可能性のあるもの、なぜ修正が推測されるのではなく破棄されるのか、そしてルールが行または形式でどのようにサイレンスされるのか。

スタイルと、それが引き出されたソース

スタイルは発明ではなく、3つのLispコミュニティの共通の実践であり、議論できるように書き留められています。doc/style.orgは長文形式です。各選択、それが打ち負かした代替案、およびその理由が含まれます。これには、Riastradhのどのルールをsiftが保持しているかと、何を採用しないか、Emacs Lispの規約(実際にはバイトコンパイラ警告)、Common Lispがクロージャを保持する理由、およびSchemeのcond節が書かれる角括弧が含まれます。プロジェクトが異なる可能性が高い設定は、設定ページにリストされています。規約が確立されたプロジェクトは、フォーマッタとそれについて議論する必要はありません。

Emacsで

emacs/sift.elは薄いパッケージです。Emacsはテキストを実行可能ファイルに渡し、検出結果を返します。すべての決定は1か所に留まります。Emacs 28.1以降が必要で、外部パッケージは不要です。2つの入り口があります:ルールにはFlymake、コードアクションにはEglot。そしてdoc/emacs.orgがそのページです:Flymakeバックエンドとそのキーマップ、Eglotとコードアクション、カスタマイズグループのすべての設定、およびsiftとTABがサードパーティマクロについて意見が異なる理由。

その他のエディタで

LSPを話すことができるものは何でも言語サーバーを使用でき、コンパイラの出力を読み取ることができるものは何でもプログラムを使用できます。doc/editors.orgには詳細とレシピがあり、すぐに使えるものはリポジトリにあります。

エディタ使用するもの
Neovimeditors/vim/neovim.lua — vim.lsp.startセットアップ、プラグインなし
Vimeditors/vim/ — :SiftLint, :SiftFormat, :SiftFix, :SiftExplain, および:make用の:compiler sift
VS Codeeditors/vscode/ — ビルドステップと依存関係のない拡張機能
Emacsemacs/sift.el — Flymake、またはコードアクション用のEglot
Helixsift format --stdinによる保存時のフォーマット、およびパイプラインでのリンター
ブラウザweb/ — siftをWebAssemblyにコンパイルし、バッファが決してタブを離れないようにします。これはhttps://jointhefreeworld.org/sift/でライブです
その他すべて--format=json、--format=github、またはsift lsp

人間が読める形式は file:line:column: severity: [rule] message であり、Vimの:make、Emacsのcompilation-mode、およびほとんどのCIログビューアはすでに解析できます。

ブラウザで

web/は、文字列の関数である2つのジョブ(フォーマットとリント)をGuile HootでWebAssemblyにコンパイルし、その周りにエディタページを配置したものです。同じリーダー、同じフォーマッタ、およびすべての92のルールがタブ内で実行され、入力はタブを離れることはありません。なぜなら、どこにも行く場所がないからです。

これはhttps://jointhefreeworld.org/sift/でライブです。ページ上のエディタ、方言、スタイル、重大度をコントロールとして、ソースにリンクバックするパネルでの検出結果、アウトライン、補完ポップアップ、呼び出しの引数を名前付けるインレイヒント、およびコマンドラインが表示するものと同じカタログから構築されたルールブラウザが含まれています。

コンパイルする理由、ポートしない理由

Lispフォーマッタをブラウザに配置する明白な方法は、JavaScriptで再度記述することです。それはセカンドフォーマッタであり、セカンドスタイルです。2つは最初のファイルがそれらを実行するまで一致せず、その時点でプロジェクトは自身のツールのどちらを信じるかを決定する必要があります。したがって、真実のソースは元の場所に留まりました。タブはリーダー、フォーマッタ、リントドライバー、およびbin/siftが実行するすべてのルールを実行します。なぜなら、それらは同じモジュールだからです。

ページとSchemeの間の契約全体は、1つの文字列から1つの文字列への単一の手続きです。

(web-request "{\"op\":\"lint\",\"source\":\"(if a b)\"}")
;; => "{\"ok\":true,\"result\":{\"warnings\":[…],\"counts\":{…}}}"

タブができることすべてがその手続きです:フォーマット、チェック、リント、修正、ルールカタログ、および4つのエディタの質問(ホバー、定義への移動、補完、アウトライン)。これらは言語サーバーの分析コードによって空のワークスペースに対して応答されます。ファイルシステムを必要とするものは何もできません。ディレクトリをウォークできず、sift.yamlもなく、保存もサーバーもなく、ページは何も報告しません。

コンパイルされたもの、代用されたもの

HootはR7RSとGuileのサブセットをコンパイルしますが、siftが使用するものとのギャップはweb/compat/です。4つのGuileライブラリには代用品があります:format、textual-ports、threads(タブは1つのスレッドなので、(sift pool)はシーケンシャルパスを取ります)、およびftw(scandirはディレクトリがないため何も返しません。これはタブの真実であり、推測ではありません)。

要求の厳しいケースはSRFI-13でした。コアの26ファイルがそれをインポートしますが、Hootはsrfi-9、srfi-11、srfi-14を提供し、SRFI-13は提供しません。Guile自身のsrfi/srfi-13.scmはHootが実装していないre-exportで書かれています。そのため、ブラウザビルドがそれを参照すると、ターゲットが定義していない名前を再エクスポートするものがコンパイルされ、そこで停止します。解決策は、13の手続きの代用品であり、(scheme base)に対して書かれ、ブラウザのコピーをセカンドプロセスで実行し、そのフォーマット、リント、修正の回答がGuileライブラリの回答とバイト単位で一致しない場合は失敗するテストです。比較されない代用品は、最初のものと一致する理由のないセカンド実装です。

シム(shim)できなかった4つの項目はソースが変更されました。ネイティブビルドを悪化させない方法で:(sift strings)は、ターゲットが持っていないライブラリをインポートするのではなく、R7RSが欠落している4つの文字列手続きを保持します。3つの(char-set …)呼び出しサイトは述語になりました。なぜなら、文字セットはR7RSが持っていないオブジェクトだからです。1つの手続きは、キーワードデフォルトとして評価されないポートを本体で受け取ります。(sift imports)のファイルシステム質問は、どのSchemeがstatとscandirを持っているかを尋ねるのではなく、誰がコンパイルしているかを尋ねます。

src/sift/のどのモジュールもブラウザ、Wasm、またはHootの名前を付けていません。依存関係は一方向に実行され、8つのテストがそれを維持します。コアはタブが存在することを知らず、ファサードのコアへの依存関係は依然として5つのモジュールです。コンパイルされたクロージャ内の各Guileライブラリには代用品があります。SRFI-13の代用品は、ビルドが見つけるファイルです。セカンドプロセスで測定されたGuileのライブラリと同じ回答を返します。ページはルートからURLを名前付けせず、名前付けられたすべてのURLはビルドスタンプを運びます。エディタは、ルートではなく、その隣にあるwasm を要求します。

コスト

モジュールは2.3MBです。これはフォーマッタ、リンター、92のルールがWasm GC上にあることを意味します。Webページとしては大きいですが、エディタとしては小さいです。速度は数値が付随する実験の一部です。

バッファformatlint
300 文字17 ms56 ms
1.2 kB52 ms145 ms
6 kB780 ms1.2 s

画面1杯は、エディタがリントに適用する300msのデバウンスを下回るため、最初の2行はリーダーに到達しません。2キロバイトを超えると、コストは顕著になります。JITはなく、ノードごとにレコードが割り当てられ、リーダーは文字ごとに4つのレコードを割り当てます。これはWasm GC上のSchemeのコストであり、ファサードが調整できるものではありません。重要な場所では、リクエストはcheckersリストを受け取ります。これは、ページがより少ない作業を要求する方法です。

実験が示すこと

2つの質問がされていました。実サイズのSchemeプログラム(おもちゃではなく、独自のリーダーと92のルールを持つフォーマッタ)が、タブで実行できるものにコンパイルできるか? はい、上記の注意点がありますが、ポート作業は書き直しではなく、1つの互換性ディレクトリで済みました。境界線が接触に耐えるか? はい、それを確立するテストは、通常のスイートでGuileの下で実行され、ブラウザやWasmランタイムは関与しません。

境界線は設計が制約される場所です。タブにはバッファがあり、プロジェクトはありません。そのため、2つのルールは推測ではなく、何も報告しないという形で発火できません。また、言語サーバーはタブ内にはありません。標準入出力上のプロセスであり、ブラウザではありません。実験はフォーマッタとリンターをカバーしており、これらはLispファイルが作成中に最も必要とするものです。

ビルドと公開
./web/build.sh     # web/dist/ を書き込み、動作するHootを見つける
maak web-serve     # その後 http://localhost:8080/ を開く
maak web-deploy    # またはnginxが提供するディレクトリにコピーする

ビルドは1つのコマンドです。なぜなら、Hootはsiftが配布するライブラリではなく、コンパイラであり、一度だけ必要で実行時には不要だからです。それを見つけることが唯一の難しさです。Hootのコンパイル済みモジュールはバイトコードであり、バイトコードはそのコンパイラに属するため、guix shell guile guile-hootはコンパイルの途中でHoot内でエラーが発生して失敗するツールチェーンを提供します。web/build.shは、ツールチェーンが機能することを確認するために2行のプログラムをコンパイルし、そうでない場合はguix-next guile-hootをGuixに要求します。web/README.orgには、サーバーが提供する2つのもの(.wasmコンテンツタイプと末尾スラッシュリダイレクト)、および提供するもの(2日間のキャッシュ、これはすべてのURLのビルドスタンプが何であるか)の長い形式があります。

公開は、提供するマシン上の/srv/http/jointhefreeworld.org/siftにコピーすることです。これは、サイトの残りの部分が公開される方法です。SSH、rsync、サーバーの再起動はありません。なぜなら、存在するファイルは提供されるファイルだからです。

言語サーバーが応答するもの

sift lspが応答する範囲(リクエストごと、拒否するリクエスト、コードアクション、およびそれらに伴う2つの制限を含む)は、doc/language-server.orgにあります。制限は繰り返す価値があります。参照は名前で1つの異なる方言内で一致します。なぜなら、siftはマクロを展開せず、インポートをたどらないからです。プロジェクトはバックグラウンドで読み込まれるため、ジャンプは残りを待つのではなく、これまでに読み込まれたファイルから応答します。クライアントがexperimentalをアドバタイズする場合、sift/indexStatus通知(uninitialized、scanning、indexing、ready)によって読み込みの進行状況が通知されます。状態、境界(ジャンプの場合は100 ms、参照検索の場合は200 ms)、およびバッチサイズはプロジェクトが読み込まれている間にあります。

パイプラインで

1つのコマンドが両方の質問をします。

sift ci src/ tests/

フォーマットをチェックし、次にリントし、要求された形式で両方のレポートを表示し、いずれかが見つかった場合は1、ファイルが読み込めないか解析できなかった場合は2で終了します。決して書き込みも修正もしません。評価中のツリーを編集するジョブは、その結果の意味がないジョブです。

GitHub Actions

再利用可能なワークフローがあるため、ほとんどのリポジトリは1つのファイルとフラグなしで済みます。

# .github/workflows/sift.yml
name: sift
on: [push, pull_request]
jobs:
  sift:
    uses: jjba23/sift/.github/workflows/sift.yml@v1.27.3

差分に検出された内容をアノテートし、SARIFドキュメントをコードスキャンにアップロードするため、修正されなかった検出結果は、セキュリティタブのアラートとして、または二度とスクロールされないログの行として表示されます。同じリポジトリはコンポジットアクションを提供しており、ステップの1つとしてsiftを必要とするジョブに使用できます。

- uses: jjba23/sift@v1.27.3
  with:
    paths: src/ tests/
    severity: warning

ステップを明示することも可能です。--format=githubは、 proseの代わりにワークフローコマンドを書き込むため、各検出結果は差分の行にアノテーションとして表示されます。

- name: sift
  run: ./bin/sift ci --format=github src/
::warning file=src/foo.scm,line=3,col=3,title=SIFT012 [if-without-else]::`if` has no else branch; `when` says it once
::error file=src/bar.scm,line=1,title=sift format::src/bar.scm would be reformatted by `sift format --write`

--format=sarifは、コードスキャンサービスが消費する形式で、実行全体で1つのドキュメントを書き込みます。

- run: ./bin/sift ci --format=sarif src/ > sift.sarif
- uses: github/codeql-action/upload-sarif@v3
  if: always()
  with:
    sarif_file: sift.sarif

pre-commitフック

sift install-hooks            # .git/hooks/pre-commit を書き込み、`sift ci' を実行
sift install-hooks --force    # 既存のものを上書き

フックはPATHにある任意のsiftを実行します。フックの環境でSIFTを設定して別のコピーを指定します。pre-commitフレームワークもサポートされています。.pre-commit-hooks.yamlは3つのフックを宣言します:sift-format(書き換え)、sift-check(失敗)、sift-lint。プロジェクトは必要なものを選択します。

repos:
  - repo: https://github.com/jjba23/sift
    rev: v1.27.3
    hooks: [{id: sift-format}, {id: sift-lint}]

並列評価

プロジェクト全体での実行は、単一ファイルでの実行のシーケンスであり、ファイルは独立しているため、lint、format、check、ciはそれらをプロセッサに分散させ、ファイル順に回答を表示します。並列実行は、シーケンシャル実行と同じバイトを書き込みます。SIFT_JOBSが唯一の設定であり、決して並列化されない2つの実行は、読み取るファイルを書き込む実行です。設定、2つの例外、および出力が順序付けられる理由は、doc/configuration.orgにあります。

設定

プロジェクトの設定は、sift.yamlまたはプロジェクトが信頼しているsift.scmであり、4つのレイヤーで読み込まれ、1つのスキーマに対して検証されます。siftが持たないキーは、無視されるのではなく、その位置とともに拒否されます。sift config show --verboseは、どのレイヤーが優先されたかを報告します。doc/configuration.orgには、検出ルール、file-filter、信頼モデル、および言語サーバーが同じファイルから読み取る設定がすべて含まれています。

テスト

プロジェクトのすべての部分は、そのユーザーがすでに持っているフレームワークでテストされます。ライブラリにはVeritas、EmacsパッケージにはERT、エディタ統合にはVimとNodeです。スイートのどれもスモークテストではありません。doc/development.orgがそのページです。maakタスク、ベンチマークが測定するもの、およびスイートが実際に主張するもの。これらのタスクはパイプラインでもあります。trunkへのプルリクエストは、ブランチが着陸する前にすべてのゲートを実行し、着陸したプッシュのみがブラウザビルドを公開します(パイプライン)。

アーキテクチャ

src/sift/はジョブごとに1つのモジュールであり、依存関係は一方向に実行されます。recordsは語彙であり、readerとformatはそれを使用します。チェッカーはrecordsとcheck/baseを使用し、lintはそれらを組み立て、renderは検出結果を印刷し、lspは同じ検出結果をプロトコル経由で配信し、cliはそれらをコマンドラインに接続します。formatまたはチェッカー内のどのモジュールもポートや終了コードを知りません。モジュールマップと各モジュールが所有するものは、doc/development.orgにあります。

前提条件

コードが測定される6つの前提条件:ソースファイルはデータであり、文字列ではない。テストではない保証は静かに失効する。作者がコードが何を言うかを決定し、ツールが空白をどこに置くかを決定する。方言は言語であり、バリアントではない。決定できることを述べ、それ以外の場合は検出結果を報告しない。プログラムが言うすべてのことは、データとして利用可能であるべきである。doc/design.orgはそれらを述べ、それらから導かれる決定(独自のリーダー、回答を保持する1回のウォーク、プリティプリンティングではなくファジーフォーマット、監査可能なYAMLリーダー)を述べます。

制限

sift自体はマクロを展開せず、型チェックせず、プロジェクトの規約を知りません。それは報告し、作者が決定します。それは謙虚さではありません。決定するリンターは、見たことのない最初のプロジェクトでは役に立たないでしょう。回答が間違っている可能性がある場合、ルールはそれを述べます:wrap-in-letは提案であり、keyword-argumentsはカウントであり、しきい値は設定です。言語サーバーは、プロジェクト固有のコンパイラに、開いたときや保存時に、スレッドで、バッファの一時コピーに対してsiftが行わないチェックを依頼できます。そして、コンパイラが見ることができる名前、アリティ、型について言うことを公開します。compiler-diagnostics: falseはセカンドオピニオンを無効にします。言語サーバーは、言語サーバーページにリストされているリクエストに応答し、それ以外のものには「メソッドが見つかりません」と応答します。推測ではありません。

貢献

より良いリーダーに値するLisp方言のリストは長く、その各項目は最後まで運ばれる貢献です。

  • バグレポート。 フォーマッタの場合、情報提供的なレポートは入力、期待される出力、およびsift versionとsift doctorの最初のセクションです。選択された方言と実行されたルールは通常、それ自体で質問に答えます。siftが解析を拒否するファイルは、ファイルが壊れていてもバグです。メッセージは、どこにあるかを述べる義務があります。
  • ルール。 各ルールは1つのレコードと1つのテストファイルであり、カタログ、ドキュメント、およびエディタ統合はそれらから導かれます。ルールには、名前、コード(次の空き)、説明文、適用される方言、重大度、例、および3つのケースが必要です。1つはパスし、1つは既知の行と列で失敗し、安全に記述できる修正がある場合は、修正されたテキストと何も見つけないはずの再リントです。
  • 方言の詳細。 異なるスペルで書かれたエスケープシーケンス、予期しない場所のコメント構文、2以外のインデントを持つ形式:tests/reader-scheme.scmとtests/format-scheme.scmにその動作が書き留められています。
  • エディタ統合。 Neovim、Vim、VS Codeにはそれぞれディレクトリと、そのエディタ固有のツールで書かれたテストがあります。別のエディタは、さらに1つのディレクトリです。
  • ドキュメントの言葉。 README、スタイルドキュメント、およびルール説明は手書きされており、ツールを信頼するかどうかを決定する人々によって読まれます。ためらいを引き起こす文章は、ドキュメントの欠陥です。

最初のパッチ、順序通り

  1. doc/style.orgを読む:これはルールが実装する議論であり、それに同意しないルールは情報提供的な種類のバグレポートです。
  2. 何も変更する前にスイートを一度実行し、その後での失敗はパッチが責任を持つものであることを確認します:maak test(パッケージが変更された場合はmaak emacs-test)。
  3. tests/checkers/の下にルールまたは修正とそのテストファイルを追加し、maak self-check、maak check、maak fixture-checkを実行します。
  4. GitHubのプルリクエストとして、またはパッチとして送信します。以下を参照してください。

プロジェクト自身のスタイルは、それが強制するスタイルであるため、自己フォーマットします。

maak fmt           # siftでsiftのソースをフォーマット
maak test          # Veritasスイート
maak check         # すべてのモジュールをコンパイル
maak self-check    # siftのソースはsiftによってフォーマットされる
maak fixture-check # ゴールデンコーパスはまだラウンドトリップする
maak docs          # doc/rules.org を再生成
maak emacs-check   # パッケージをバイトコンパイル、警告はエラー
maak emacs-test    # ERT
maak editors-check # バッチモードのVim、VS Codeロジック上のNode

ドキュメント文字列はTexinfo風(@var{}、@code{})で、最初の行は文であり、各段落はルールの理由を述べています。そのため、このREADMEは仕様なしでも読むことができます。

コミットメッセージはタイプと文です:feat:は以前存在しなかったもの、fix:は間違っていたもの、docs:、test:、refactor:、build:、ci:、またはchore:は残りのもの。対象が絞られる場合は括弧でスコープされます(fix(lsp):、refactor(reader):)。重要なのはgit logをスキャンしてビルドを壊した変更を探すリーダーであり、タイプは10個中9個のコミットを未開封でスキップできるようにします。

パッチはGitHubのプルリクエストとして、またはgit format-patchとgit send-emailで送信されるパッチとして到着します。これは作者が通常行う方法です。レビューはコードに関するものです。

質問も問題として歓迎されます。READMEが答えない質問はREADMEの欠陥であり、それを報告することは最も有用なバグレポートです。

さらに読む

このリポジトリで

  • doc/style.org — スタイル、その背後にある選択、なぜそれぞれがidiomatic Lispであるか、そしてRiastradhのどのルールをsiftが保持しているか。
  • doc/rules.org — すべてのルール、コード付き、ルール自体から生成されたドキュメント。
  • doc/editors.org — Emacs、Eglot、Neovim、Vim、VS Code、Helix、pre-commit、および2つのCI形式。
  • doc/cli.org — すべてのコマンド、すべてのオプション、および各終了ステータスの意味。
  • doc/language-server.org — sift lspが応答するすべてのリクエスト、拒否するリクエスト、および提供するコードアクション。
  • doc/diagrams.md — Mermaid図による動く部分:ナビゲーション、2つの診断パス、標準ライブラリの検出とダウンロード、インポート整理、ファイル名変更。
  • doc/configuration.org — 2つの設定ファイル、読み込まれる4つのレイヤー、プロジェクトが変更する可能性のある設定、および設定ではない1つのノブ。
  • doc/formatting.org — フォーマッタ:2つのスタイル、3つのインデントルール、および各方言の読み込み構文。
  • doc/linting.org — リントドライバー、修正が触れる可能性のあるもの、およびルールをサイレンスする方法。
  • doc/emacs.org — Emacsパッケージ、両方の入り口、およびすべての設定。
  • doc/design.org — 信念と、それらが生み出した決定。
  • doc/development.org — maakゲート、それらを実行するパイプライン、リリースをカットする儀式、ベンチマークが測定するもの、モジュールマップ。
  • web/README.org — ブラウザビルド:シーム、プロトコル、互換性レイヤー、および数値。
  • sift explain RULE — 同じ推論、ルールごとに、プログラムから。
  • sift list-checkers — カタログを表形式で、方言でフィルタリング。
  • emacs/sift.el — パッケージ、上部にコメント付き。

外部

ライセンス

siftはMITライセンスの下でのフリーソフトウェアです。LICENSEにテキストがあります。短く許可的なライセンスは、感情ではなく実用的な要件です。フォーマッタが他人のパイプラインに広がる場合、ライセンスの問題を伴うことはできません。


[2] タイトル: シカゴの学校、Googleに「AIを受け入れるくらいなら検索を失う方がまし」と通告
URL: https://www.techspot.com/news/114532-chicago-schools-tell-google-they-can-live-without.html
本文: (取得不可)

シカゴの公立学校システムは、GoogleのAI機能の統合を拒否し、検索機能なしで運営する意向を表明しました。これは、AIによるコンテンツ生成の正確性や、それに伴う著作権、プライバシー、および教育への影響に関する懸念から来ています。学校側は、AIの導入によって教育の質が低下するリスクを避けるため、たとえ検索機能が利用できなくなっても、AIの強制的な受け入れを拒否する姿勢を示しました。