Merge pull request #1063 from stephencelis/swiftlint

Add linting

Author: jberkel

.cocoadocs.yml

@@ -14,6 +14,13 @@ jobs:
         gem install xcpretty --no-document
         brew update
         brew outdated carthage || brew upgrade carthage
+        brew outdated swiftlint || brew upgrade swiftlint
+    - name: "Lint"
+      run: make lint
+    - name: "Run tests (PACKAGE_MANAGER_COMMAND: test)"
+      env:
+        PACKAGE_MANAGER_COMMAND: test -Xswiftc -warnings-as-errors
+      run: ./run-tests.sh
     - name: "Run tests (BUILD_SCHEME: SQLite iOS)"
       env:
         BUILD_SCHEME: SQLite iOS
@@ -54,7 +61,3 @@ jobs:
       env:
         CARTHAGE_PLATFORM: tvOS
       run: ./run-tests.sh
-    - name: "Run tests (PACKAGE_MANAGER_COMMAND: test)"
-      env:
-        PACKAGE_MANAGER_COMMAND: test
-      run: ./run-tests.sh

.github/workflows/build.yml

@@ -0,0 +1,42 @@
+disabled_rules: # rule identifiers to exclude from running
+  - todo
+  - operator_whitespace
+  - large_tuple
+  - closure_parameter_position
+included: # paths to include during linting. `--path` is ignored if present. takes precendence over `excluded`.
+  - Sources
+  - Tests
+excluded: # paths to ignore during linting. overridden by `included`.
+
+identifier_name:
+  excluded:
+    - db
+    - in
+    - to
+    - by
+    - or
+    - eq
+    - gt
+    - lt
+    - fn
+    - a
+    - b
+    - q
+    - SQLITE_TRANSIENT
+
+type_body_length:
+  warning: 260
+  error: 260
+
+function_body_length:
+  warning: 60
+  error: 60
+
+line_length:
+  warning: 150
+  error: 150
+  ignores_comments: true
+
+file_length:
+  warning: 900
+  error: 900

.swiftlint.yml

@@ -19,7 +19,7 @@ addresses everything. If it doesn’t, continue the conversation there.
 If your searches return empty, see the [bug](#bugs) or [feature
 request](#feature-requests) guidelines below.
 
-[Ask on Stack Overflow]: http://stackoverflow.com/questions/tagged/sqlite.swift
+[Ask on Stack Overflow]: https://stackoverflow.com/questions/tagged/sqlite.swift
 [Search]: https://github.com/stephencelis/SQLite.swift/search?type=Issues
 
 

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# SQLite.swift Release checklist
+
+* [ ] Make sure current master branch has a green build
+* [ ] Make sure `CHANGELOG.md` is up-to-date
+* [ ] Update the version number in `SQLite.swift.podspec`
+* [ ] Run `pod lib lint` locally
+* [ ] Update the version numbers mentioned in `README.md`, `Documentation/Index.md`
+* [ ] Update `MARKETING_VERSION` in `SQLite.xcodeproj/project.pbxproj`
+* [ ] Create a tag with the version number (`x.y.z`)
+* [ ] Publish to CocoaPods: `pod trunk push`
+* [ ] Update the release information on GitHub

Documentation/Release.md

@@ -9,52 +9,31 @@ else
 endif
 
 XCPRETTY := $(shell command -v xcpretty)
-SWIFTCOV := $(shell command -v swiftcov)
-GCOVR := $(shell command -v gcovr)
 TEST_ACTIONS := clean build build-for-testing test-without-building
 
 default: test
 
 build:
 	$(BUILD_TOOL) $(BUILD_ARGUMENTS)
 
+lint:
+	swiftlint --strict
+
 test:
 ifdef XCPRETTY
 	@set -o pipefail && $(BUILD_TOOL) $(BUILD_ARGUMENTS) $(TEST_ACTIONS) | $(XCPRETTY) -c
 else
 	$(BUILD_TOOL) $(BUILD_ARGUMENTS) $(TEST_ACTIONS)
 endif
 
-coverage:
-ifdef SWIFTCOV
-	$(SWIFTCOV) generate --output coverage \
-		$(BUILD_TOOL) $(BUILD_ARGUMENTS) -configuration Release test \
-		-- ./SQLite/*.swift
-ifdef GCOVR
-	$(GCOVR) \
-		--root . \
-		--use-gcov-files \
-		--html \
-		--html-details \
-		--output coverage/index.html \
-		--keep
-else
-	@echo gcovr must be installed for HTML output: https://github.com/gcovr/gcovr
-endif
-else
-	@echo swiftcov must be installed for coverage: https://github.com/realm/SwiftCov
-	@exit 1
-endif
-
 clean:
 	$(BUILD_TOOL) $(BUILD_ARGUMENTS) clean
-	rm -r coverage
 
 repl:
 	@$(BUILD_TOOL) $(BUILD_ARGUMENTS) -derivedDataPath $(TMPDIR)/SQLite.swift > /dev/null && \
 		swift -F '$(TMPDIR)/SQLite.swift/Build/Products/Debug'
 
 sloc:
-	@zsh -c "grep -vE '^ *//|^$$' SQLite/*/*.{swift,h,m} | wc -l"
+	@zsh -c "grep -vE '^ *//|^$$' Sources/**/*.{swift,h,m} | wc -l"
 
-.PHONY: test coverage clean repl sloc
+.PHONY: test clean repl sloc

Makefile

@@ -20,7 +20,7 @@ syntax _and_ intent.
  - Extensively tested
  - [SQLCipher][] support via CocoaPods
  - Active support at
-   [StackOverflow](http://stackoverflow.com/questions/tagged/sqlite.swift),
+   [StackOverflow](https://stackoverflow.com/questions/tagged/sqlite.swift),
    and [Gitter Chat Room](https://gitter.im/stephencelis/SQLite.swift)
    (_experimental_)
 
@@ -119,7 +119,7 @@ For a more comprehensive example, see
 and the [companion repository][SQLiteDataAccessLayer2].
 
 
-[Create a Data Access Layer with SQLite.swift and Swift 2]: http://masteringswift.blogspot.com/2015/09/create-data-access-layer-with.html
+[Create a Data Access Layer with SQLite.swift and Swift 2]: https://masteringswift.blogspot.com/2015/09/create-data-access-layer-with.html
 [SQLiteDataAccessLayer2]: https://github.com/hoffmanjon/SQLiteDataAccessLayer2/tree/master
 
 ## Installation
@@ -226,7 +226,7 @@ device:
 
 
 [Xcode]: https://developer.apple.com/xcode/downloads/
-[Submodule]: http://git-scm.com/book/en/Git-Tools-Submodules
+[Submodule]: https://git-scm.com/book/en/Git-Tools-Submodules
 [download]: https://github.com/stephencelis/SQLite.swift/archive/master.zip
 
 
@@ -243,7 +243,7 @@ device:
 
 [See the planning document]: /Documentation/Planning.md
 [Read the contributing guidelines]: ./CONTRIBUTING.md#contributing
-[Ask on Stack Overflow]: http://stackoverflow.com/questions/tagged/sqlite.swift
+[Ask on Stack Overflow]: https://stackoverflow.com/questions/tagged/sqlite.swift
 [Open an issue]: https://github.com/stephencelis/SQLite.swift/issues/new
 [Submit a pull request]: https://github.com/stephencelis/SQLite.swift/fork
 
@@ -280,16 +280,16 @@ Looking for something else? Try another Swift wrapper (or [FMDB][]):
  - [SwiftSQLite](https://github.com/chrismsimpson/SwiftSQLite)
 
 [Swift]: https://swift.org/
-[SQLite3]: http://www.sqlite.org
+[SQLite3]: https://www.sqlite.org
 [SQLite.swift]: https://github.com/stephencelis/SQLite.swift
 
 [GitHubActionBadge]: https://img.shields.io/github/workflow/status/stephencelis/SQLite.swift/Build%20and%20test
 
 [CocoaPodsVersionBadge]: https://cocoapod-badges.herokuapp.com/v/SQLite.swift/badge.png
-[CocoaPodsVersionLink]: http://cocoadocs.org/docsets/SQLite.swift
+[CocoaPodsVersionLink]: https://cocoapods.org/pods/SQLite.swift
 
 [PlatformBadge]: https://cocoapod-badges.herokuapp.com/p/SQLite.swift/badge.png
-[PlatformLink]: http://cocoadocs.org/docsets/SQLite.swift
+[PlatformLink]: https://cocoapods.org/pods/SQLite.swift
 
 [CartagheBadge]: https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat
 [CarthageLink]: https://github.com/Carthage/Carthage

README.md

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name             = "SQLite.swift"
   s.version          = "0.13.0"
-  s.summary          = "A type-safe, Swift-language layer over SQLite3 for iOS and macOS."
+  s.summary          = "A type-safe, Swift-language layer over SQLite3."
 
   s.description      = <<-DESC
     SQLite.swift provides compile-time confidence in SQL statement syntax and
@@ -17,13 +17,12 @@ Pod::Spec.new do |s|
   s.module_name      = 'SQLite'
   s.default_subspec  = 'standard'
   s.swift_versions = ['5']
-  
-  
+
   ios_deployment_target = '9.0'
   tvos_deployment_target = '9.1'
   osx_deployment_target = '10.15'
   watchos_deployment_target = '3.0'
-  
+
   s.ios.deployment_target = ios_deployment_target
   s.tvos.deployment_target = tvos_deployment_target
   s.osx.deployment_target = osx_deployment_target