Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #2

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: ['https://cash.app/$zanchee']
50 changes: 50 additions & 0 deletions .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: 🚨 Checks

on:
push:
branches:
- main
pull_request:
branches:
- '*'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
lint:
name: 📝 Lint
runs-on: ubuntu-latest
steps:
- name: 🗄️ Checkout Code
uses: actions/checkout@v4
- name: 📝 SwiftLint
uses: stanfordbdhg/action-swiftlint@v4
with:
args: --strict
test:
name: 🧪 Test
runs-on: macos-latest
strategy:
matrix:
platform: [IOS, MACOS, MAC_CATALYST, TVOS, WATCHOS]
steps:
- name: 👀 Install visionOS runtime
if: matrix.platform == 'visionOS'
run: |
sudo xcodebuild -runFirstLaunch
sudo xcrun simctl list
sudo xcodebuild -downloadPlatform visionOS
sudo xcodebuild -runFirstLaunch
- name: 🗄️ Checkout Code
uses: actions/checkout@v4
- name: 🧰 Select Xcode Version
run: xcodes select 16
- name: 🧪 Run tests
run: make XCODEBUILD_ARGUMENT=test CONFIG=Debug PLATFORM='${{ matrix.platform }}'
- name: 📊 Upload Coverage
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
swift: true
97 changes: 7 additions & 90 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,90 +1,7 @@
# Xcode
#
# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore

## User settings
xcuserdata/

## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
*.xcscmblueprint
*.xccheckout

## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
build/
DerivedData/
*.moved-aside
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3

## Obj-C/Swift specific
*.hmap

## App packaging
*.ipa
*.dSYM.zip
*.dSYM

## Playgrounds
timeline.xctimeline
playground.xcworkspace

# Swift Package Manager
#
# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
# Packages/
# Package.pins
# Package.resolved
# *.xcodeproj
#
# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
# hence it is not needed unless you have added a package configuration file to your project
# .swiftpm

.build/

# CocoaPods
#
# We recommend against adding the Pods directory to your .gitignore. However
# you should judge for yourself, the pros and cons are mentioned at:
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
#
# Pods/
#
# Add this line if you want to avoid checking in source code from the Xcode workspace
# *.xcworkspace

# Carthage
#
# Add this line if you want to avoid checking in source code from Carthage dependencies.
# Carthage/Checkouts

Carthage/Build/

# Accio dependency management
Dependencies/
.accio/

# fastlane
#
# It is recommended to not store the screenshots in the git repo.
# Instead, use fastlane to re-generate the screenshots whenever they are needed.
# For more information about the recommended setup visit:
# https://docs.fastlane.tools/best-practices/source-control/#source-control

fastlane/report.xml
fastlane/Preview.html
fastlane/screenshots/**/*.png
fastlane/test_output

# Code Injection
#
# After new code Injection tools there's a generated folder /iOSInjectionProject
# https://github.com/johnno1962/injectionforxcode

iOSInjectionProject/
.DS_Store
.build
.swiftpm
/Packages
/*.swiftinterface
/*.xcodeproj
xcuserdata/
130 changes: 130 additions & 0 deletions .swiftlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# SwiftLint configuration file for the Storybook repository.
# Run `swiftlint --fix` at the root of the repository to format all code.

# MARK: - Settings

#included:
# - *.swift
excluded:
- "**/.build"

# If true, SwiftLint will not fail if no lintable files are found.
allow_zero_lintable_files: false

# If true, SwiftLint will treat all warnings as errors.
strict: false

# If true, SwiftLint will check for updates after linting or analyzing.
check_for_updates: true

# reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging, summary)
reporter: "xcode"

# MARK: - Rules

disabled_rules:
- class_delegate_protocol
- cyclomatic_complexity
- discouraged_direct_init
- duplicate_enum_cases
- function_parameter_count
- inclusive_language
- large_tuple
- line_length
- multiple_closures_with_trailing_closure
- nesting
- non_optional_string_data_conversion
- notification_center_detachment
- shorthand_operator
- todo
- type_body_length
- void_function_in_ternary

opt_in_rules:
- closure_end_indentation
- closure_spacing
- collection_alignment
- comma_inheritance
- contains_over_filter_count
- contains_over_filter_is_empty
- contains_over_first_not_nil
- contains_over_range_nil_comparison
- convenience_type
- discarded_notification_center_observer
- discouraged_none_name
- discouraged_object_literal
- discouraged_optional_boolean
- discouraged_optional_collection
- empty_collection_literal
- empty_count
- empty_string
- explicit_init
- fatal_error_message
- file_name_no_space
- first_where
- identical_operands
- implicit_return
- indentation_width
- joined_default_parameter
- last_where
- legacy_multiple
- literal_expression_end_indentation
- lower_acl_than_parent
- modifier_order
- multiline_arguments
- multiline_arguments_brackets
- multiline_literal_brackets
- multiline_parameters
- multiline_parameters_brackets
- number_separator
- operator_usage_whitespace
- optional_enum_case_matching
- overridden_super_call
- override_in_extension
- prefer_self_in_static_references
- prefer_self_type_over_type_of_self
- prefer_zero_over_explicit_init
- private_swiftui_state
- raw_value_for_camel_cased_codable_enum
- redundant_nil_coalescing
- return_value_from_void_function
- shorthand_optional_binding
- sorted_enum_cases
- sorted_first_last
- sorted_imports
- toggle_bool
- unhandled_throwing_task
- unneeded_parentheses_in_closure_argument
- unowned_variable_capture
- vertical_parameter_alignment_on_call
- vertical_whitespace_closing_braces
- yoda_condition

analyzer_rules:
- unused_declaration
- unused_import

# MARK: - Config

file_length:
warning: 750
error: 1500
ignore_comment_only_lines: true
force_cast:
severity: warning
force_try:
severity: warning
function_body_length:
warning: 100
error: 200
identifier_name:
min_length: 0
max_length: 60
opening_brace:
- ignore_multiline_statement_conditions
trailing_comma:
mandatory_comma: true
type_name:
min_length: 0
unused_declaration:
severity: warning
Loading
Loading