素晴らしいコミュニティモジュール

JSビューティファイアー

ビルドステータスビルドステータス

PyPIバージョンCDNJSバージョンNPMバージョン統計をダウンロードする

https://gitter.im/beautify-web/js-beautifyでチャットに参加してくださいTwitterフォロー

NPM統計

この小さな美化器は、ブックマークレット、醜いJavaScriptを再フォーマットして再インデントし、Dean Edwardの人気のあるパッカーによってパックされたスクリプトを解凍し、 javascriptobfuscator.comによって処理されたスクリプトを難読化解除します。

必要な貢献者

現在、既存の所有者がこのプロジェクトに取り組む時間が非常に限られているため、この前面と中央を上に置きます。これは人気のあるプロジェクトであり、広く使用されていますが、顧客が直面しているバグと根本的な問題の両方を修正することにコミットする時間のある貢献者が必死に必要です。内部の設計と実装で。

興味のある方は、 CONTRIBUTING.mdをご覧になり、「 CONTRIBUTING.md ラベルの付いた問題を修正してPRを送信してください。できるだけ頻繁に繰り返してください。ありがとうございます。

使用法

WebブラウザでJSBeautifierを使用するか、node.jsまたはpythonを使用してコマンドラインでjavascriptを美化できます。

JS Beautifierは、cdnjsとrawgitの2つのCDNサービスでホストされています。

これらのサービスのいずれかからプルするには、以下のスクリプトタグのセットをドキュメントに含めます。

1 2 3 4 5 6 7 8 9 10 11
<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-css.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-html.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-css.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-html.min.js"></script> <script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify.js"></script> <script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify-css.js"></script> <script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify-html.js"></script>

免責事項:これらは無料のサービスであるため、稼働時間やサポートの保証はありません

ウェブブラウザ

jsbeautifier.orgを開きます。オプションはUIから利用できます。

Python

pythonを使用して美化するには:

1 2
$ pip install jsbeautifier $ js-beautify file.js

美化された出力はstdout送られます。

jsbeautifierをライブラリとして使用するのは簡単です。

1 2 3
import jsbeautifier res = jsbeautifier.beautify('your javascript string') res = jsbeautifier.beautify_file('some_file.js')

...または、いくつかのオプションを指定するには:

1 2 3 4
opts = jsbeautifier.default_options() opts.indent_size = 2 opts.space_in_empty_paren = True res = jsbeautifier.beautify('some javascript', opts)

構成オプション名はCLI名と同じですが、ダッシュではなく下線が付いています。上記の例は、コマンドラインで--indent-size 2 --space-in-empty-parenとして設定されます。

JavaScript

Pythonスクリプトの代わりに、NPMパッケージjs-beautifyインストールすることもできます。グローバルにインストールすると、実行可能なjs-beautifyスクリプトが提供されますjs-beautifyスクリプトと同様に、特に設定されていない限り、美化された結果はstdout送信されます。

1 2
$ npm -g install js-beautify $ js-beautify foo.js

js-beautifynodeライブラリとして使用することもできます(ローカルにインストールしますnpmデフォルト)。

1
$ npm install js-beautify

javascript(js)、css、またはhtmlの適切なbeautifierメソッドをインポートして呼び出します。3つのメソッドシグネチャはすべてbeautify(code, options)ですcodeは、美化するコードの文字列です。optionsは、設定を行うオブジェクトです。コードを美化するために使用されるように。

構成オプション名はCLI名と同じですが、ダッシュの代わりに下線が付いています。たとえば、 --indent-size 2 --space-in-empty-paren{ indent_size: 2, space_in_empty_paren: true }ます。

1 2 3 4 5 6 7 8 9
var beautify = require('js-beautify').js, fs = require('fs'); fs.readFile('foo.js', 'utf8', function (err, data) { if (err) { throw err; } console.log(beautify(data, { indent_size: 2, space_in_empty_paren: true })); });

オプション

