Show HN: sce(Simple Console Editor)
Show HN: sce (Simple Console Editor) (github.com)
要約
このプロジェクトは、Pythonで書かれたシンプルなコンソールベースのテキストエディタ「sce」を紹介するものです。2008年に開発が始まり、長年にわたり機能改善と安定性向上が図られてきました。依存関係はPythonランタイムとcursesライブラリのみで、単一ファイル実行可能ファイルとして配布可能です。Linux、macOS、BSDなど、POSIX互換システムで動作します。エディタ機能に加え、ブラウザライクなページャー機能も実装されています。ソースコードは数千行程度と比較的短く、コードの可読性は低いものの実用性は高いと説明されています。
全文翻訳
SCE -- Simple Console Editor
[画像: ./documentation/assets/github-banner.png]
概要
これは私が2008年の暑い夏に数日間で最初に書いた、個人的なプレーンテキストエディタです。
長年にわたり、マイナーな機能強化と安定性向上、そしてブラウザ風ページャーの初期実装を行ってきました。
最初の頃から、CからGo、PythonからScheme、BashからErlang、HTML / CSS / JavaScript、LaTeXからCommonMark、JSONからXMLまで、Javaを除くあらゆる言語のソースコードやスクリプト、設定ファイルの編集にこれを使用しています。
コードはPythonで書かれており、Python 3.6+と2.7の両方で動作します。現在のバージョン(ブラウザ風ページャーを含む)でもコードは約3.5k行と、わずか数千行です。ただし、欠点としてはコードはかなり散らかっていますが、仕事はこなします。
基本的なPythonランタイムとcursesライブラリ以外の依存関係はありません。
シンプルな単一ファイルのスタンドアロン実行ファイルとしてデプロイでき、Linux、OpenBSD、OSXなどのあらゆるPOSIXライクなシステムで動作します。
インストール
プリコンパイル済み実行ファイルのダウンロード
最も簡単なインストール方法は、GitHubのリリースページから入手できる、自己完結型のPython zippappをダウンロードすることです。
これらの各ファイルは実際にはプレーンな.zipアーカイブであり、#!/usr/bin/env -S python3 -u -O -O -B -E -S -s -R -bのようなシェバン行とともに、バイトコードコンパイルおよび最適化されたPythonソース(つまり*.pyoファイル)のバリアントが含まれています。したがって、これらのファイルを実行可能にすれば、他のスクリプト/バイナリと同様に実行できます。
*.pyoファイルはPythonのメジャーバージョン間で互換性がないため、ダウンロードしたバージョンとpython3.xのバージョンを一致させることが非常に重要です。 不一致の場合、/usr/bin/python3: can't find '__main__' module in '/tmp/sce'のような非常に紛らわしいPythonエラーに遭遇します。
あるいは、コンパイルされていないソース(*.py)を含むportableバリアントを使用することもできます。これは問題なく動作しますが、Pythonインタプリタがバイトコードコンパイルを行うまで、起動に少し時間がかかる場合があります。
例えば、Python 3.14をインストールした場合(python3.14が$PATHのどこからでも利用可能)、Linux、OSX、FreeBSD、OpenBSD、Android(Termux経由)、そしておそらく他のほとんどのPOSIX準拠システムで、以下のコマンドを実行できます。
curl \
-s -S -f -L \
-o /tmp/sce \
https://github.com/volution/simple-console-editor/releases/download/preview/editor--python-3.14--v0.2.0--preview \
#
chmod a=rx /tmp/sce
## 注意: 終了するには、Ctrl+Xを押します(何も変更していない場合)。
## または Ctrl+R を押し、「exit」と入力して変更を破棄します。
## 保存するには、Ctrl+Sを押します。
/tmp/sce
## 注意: **既存**のファイルを編集するには。
/tmp/sce my-file.txt
## 注意: 新しいファイルを編集するには(つまり、ファイルが存在する必要があります)。
touch my-file.txt
/tmp/sce my-file.txt
その後、$PATHで利用可能な場所に配置したい場合は、次のようにします。
sudo cp /tmp/sce /usr/local/bin/sce
前のセクションで述べたように、Python 3.6+(あるいは2.7)以外の依存関係はありません。
ソースからの実行
あるいは、GitHubからリポジトリをチェックアウトする(またはソースをダウンロードする)だけで、他のPython CLIと同様に実行できます。
python ./sources/exec_editor.py
デプロイしたい場合は、sourcesフォルダの内容だけが必要で、それ以外は何も必要ありません。
例
エディタの例
呼び出し構文
sce
sce <ファイル>
produce | sce | consume
最初のバリアントでは、エディタは空のバッファで開き、ユーザーが編集できるようにします。その後、save /tmp/file.txtのようなコマンドを使用して内容を保存し、exitコマンドを実行できます。
コマンドを実行するには、Ctrl+Rを押して目的のコマンドを入力します。(exitコマンドの代替として、Ctrl+Xを押すだけでも終了します。)
2番目のバリアントでは、エディタは指定されたファイルを開き、ユーザーが編集できるようにします。その後、saveのようなコマンドを使用して内容を保存し、exitコマンドを実行できます。(saveコマンドの代替として、Ctrl+Sを押すだけでも保存できます。)
3番目のバリアントでは、エディタはproduceのすべての出力を読み込み、匿名バッファで開き、ユーザーが編集できるようにします。その後、exitのようなコマンドを使用してエディタを閉じ、consumeによって消費されたすべての出力を書き込むことができます。このバリアントは基本的にパイプ(またはプレーンファイル)をstdinとstdoutとして使用し、一時ファイルの使用を必要としません。
以下はサポートされているすべてのコマンドです(Ctrl+Rを押すだけで入力できます):
exit-- 保存を求めたり実行したりせずに終了します。saveまたはsave /tmp/file.txt;open /tmp/file.txt;clear-- 現在のバッファをクリアします。gs text--textを検索します。(次のマッチを見つけるには、Ctrl+Gを押します。)gr regex-- 正規表現を検索します。(次のマッチを見つけるには、再度Ctrl+Gを使用します。)gl number-- 指定した行番号に移動します。replace this that-- 最初のマッチを検索し、それを置換するにはCtrl+Nを押す必要があります。次のマッチを見つけるにはCtrl+Nを押し、さらに置換するにはもう一度Ctrl+Nを押します。store-- 現在の選択範囲を一時ファイルに保存します。load-- 一時ファイルから保存された選択範囲を現在のカーソル位置に挿入します。- (
storeとloadは呼び出し間で機能するため、ファイル間でコピー&ペーストが可能です。) pipe command arguments...-- 現在のファイルまたは選択範囲に対してコマンドを実行し、stdinにフィードし、stdoutからの結果で置き換えます。sys i command arguments...-- コマンドを実行し、stdoutの出力を挿入します。sys o command arguments...-- コマンドを実行し、現在の選択範囲をstdinにフィードします。copy--Ctrl+Dを参照してください。cut--Ctrl+Kを参照してください。yank--Ctrl+Yを参照してください。paste--Ctrl+Tを参照してください。
以下はサポートされているすべてのキーバインディング/ショートカットです:
- 上、下、左、右、ホーム、エンド、ページアップ、ページダウン、バックスペース、デリート -- 期待通りに動作します。
Ctrl+X-- ファイルが変更されていないか、既に保存されている場合、エディタを終了します。Ctrl+S-- ファイルを保存します。Ctrl+R-- ユーザーがコマンドを入力できるようにします。Ctrl+G-- 次のマッチに移動します。(gsまたはgrによって開始されたもの。)Ctrl+N-- 現在のマッチを置換するか、次の置換マッチに移動します。(replaceによって開始されたもの。)Ctrl+Space-- 選択範囲の開始。もう一度Ctrl+Spaceを押すと選択範囲が終了します。選択範囲は移動間で永続します。選択範囲をクリアするにはCtrl+Spaceを2回押します。Ctrl+D-- 選択範囲を内部バッファにコピーします。Ctrl+K-- 選択範囲を内部バッファにカットします。Ctrl+Y-- 内部バッファからペーストします。Ctrl+V-- 現在の行にジャンプマーカーを設定します。Ctrl+Z-- 前のマーカーに移動し、現在の行を新しいジャンプマーカーとして設定します。(つまり、Ctrl+VとCtrl+Zを使用すると、同じファイルの2つの部分間を簡単にジャンプできます。)Ctrl+T--sce-pasteを実行します。これはユーザー提供の実行可能ファイルで、おそらく別のcursesベースのアプリケーションであり、stdoutからの出力を挿入します。(例えば、fzfを使用してさまざまなスニペットやその他の「オートコンプリート」機能を提供できます。)
ページャーの例
呼び出し構文
produce | sce-pager <パターン> | consume
produce | sce-pager <パターン> <プレフィックス> <アンカー> <サフィックス> <データ> | consume
4つの引数は次のとおりです。
<パターン>-- ハイライトされる行の一部に一致するはずのキャプチャを含む正規表現(次の例では^(pub...)。<プレフィックス>-- アンカーの直前に、通常のテキストの一部となる置換テンプレート(次の例では<1>)。<アンカー>-- ハイライトされるアンカーのテキストとなる置換テンプレート(次の例では[ <2>])。<サフィックス>-- アンカーの直後に、通常のテキストの一部となる置換テンプレート(次の例ではスペース)。<データ>-- 現在のアンカーが選択された場合に、出力されるデータとなる置換テンプレート(次の例では<2>)。
入力と出力:
- ページャーは、標準入力と標準出力がファイルまたはパイプ(実際にはTTY以外のもの)であることを期待します。
- ページャーは、標準エラー出力が端末(つまりTTY)であることを期待します。
注記:
- 文字列の照合された部分は、プレフィックス、アンカー、サフィックスの展開を連結したものに置き換えられます。
- プレフィックス、サフィックス、アンカーがすべて存在する場合、ユーザーは「コンテキストに応じた」マッチを行うことができます。次の例では、16進数文字列としてキー識別子を特定しますが、
pubで始まる行の先頭にのみ出現するものに限ります。GPGキータイプ(16進数文字列に似ている)は無視します。 - 異なるデータテンプレートを持つことで、データの短いバージョンを提示しつつ、完全なデータを出力することができます。
- 正規表現と置換パターンの構文は、Pythonの
reライブラリのものです。 - 正規表現は個々の行に対して実行されるため、マッチは行末で「折り返されません」。
- 明らかに、1行に複数のハイライトがあっても構いません。
GPGキー識別子の選択
(シェルに貼り付ける)次のスクリプトを実行します。
gpg2 --list-keys --keyid-format short \
| sce-pager '^(pub +[0-9a-zA-Z]+/)([0-9a-fA-F]+) ' '\g<1>' '[\g<2>]' ' ' '\g<2>' \
| cat
ページャーが起動したら、以下を行います。
Tabキーを押すと、カーソルが次のハイライトされたキー識別子に移動します。(ハイライトは黄色です。)- カーソルが「上」にあるハイライトされたキー識別子を選択するには、
Enterキーを押します。(選択されたハイライトは赤色です。) - 他のキー識別子を見つけるために
Tabを押し続け、それらを選択するためにEnterを押します。 - ハイライトされたキー識別子の選択を解除するには、カーソルが「上」にあるときに
Enterキーを押します。 Ctrl+Xを押すと終了します。選択されたキー識別子は、辞書順にソートされて標準出力に出力されます。
その他
高度な「トリック」:
Ctrl+Rを押すと、さまざまなコマンドを実行できます。- そのコマンドの1つに
filter <pattern> <context-lines>があります。これは、パターンに一致する行に、指定された数の前後の行を追加して表示します。(フィルタをクリアするには、単にfilterを実行します。)
注意
著作権とライセンスの詳細については、documentation/licensingフォルダ内のnoticeファイルを参照してください。(要約すると、コードはGPL 3以降でライセンスされています。)