Skip to content

Instantly share code, notes, and snippets.

View scott-lydon's full-sized avatar

Scott scott-lydon

  • High Five
  • Burlingame
View GitHub Profile
@scott-lydon
scott-lydon / CI.md
Last active August 7, 2024 23:22
CI/CD Pipeline verfiication checklist

Job Requirements Checklist

  • Present errors and warnings in github messages for the pr, using the default message formating if any is available, or include at least include " in the header" and the error or warning in the message For the following plugins:
    • Codecov
    • SonarQube
    • SwiftLint
    • Coverity
    • Codebeat
    • GPTLint
  • Scottlint

Coding Guidelines

Rules

  1. Omit the return keyword in one-line functions that return a value.
  2. Use trailing closure syntax.
  3. Remove the Google indentation guide rule due to lack of specific guidelines in the Google Swift style guide and because SwiftLint handles indentation.
  4. Reevaluate the rule regarding DispatchQueue from inaction on the main thread for feasibility in static analysis.
  5. Use higher-order functions when multiple properties call the same function.
  6. Require every method to have a comment.

Coding Guidelines

Rules

  1. Omit the return keyword in one-line functions that return a value.
  2. Use trailing closure syntax.
  3. Remove the Google indentation guide rule due to lack of specific guidelines in the Google Swift style guide and because SwiftLint handles indentation.
  4. Reevaluate the rule regarding DispatchQueue from inaction on the main thread for feasibility in static analysis.
  5. Use higher-order functions when multiple properties call the same function.
  6. Require every method to have a comment.
# Coding Guidelines
## Rules
1. **Omit the return keyword in one-line functions that return a value.**
2. **Use trailing closure syntax.**
3. **Remove the Google indentation guide rule due to lack of specific guidelines in the Google Swift style guide and because SwiftLint handles indentation.**
4. **Reevaluate the rule regarding DispatchQueue from inaction on the main thread for feasibility in static analysis.**
5. **Use higher-order functions when multiple properties call the same function.**
6. **Require every method to have a comment.**
1. Omit the return keyword in one-line functions that return a value.
Non-triggering examples:
swift
Copy code
func blocks() -> [Block] {
.all(with: .retained, times: 2)
}
swift
// No Model in names
/*
throw an error when a class or struct is added that doesn't
use the word model in the name, and isn't a subclass of a
UIViewController, nor UIView, nor view, uiviewRepresentable,
codable or observer.
*/
import UIKit
@scott-lydon
scott-lydon / PullRequestChecklist.md
Created November 22, 2022 22:49
A checklist for pull requests. It is added to as I get feedback for prs.
  • Its better to use existing functions than to create your own
  • Its better to add functionality to existing types than to create new types.
  • Remove unused code.
  • Give ui tests a timeout, longer for ci
  • following conventions for teams.
@scott-lydon
scott-lydon / FindCellInUITest.swift
Last active November 11, 2022 22:33
It's hard to access elements in tableviews sometimes, even when they are on the screen.
class QRCodeTarotUITests: XCTestCase {
override func setUpWithError() throws {
// Put setup code here. This method is called before the invocation of each test method in the class.
// In UI tests it is usually best to stop immediately when a failure occurs.
continueAfterFailure = false
// In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
}
//
// WeirdIssue.swift
// QRCodeTarot
//
// Created by Scott Lydon on 9/24/22.
//
import SwiftUI
struct WeirdIssue: View {
struct TestText: View {
var body: some View {
HStack(alignment: .firstTextBaseline) {
Text("Hello world")
Spacer()
}
}
}