Prettier と ESLint を使用して高品質なコードを改善する

[‘.eslintrc.cjs’, ‘dist/*’]

ノアプリクルーも素直に落ち着いた時間を過ごせますコードのフォーマットについて議論する心理的なリソース。 同じことは、乗組員の約 1 人が安全ではない、または非生産的な糸を使用する可能性があるコード プラクティスにも当てはまります。 それを明確にするために、Prettier と ESLint のエナジー デュオを使用するようにミッションを構成します — コードの書式設定とコードのリンティングに使用します

精密存在シナリオ PR を見直していると想像してみてください。すぐに書式設定の音声に気付きます。ぶら下がっているカンマがありません。 ニッチピッカーとして知られることを気にしないのに対し、これを取引クエリとして強調します.

余分なコードの痕跡について、同じ声が繰り返されました。 PR をスクロールすると、PR の追加のインスタンスがいくつか表示されます。 すべてのコメントを追加するのをやめますか? 「など」を構築するのをやめますか？ 適切な判断に注意を払わなくても、実際に5分を費やして、回避することなく得られるであろういくつかの選択に出くわす可能性が高い. 書式設定エラーを自動的に修正することで、慌てずに済みます リンターが何かをする同じですが、お粗末なコード慣行用です。 ベンチャーを自動的に修正することの交換として、通常はそうでない場合よりも、コードの一部がミッションクルーによって合意された原則に違反することを完全に強調しています。 これにより、作成者はコード レビューが始まる前に音声を盗んで修正することができます。 [ ‘error’, { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ]

このミームを救っても、学ぶ必要はないでしょう。この記事。 [

‘error’, { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] コードの書式設定とは何ですか?

コードのフォーマットは、判断力よりも美学に大きく関係しています。 問題は、二重引用符の代わりに一重引用符を使用することに喜びを感じます (言語で許可されている場合)。残余がある場合は、パフォーマンス、複雑さ、または読みやすさに影響を与えます。

を持っているuniform コードの書式設定には利益があります読みやすさに影響します。 結局すぐに、単一引用符の代わりに二重引用符で囲まれた文字列を見つめると、たくさんの質問が自動的に頭に浮かびます。 動機でしょうか？ そうでない場合、それは間違いですか？ 落ち着いてこれを修理できますか？ これを強調して落ち着いてもらえますか？ このコードを追加したのは誰ですか (引用符がリファクタリングされたコードにある場合)。 彼らはいつこれを制定したのですか？ もしかしてレガシーコード？ これコードをスキャンするたびに遅くなります。 そして、私たちの何人かは、非公開の侮辱として単に「甘やかされた」(=彼らがつかんだものでも、以前に合意されたものでもない)フォーマットを調達し、ミッションに取り組む彼らのモチベーションを低下させます. リンティングとは何ですか?なぜそれが重要なのですか?

危険なコード、恐ろしい可読性を持つコード、または保存するのが面倒な可能性のあるコードを回避するマップをビルドするだけです。

固有パラメータの再保持を停止します。 発明しないで停止 var

と推測されるもの const. 明らかに async

特性名の先頭には一貫して が付加されますを待つ

。 ぶら下がっているコンマを連続して使用します。 99ほとんどの場合、これらの手法を無視すると、特にコードがリファクタリングされるときに、論理エラーやバグが発生する可能性があります.

フォーマットとリンティングを自動的に終了する必要があるのはなぜですか?

[ 'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] あなたは、ほぼ間違いなく、基本的にあなたが解決する原則を最も多く含むルールセットを叫びたいと思っています。 これらのオブジェクトのすべての原則は、ミッション ESLint 構成内でオーバーライドされます

黄金律 一方、ESLint は各書式設定と非表示を強調表示して倫理的に表示できます。 -formatting (delight in “

ドン特性パラメータを再保持しない

」) 原則、私はこれらの形態の原則が他のすべての場合に扱われることを望みます. フォーマットの原則は、例外なく自動的に一貫して利用されるべきです.

さまざまな手で、非フォーマットの原則が必要です 決して 自動的に利用されることはありません。コミュニティ内でそれらをコミットします(ただし、ある程度の距離を投げてプッシュしないでください).

きれい ["es2020"] これら 2 つの形式の原則の処理を分割し、書式設定の原則を適用するために、他のすべてのアプリケーションは古風なものになります。 それは、その安全な独断的なルールの説明に応じてファイルをフォーマットするという 1 つの本当の本当の動機を持つ公開ライン アプリケーションです. 設定の余地があります (はい、一重引用符または二重引用符を叫ぶ準備ができています) と VSCode プラグイン あなたがよりきれいに過ごす一方で、あなたがうまくいく可能性は高いですPrettier と競合する原則を無効にする ESLint の追加バンドルをインストールしたいと考えています。 そして、ESLint構成内でこれらの原則を有効にしないように明白に発明してください(Prettierがフォーマットを適用した後の他のすべてのケースでは、ESLint生成エラーが一貫して発明されます).

エディターでの自動化 フォーマットを適用するとコンピューター化されているため、コードが追加された後、考えられる限り早く落ち着く必要があります。 VSCode では、ファイルの保存時にいつでもコードの書式設定を利用できます。 VSCode 固有の構成については、下にある「ステップバイステップ」共有を参照してください。

git Commit/Push Hook による自動化

["es2020"] ローグ

開発者は、コード エディターのレイアウト オン キープ チャンスを有効にしないことも正直にできます (または、エディターも正直にそれを強化することはできません)。コミットごとにフォーマットする 発明するリンター エラーが修正されていないコードがリポジトリに取り込まれないことが明らかな場合は、プッシュ時にリント フックを少し離れた場所に追加します

ステップバイステップTypeScript ミッション構成

下のアカデミック用に、Apollo Graph を使用してダミーの TypeScript API を作成します。 QLサーバー.

予備ミッション設定 )
1. ミッションを挑発する

['.eslintrc.cjs', 'dist/*']

npm
mkdir プリティリント['import', 'prettier'] && [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] CD

プリティリント && npm ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 初期化
-y
「トレード」パッケージをインストールします['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] ['.eslintrc.cjs', 'dist/*']

   npm  私 
 @
アポロ
/サーバ [ 'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] graphql["es2020"]
typescript
  

有効にするプロップ 輸入 (この場合は ESModules を使用します)

 [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] [ 'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ]

 [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] ['.eslintrc.cjs', 'dist/*'] 輸入 { ApolloServer } から ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] '@apollo/server' ;

輸入 { startStandaloneServer

}

から '@apollo/server/standalone'

;



輸入 { formatComplex

, formatNameShort['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] }

から './utils/layout.js';



const

本

=;



const

個人

=[

{ firstName: 'John', lastName: 'Appleseed', }, { firstName: 'Robert', lastName: 'Paulson', },];



const

typeDefs

= `#graphql

['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']

種類の本 { タイトル: 文字列

著者：弦 ['lastName'] }

優しい人 {

firstName: 文字列
lastName: 文字列

shortName: 文字列 }

種類のクエリ {

本: [Book!]!

個人: [Person!]!

}

`;

const [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] リゾルバ["es2020"] =

{

クエリ

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] {

書籍: ()=> {

コンソール.["es2020"] ログ

(「これも正直に本を返すことができます」)) ;

戻る ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 本

},

個人["node"]

:

()=> {

戻る

個人

.

目的

((['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 人

)=> ({

...

人

,

shortName

: formatNameShort

(人.

ファーストネーム

,

人.['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 苗字

),

complexName['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']

:

formatComplex

(人.["es2020"] ファーストネーム

,

人['lastName'], 特性

() {

コンソール.['import', 'prettier'] ログ

(

 'ドンク');  
  }), 
 }));  
  }, 

}, };



const

サーバ=集まった

アポロサーバー

({
typeDefs['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] ,

リゾルバ ,

});



const

{ url }=

を待つ startStandalon eServer

 (サーバ, {  

注意を払う:

{ ポート

:

4000

}, });



コンソール. ログ(`🚀 サーバーの希望:

${url

} `);

1つおきに追加 src/utils/layout.ts

ファイル：

輸出

const

formatNameShort ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']=

(初め

、

閉鎖)=>

`${初め.['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 部分文字列
(
0
,1 )) }
。 ${

閉鎖}

`;



輸出 const

formatComplex['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] =(初め

: 弦

,

閉鎖

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 弦

、onComplete

: ()=> 空所,
): 弦

=> {

閉鎖
=

弦(

5);

初め ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']=

初め + "かわった";

var ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] わかった

= 0;

var ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] m

= ["es2020"];

var ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] n

= ["es2020"];

初め ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']=

弦(わかった > [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 0["es2020"]

? 「はい」
: わかった--
);

戻る ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 初め

;

};

を組み立てて に追加) tsconfig.json

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] { "コンパイラオプション"

:

{

['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] "rootDirs"

: ["es2020"],

[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] "outDir" :

"距離",

"lib"

: ["es2020"], ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] "ゴール"

: 「es2020」 ,

"モジュール":

「エスネクスト」

,

"モジュール解像度"

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] "ノード"

,

「esModuleInterop」 : ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 倫理的

,

「種類」['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']

: ["node"],

"パス"

: {

"*":

['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier']

},



"baseUrl"
: "."
,

[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ]

"forceConsistentCasingInFileNames": ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] 倫理的

,

"厳しい"

:

倫理的

、 "skipLibCheck"

:

倫理的

},

「エンコンパス」 :

["es2020"],

"除外": ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] )

}





スクリプトを更新します

['import', 'prettier'] 内で共有bundle.json

:

4. "スクリプト"
   :  {  
    "組み立てる"
   :  "tsc"
    , 
    "始まり":  [
    'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] "npm jog assemble && node ./dist /index.js"
    
     },
   

それをドラッグします： [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ]

2. 開ける http://localhost:4000 そして、「本」に関するクイズ [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] を取得します。

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] きれいに追加

まだ完了していない場合は、Prettier プラグインを VSCode (またはさまざまなプラグイン) にインストールします。編集者)。

vscode-prettier.png[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 追加 ['.eslintrc.cjs', 'dist/*'] .prettierrc ファイル

3.  {

"一重引用符": ["es2020"] エシカル

, "末尾のコンマ"
: "全て",
"印刷幅"
: 100,
"jsxSingleQuote"
: エシカル
}

Cmd+Shift+P → 「ワークスペース設定」 → Enter ;  「プットのフォーマット」;  Editor: Format on Put["es2020"] をテストします。  チェックボックス.
  次に、ワークスペース設定内で「フォーマッター」の可能性を予測し、「Prettier」とナレーションします。 」  

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ]

2. 収集index.ts['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] に出席 そして Cmd+S を押します。 ファイルは自動フォーマットされます。 それが起こらない場合は、次のことを明らかにしてください:
   

3. 「Format on Put」と「Editor: Default Formatter」の両方の選択肢は、Workspace レベルでナレーションされ、さまざまなレベルでナレーションされません.
5. Prettier プラグインがインストールされ、有効になっている(ときどきエディタを再起動する必要があります)

はありません.editorconfig

競合する可能性のある構成を含むファイル

util と同じことを停止します。 s/layout.ts

 
 ESLintを追加 
 
指定されたパッケージをインストールします 

['.eslintrc.cjs', 'dist/*']

npm

私

--

保つ

-dev

@ typescript-

eslint /["es2020"] eslint -

プラグイン
@typescript[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] -

eslint

/パーサー

eslint [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] エスリント["es2020"]

-config -可愛い
eslint

- プラグイン-

可愛い

eslint -プラグイン

-輸入

[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] ESLint 構成ファイルを追加します .eslintrc.cjs

モジュール .
 輸出[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] =

{

[

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] env['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'] :

{

ノード

: [ 'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 倫理的["es2020"] 、

},

拡張 :

['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],

プラグイン

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ], [ 'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 根

:

倫理的

,

原則

: {

'import/no-extraneous-dependencies'

: 'オフ'

,

「コンソールなし」: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] } ]、

'no-param-reassign'

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ], '未使用変数'

: [

'error', { allowExpressions: true, allowHigherOrderFunctions: true, allowTypedFunctionExpressions: true, }, ] 'オフ'

,

'@typescript-eslint/no-unused-vars'

: 'エラー',
'@typescript-eslint/say-characteristic-return-kind':
、 },

ignorePatterns

: