如何通过静态分析提高iOS代码质量

$ brew install swiftlint

pod 'SwiftLint', :configurations => ['Debug']

if which swiftlint >/dev/null; then

  swiftlint

else

  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"

fi

"${PODS\_ROOT}/SwiftLint/swiftlint"

disabled\_rules: # rule identifiers to exclude from running

  - colon

  - trailing\_whitespace

  - vertical\_whitespace

  - function\_body\_length

opt\_in\_rules: # some rules are only opt-in

  - empty\_count

  # Find all the available rules by running:

  # swiftlint rules

included: # paths to include during linting. `--path` is ignored if present.

  - Source

excluded: # paths to ignore during linting. Takes precedence over `included`.

  - Carthage

  - Pods

  - Source/ExcludedFolde

  - Source/ExcludedFile.swift

  - Source/\*/ExcludedFile.swift # Exclude files with a wildcard

analyzer\_rules: # Rules run by `swiftlint analyze` (experimental)

  - explicit\_self



# configurable rules can be customized from this configuration file

# binary rules can set their severity level

force\_cast: warning # implicitly

force\_try:

  severity: warning # explicitly

# rules that have both warning and error levels, can set just the warning level

# implicitly

line\_length: 110

# they can set both implicitly with an array

type\_body\_length:

  - 300 # warning

  - 400 # erro

# or they can set both explicitly

file\_length:

  warning: 500

  error: 1200

# naming rules can set warnings/errors for min\_length and max\_length

# additionally they can set excluded names

type\_name:

  min\_length: 4 # only warning

  max\_length: # warning and erro

    warning: 40

    error: 50

  excluded: iPhone # excluded via string

  allowed\_symbols: ["\_"] # these are allowed in type names

identifier\_name:

  min\_length: # only min\_length

    error: 4 # only erro

  excluded: # excluded via string array

    - id

    - URL

    - GlobalAPIKey

reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit, html, emoji, sonarqube, markdown)

! Function Body Length Violation: Function body should span 40 lines or less excluding comments and whitespace: currently spans 43 lines (function\_body\_length)

# reporter type (xcode, json, csv, checkstyle, junit, html, emoji, sonarqube, markdown)

$ swiftlint lint --reporter html > swiftlint.html

# 不带pod的项目，target名为TargetName，在Debug下，指定模拟器sdk环境进行编译

xcodebuild -target TargetName -configuration Debug -sdk iphonesimulato

# 带pod的项目，workspace名为TargetName.xcworkspace，在Release下，scheme为TargetName，指定真机环境进行编译。不指定模拟器环境会验证证书

xcodebuild -workspace WorkspaceName.xcworkspace -scheme SchemeName Release

# 清楚项目的编译产物

xcodebuild -workspace WorkspaceName.xcworkspace -scheme SchemeName Release clean

$ brew install infe

$ cd projectDi

# 跳过对Pods的分析

$ infer run --skip-analysis-in-path Pods -- xcodebuild -workspace "Project.xcworkspace" -scheme "Scheme" -configuration Debug -sdk iphonesimulato

$ infer explore --html

$ xcodebuild -workspace "Project.xcworkspace" -scheme "Scheme" -configuration Debug -sdk iphonesimulator clean

$ infer run --skip-analysis-in-path Pods -- xcodebuild -workspace "Project.xcworkspace" -scheme "Scheme" -configuration Debug -sdk iphonesimulato

$ brew tap oclint/formulae   

$ brew install oclint

$ oclint --version

LLVM (http://llvm.org/):

  LLVM version 5.0.0svn-r313528

  Optimized build.

  Default target: x86\_64-apple-darwin19.0.0

  Host CPU: skylake



OCLint (http://oclint.org/):

  OCLint version 0.13.

  Built Sep 18 2017 (08:58:40).

1 error generated

1 error generated

...

oclint: error: cannot open report output file ..../onlintReport.html

$ brew install cmake ninja

$ git clone https://github.com/oclint/oclint

$ ./make

OCLint\_PATH=/Users/zhangferry/oclint/build/oclint-release

export PATH=$OCLint\_PATH/bin:$PATH

$ oclint --version

OCLint (http://oclint.org/):

OCLint version 0.15.

Built May 19 2020 (11:48:49).

$ gem install xcpretty

post\_install do |installer|

  installer.pods\_project.targets.each do |target|

      target.build\_configurations.each do |config|

          config.build\_settings['COMPILER\_INDEX\_STORE\_ENABLE'] = "NO"

      end

  end

end

$ xcodebuild -workspace ProjectName.xcworkspace -scheme ProjectScheme -configuration Debug -sdk iphonesimulator | xcpretty -r json-compilation-database -o compile\_commands.json

$ oclint-json-compilation-database -e Pods -- -report-type html -o oclintReport.html -rc LONG\_LINE=9999 -max-priority-1=9999 -max-priority-2=9999 -max-priority-3=9999

#!/bin/bash

# mark sure you had install the oclint and xcpretty



# You need to replace these values with your own project configuration

workspace\_name="WorkSpaceName.xcworkspace"

scheme\_name="SchemeName"



# remove history

rm compile\_commands.json

rm oclint\_result.xml

# clean project

# -sdk iphonesimulator means run simulato

xcodebuild -workspace $workspace\_name -scheme $scheme\_name -configuration Debug -sdk iphonesimulator clean || (echo "command failed"; exit 1);



# export compile\_commands.json

xcodebuild -workspace $workspace\_name -scheme $scheme\_name -configuration Debug -sdk iphonesimulator \

| xcpretty -r json-compilation-database -o compile\_commands.json \

|| (echo "command failed"; exit 1);



# export report html

# you can run `oclint -help` to see all USAGE

oclint-json-compilation-database -e Pods -- -report-type html -o oclintReport.html \

-disable-rule ShortVariableName \

-rc LONG\_LINE=1000 \

|| (echo "command failed"; exit 1);



open -a "/Applications/Safari.app" oclintReport.html

# Type a script or drag a script file from your workspace to insert its path.

# 内置变量

cd ${SRCROOT}

xcodebuild clean 

xcodebuild | xcpretty -r json-compilation-database

oclint-json-compilation-database -e Pods -- -report-type xcode