OSS Gate Workshop: ゆるい勉強会旭川: 2024-07-28: hana979: laravel/pint: Work log

oss-gate / workshop

OSSの開発に未参加または参加したことはあるけどまだ自信がない人を後押しするワークショップ用のリポジトリー

124 stars 547 forks source link

OSS Gate Workshop: ゆるい勉強会旭川: 2024-07-28: hana979: laravel/pint: Work log #1852

Closed hana979 closed 4 months ago

hana979 commented 4 months ago

This is a work log of a "OSS Gate workshop". "OSS Gate workshop" is an activity to increase OSS developers. Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

スライド：ワークショップの進行に使っているスライドがあります。
チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

hana979 commented 4 months ago

https://github.com/laravel/pint を選びました。

https://github.com/laravel/pint/blob/main/LICENSE.md があり、MITライセンスだったので、OSSだと確認できました。

hana979 commented 4 months ago

CONTRIBUTING.mdにコントリビュートの説明があった。（LaravelのContribution Guideに従って行うように記載があった）

https://github.com/laravel/pint/blob/main/.github/CONTRIBUTING.md https://laravel.com/docs/11.x/contributions

fujiokayu commented 4 months ago

公式ドキュメントにインストール方法や利用方法が記載してあった

Laravel Pint

hana979 commented 4 months ago

README.mdなどには、ローカルテストの記述はありませんでした。なので、標準的なphpライブラリのパッケージのインストールやテストなどを試してみる。

hana979 commented 4 months ago

composer installを実行してテストを実行できるようにした。

テストを実行したらオールパスしました。

./vendor/bin/pest

hana979 commented 4 months ago

phpstanを実行してエラーが出た

hanada@toshiki pint % ./vendor/bin/phpstan
Note: Using configuration file /Users/hanada/study/oss-gate/pint/phpstan.neon.
⚠️  You're using a deprecated config option checkGenericClassInNonGenericObjectType ⚠️️

It's strongly recommended to remove it from your configuration file
and add the missing generic typehints.

If you want to continue ignoring missing typehints from generics,
add missingType.generics error identifier to your ignoreErrors:

parameters:
        ignoreErrors:
                -
                        identifier: missingType.generics

 27/27 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 -- ---------------------------------------------------------------------------- 
     Error                                                                       
 -- ---------------------------------------------------------------------------- 
     Some parallel worker jobs have not finished. while running parallel worker  
 -- ---------------------------------------------------------------------------- 

 [ERROR] Found 1 error                                                                                                  

⚠️  Result is incomplete because of severe errors. ⚠️
   Fix these errors first and then re-run PHPStan
   to get all reported errors.

hana979 commented 4 months ago

どうやらメモリ不足によるエラーのようなので、オプションをつけて実行するとエラーは解決できた。 https://github.com/phpstan/phpstan/discussions/11137

hanada@toshiki pint % ./vendor/bin/phpstan --memory-limit=2G
Note: Using configuration file /Users/hanada/study/oss-gate/pint/phpstan.neon.
⚠️  You're using a deprecated config option checkGenericClassInNonGenericObjectType ⚠️️

It's strongly recommended to remove it from your configuration file
and add the missing generic typehints.

If you want to continue ignoring missing typehints from generics,
add missingType.generics error identifier to your ignoreErrors:

parameters:
    ignoreErrors:
        -
            identifier: missingType.generics

 27/27 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 [OK] No errors

hana979 commented 4 months ago

⚠️ You're using a deprecated config option checkGenericClassInNonGenericObjectType ⚠️️

It's strongly recommended to remove it from your configuration file and add the missing generic typehints.

以前として、非推奨オプションに関しての警告が出ていたが、「phpstan.neon」のcheckGenericClassInNonGenericObjectTypeオプションを削除すると表示されなくなった。

hanada@toshiki pint % ./vendor/bin/phpstan --memory-limit=2G
Note: Using configuration file /Users/hanada/study/oss-gate/pint/phpstan.neon.
 27/27 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 [OK] No errors

hana979 commented 4 months ago

非推奨オプションのcheckGenericClassInNonGenericObjectTypeに関しては、削除する方針で良さそう。削除後に再度、テストも実行したが問題なくパスしていることを確認した。 checkGenericClassInNonGenericObjectTypeで検索して、過去にissueとして取り上げられてないことを確認した。

非推奨オプションの削除に関するPRを実行しようと思う。

hana979 commented 4 months ago

PRを送りました！ https://github.com/laravel/pint/pull/287

github-actions[bot] commented 4 months ago

おつかれさまでした！

ワークショップの終了にともないissueを閉じますが、このまま作業メモとして使っても構いません :ok_hand:

ワークショップの感想を集めています！

ブログなどに書かれた際は、このページへリンクの追加をお願いします :pray:

またの参加をお待ちしています！