Dart/Flutterのための静的コード解析

dartanalyzerを使った、Dart/Flutterの静的コード解析についての発表です。
CircleCI上でdartanalyzerを実行し、Github Pull Requestにコメントを入れる手順まで紹介しています。

Flutter勉強会 in 福岡 #3 & Fukuoka.dart #1 - connpass
https://flat-lab.connpass.com/event/113785/

flutter/flutterの公式analysis_options.yaml
https://github.com/flutter/flutter/blob/stable/analysis_options.yaml

```.circleci/config.yml
version: 2
jobs:
lint:
docker:
- image: kuronekomichael/flutter:stable
steps:
- checkout
- run: 'flutter packages get'
- run: 'dartcop . | reviewdog -f=checkstyle -name=dartcop -reporter=github-pr-review'
workflows:
version: 2
build_and_test:
jobs:
- lint
```

1. dartanalyzerのラッパー「dartcop」
https://github.com/kuronekomichael/dartcop

2. Dart/Flutter用のdockerイメージ「kuronekomichael/flutter」
https://hub.docker.com/r/kuronekomichael/flutter/dockerfile

Transcript

1. ੩తίʔυղੳ Dart/FlutterͷͨΊͷ
2. Ͷ͜·͍͚Δ @KURONEKOMICHAEL
3. ੩తίʔυղੳͯ͠· ͔͢ʁʂ ΈΜͳʂ
4. ֤ݴޠຖͷ੩తίʔυղੳπʔϧ PHP = PHPMD, PHPCS JAVASCRIPT = ESLINT GOLANG = GOLINT DART = ?
5. DARTANALYZER DARTެࣜͷ੩తίʔυղੳπʔϧ
6. DART SDKʹಉࠝ͞Ε͍ͯΔͷͰɺ͙͢ʹ࢖͑Δʂ
7. IDE্Ͱ΋੩తίʔυղੳͷ݁Ռ͕֬ೝՄೳ
8. ϧʔϧͷΧελϚΠζ΋؆୯ ΧϨϯτσΟϨΫτϦʹʮanalysis_options.yamlʯΛஔ͚ͩ͘ʂ analyzer: strong-mode: implicit-dynamic: false errors: # treat missing required parameters as a warning (not a hint) missing_required_param: warning # treat missing returns as a warning (not a hint) missing_return: warning # allow having TODOs in the code todo: ignore exclude: - 'bin/cache/**' # the following two are relative to the stocks example and the flutter package respectively # see https://github.com/dart-lang/sdk/issues/28463 - 'lib/i18n/stock_messages_*.dart' - 'lib/src/http/**' linter: rules: # these rules are documented on and in the same order as # the Dart Lint rules page to make maintenance easier # https://github.com/dart-lang/linter/blob/master/example/all.yaml - always_declare_return_types - always_put_control_body_on_new_line # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/ flutter/issues/10219 - always_require_non_null_named_parameters - always_specify_types
9. Զʹ͸ψϧ͍ ඪ४ͷϧʔϧ͸
10. Φεεϝઃఆ ϚʔΫ ඪ४ͩͱϧʔϧ͕ψϧ͍ͷͰɺ Flutterެࣜͷ analysis_options.yaml ͕Φεεϝ ΄ͲΑ͘ݫ͘͠ ㅟ ㅟ ㅟ ΑΓϞμϯʹ ㅟ ㅟ ㅟ https://github.com/flutter/flutter
11. ਓؒ͸ؒҧ͍Λ ൜͢ಈ෺Ͱ͋Δ
12. ͦΕͰ΋ବ໨ίʔ υ͸ฆΕࠐΉ
13. ଵଦ͸৺ͷ ຾Γͩɻ (BOTʹ೚ͤΑ͏) ϰΥʔϰφϧά ňল࡯ͱ֨ݴʼn
14. CONTINUS INTEGRATION CIͰࣗಈԽ͠Α͏ Github Pull Request + Circle CI + dartanalyzer
15. dartanalyzer ᶃ Pull RequestΛpush ᶄJOBΛىಈ ᶅղੳ࣮ߦ ᶆ݁ՌͷҾ͖౉͠ ᶇPull Request্Ͱࢦఠ
16. STEP 1 (ඞཁʹԠͯ͡)dartanalyzerͷϧʔϧϑΝΠϧΛೖΕΔ analysis_options.yaml $ curl -O https://raw.githubusercontent.com/flutter/flutter/stable/analysis_options.yaml
17. STEP 2 CircleCIͷઃఆϑΝΠϧΛίϛοτ͢Δ .circleci/config.yml version: 2 jobs: lint: docker: - image: kuronekomichael/flutter:stable steps: - checkout - run: 'flutter packages get' - run: 'dartcop . | reviewdog -f=checkstyle -name=dartcop -reporter=github-pr-review' workflows: version: 2 build_and_test: jobs: - lint
18. STEP 3 CircleCIΛઃఆ͢Δ ▸ Point1. reviewdog͔ΒPull RequestʹίϝϯτͰ͖ΔΑ͏ɺ ؀ڥม਺ʹGitHubͷAPIτʔΫϯΛઃఆͯ͋͛͠Δ
 REVIEWDOG_GITHUB_API_TOKEN ▸ Point2. Pull Request͚ͩδϣϒΛ૸ΒͤΔΑ͏ઃఆ
 [Settings]-[Advanced Settings]-[Only build pull requests]
 •On
19. ט·ΕΔ☺
20. खલຯḩͳ࿩ 1. dartanalyzerͷϥούʔʮdartcopʯ dartanalyzer͸ಠࣗܗࣜͷग़ྗ͔͠ରԠ͍ͯ͠ͳ͍ ͷͰɺreviewdog͕ಡΈࠐΈͰ͖ΔΑ͏ʹϥούʔ ͷπʔϧΛ࣮૷͠·ͨ͠ ຊ౰͸reviewdogͷefmͰ࣮ݱग़དྷΔ͸ͣͳΜͰ͕͢ɺ͝ΊΜͳ͍͞... https://github.com/kuronekomichael/dartcop 2. Dart/Flutter༻ͷdockerΠϝʔδʮkuronekomichael/flutterʯ LinuxϕʔεͰ͕͢ɺflutter SDKΛؚΊ dartanalyzer,্هͷdartcop,reviewdog΋ؚΊͯશ ෦ͥΜͿೖΕͪΌͬͨDockerΠϝʔδɻେ͖Ίɻ https://hub.docker.com/r/kuronekomichael/flutter/dockerfile
21. HAPPY HACKING!!