これらは、PythonスクリプトとJSスクリプトの両方のコマンドラインフラグです。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
CLI Options: -f, --file Input file(s) (Pass '-' for stdin) -r, --replace Write output in-place, replacing input -o, --outfile Write output to file (default stdout) --config Path to config file --type [js|css|html] ["js"] -q, --quiet Suppress logging to stdout -h, --help Show this help -v, --version Show the version Beautifier Options: -s, --indent-size Indentation size [4] -c, --indent-char Indentation character [" "] -t, --indent-with-tabs Indent with tabs, overrides -s and -c -e, --eol Character(s) to use as line terminators. [first newline in file, otherwise "\n] -n, --end-with-newline End output with newline --editorconfig Use EditorConfig to set up the options -l, --indent-level Initial indentation level [0] -p, --preserve-newlines Preserve line-breaks (--no-preserve-newlines disables) -m, --max-preserve-newlines Number of line-breaks to be preserved in one chunk [10] -P, --space-in-paren Add padding spaces within paren, ie. f( a, b ) -E, --space-in-empty-paren Add a single space inside empty paren, ie. f( ) -j, --jslint-happy Enable jslint-stricter mode -a, --space-after-anon-function Add a space before an anonymous function's parens, ie. function () -b, --brace-style [collapse|expand|end-expand|none][,preserve-inline] [collapse,preserve-inline] -u, --unindent-chained-methods Don't indent chained method calls -B, --break-chained-methods Break chained method calls across subsequent lines -k, --keep-array-indentation Preserve array indentation -x, --unescape-strings Decode printable characters encoded in xNN notation -w, --wrap-line-length Wrap lines at next opportunity after N characters [0] -X, --e4x Pass E4X xml literals through untouched --good-stuff Warm the cockles of Crockford's heart -C, --comma-first Put commas at the beginning of new line instead of end -O, --operator-position Set operator position (before-newline|after-newline|preserve-newline) [before-newline]

両方のライブラリインターフェイスで下線が引かれたオプションキーに対応します

CLIオプションごとのデフォルト

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
{ "indent_size": 4, "indent_char": " ", "indent_with_tabs": false, "eol": "\n", "end_with_newline": false, "indent_level": 0, "preserve_newlines": true, "max_preserve_newlines": 10, "space_in_paren": false, "space_in_empty_paren": false, "jslint_happy": false, "space_after_anon_function": false, "brace_style": "collapse", "unindent_chained_methods": false, "break_chained_methods": false, "keep_array_indentation": false, "unescape_strings": false, "wrap_line_length": 0, "e4x": false, "comma_first": false, "operator_position": "before-newline" }

cliで公開されていないデフォルト

1 2 3 4
{ "eval_code": false, "space_before_conditional": true }

すべてのデフォルトがCLIを介して公開されているわけではないことに注意してください。これまで、PythonとJS APIは100%同一ではありませんでした。たとえば、 space_before_conditionalは現在JSのみであり、CLIスクリプトからアドレス指定できません。 100%のAPI互換性から私たちを守ります。

Loading settings from environment or .jsbeautifyrc (JavaScript-Only)

CLI引数に加えて、次の方法で構成をJS実行可能ファイルに渡すことができます。

  • 任意のjsbeautify_接頭jsbeautify_付き環境変数
  • --configパラメーターで示されるJSON形式のファイル
  • $PWD超えるファイルシステムの任意のレベルのJSONデータを含む.jsbeautifyrcファイル

このスタックの前半で提供された構成ソースは、後の構成ソースをオーバーライドします。

Setting inheritance and Language-specific overrides

設定は浅いツリーであり、その値はすべての言語で継承されますが、オーバーライドできます。これは、どちらの実装でもAPIに直接渡される設定で機能します。Javascriptの実装では、.jsbeautifyrcなどの構成ファイルから読み込まれた設定で次のことができます。継承/オーバーライドも使用します。

以下は、言語オーバーライドノードでサポートされているすべての場所を示す構成ツリーの例ですindent_sizeを使用して、この構成の動作について説明しますが、任意の数の設定を継承またはオーバーライドできます。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
{ "indent_size": 4, "html": { "end_with_newline": true, "js": { "indent_size": 2 }, "css": { "indent_size": 2 } }, "css": { "indent_size": 1 }, "js": { "preserve-newlines": true } }

上記の例を使用すると、次の結果が得られます。

  • HTMLファイル
    • トップレベルの設定から4スペースのindent_sizeを継承します。
    • ファイルもnewlineで終わります。
    • HTML内のJavaScriptとCSS
      • HTMLのend_with_newline設定を継承します
      • インデントを2スペースにオーバーライドします
  • CSSファイル
    • トップレベルの設定を1スペースのindent_sizeにオーバーライドします。
  • JavaScriptファイル
    • トップレベル設定から4スペースのindent_sizeを継承します
    • preserve-newlinestrue設定しtrue

CSS & HTML

js-beautify実行可能ファイルに加えて、 css-beautifyhtml-beautify js-beautify --cssも、これらのスクリプトへの簡単なインターフェイスとして提供されます。あるいは、 js-beautify --cssまたはjs-beautify --htmlは、それぞれ同じことを実行します。

1 2 3 4 5 6
// Programmatic access var beautify_js = require('js-beautify'); // also available under "js" export var beautify_css = require('js-beautify').css; var beautify_html = require('js-beautify').html; // All methods accept two arguments, the string to be beautified, and an options object.

CSSとHTMLの美化装置は、範囲がはるかに単純であり、オプションがはるかに少なくなっています。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
CSS Beautifier Options: -s, --indent-size Indentation size [4] -c, --indent-char Indentation character [" "] -t, --indent-with-tabs Indent with tabs, overrides -s and -c -e, --eol Character(s) to use as line terminators. (default newline - "\\n") -n, --end-with-newline End output with newline -L, --selector-separator-newline Add a newline between multiple selectors -N, --newline-between-rules Add a newline between CSS rules HTML Beautifier Options: -s, --indent-size Indentation size [4] -c, --indent-char Indentation character [" "] -t, --indent-with-tabs Indent with tabs, overrides -s and -c -e, --eol Character(s) to use as line terminators. (default newline - "\\n") -n, --end-with-newline End output with newline -p, --preserve-newlines Preserve existing line-breaks (--no-preserve-newlines disables) -m, --max-preserve-newlines Maximum number of line-breaks to be preserved in one chunk [10] -I, --indent-inner-html Indent <head> and <body> sections. Default is false. -b, --brace-style [collapse-preserve-inline|collapse|expand|end-expand|none] ["collapse"] -S, --indent-scripts [keep|separate|normal] ["normal"] -w, --wrap-line-length Maximum characters per line (0 disables) [250] -A, --wrap-attributes Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] ["auto"] -i, --wrap-attributes-indent-size Indent wrapped attributes to after N characters [indent-size] (ignored if wrap-attributes is "force-aligned") -U, --unformatted List of tags (defaults to inline) that should not be reformatted -T, --content_unformatted List of tags (defaults to pre) whose content should not be reformatted -E, --extra_liners List of tags (defaults to [head,body,/html] that should have an extra newline before them. --editorconfig Use EditorConfig to set up the options

セクションを無視または保持するためのディレクティブ(Javascriptのみ)

Beautifier forは、ファイル内のコメント内のディレクティブをサポートします。これにより、ファイルのフォーマットを保持するか、ファイルの一部を完全に無視するようにビューティファイアに指示できます。以下の入力例は、ビューティフィケーション後も変更されたままになります。

1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Use preserve when the content is not javascript, but you don't want it reformatted. /* beautify preserve:start */ { browserName: 'internet explorer', platform: 'Windows 7', version: '8' } /* beautify preserve:end */ // Use ignore when the content is not parsable as javascript. var a = 1; /* beautify ignore:start */ {This is some strange{template language{using open-braces? /* beautify ignore:end */

ライセンス

これが便利または機能していると思われる場合に備えて、これを自由に使用できますが、著作権に関する通知とライセンスを保持する必要があります。(MIT)

クレジット

Jason Diamond、Patrick Hof、Nochum Sossonko、Andreas Schneider、Dave Vasilevsky、Vital Batmanov、Ron Baldwin、Gabriel Harrison、Chris J. Shull、Mathias Bynens、VittorioGambalettaなどにも感謝します。

(README.md: js-beautify@1.7.5