Add CHANGELOG + swiftlint + gitignore

This commit is contained in:
Loïc GRIFFIE 2019-02-22 13:57:21 +01:00
parent f19c3f3107
commit b733925423
5 changed files with 166 additions and 5 deletions

132
.gitignore vendored Normal file
View File

@ -0,0 +1,132 @@
# Created by https://www.gitignore.io/api/xcode,macos
### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride
# Icon must end with two \r
Icon
# Thumbnails
._*
# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
### Xcode ###
# Xcode
#
# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
## Build generated
build/
DerivedData/
## Various settings
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata/
## Other
*.moved-aside
*.xccheckout
*.xcscmblueprint
## Obj-C/Swift specific
*.hmap
*.ipa
*.dSYM.zip
*.dSYM
## Playgrounds
timeline.xctimeline
# 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
.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
# 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/
### Xcode Patch ###
*.xcodeproj/*
!*.xcodeproj/project.pbxproj
!*.xcodeproj/xcshareddata/
!*.xcworkspace/contents.xcworkspacedata
/*.gcno
**/xcshareddata/WorkspaceSettings.xcsettings
# End of https://www.gitignore.io/api/xcode,macos
### CocoaPods ###
## CocoaPods GitIgnore Template
# CocoaPods - Only use to conserve bandwidth / Save time on Pushing
# - Also handy if you have a large number of dependant pods
# - AS PER https://guides.cocoapods.org/using/using-cocoapods.html NEVER IGNORE THE LOCK FILE
Pods/
# End of https://www.gitignore.io/api/cocoapods

1
.swift-version Normal file
View File

@ -0,0 +1 @@
4.2

29
.swiftlint.yml Normal file
View File

@ -0,0 +1,29 @@
excluded: # paths to ignore during linting. Takes precedence over `included`.
- Carthage
- Pods
- devprojects
- vendor
- MUBackYard.playground
opt_in_rules:
- unneeded_parentheses_in_closure_argument
- switch_case_on_newline
- strict_fileprivate
- force_unwrapping
- implicitly_unwrapped_optional
- redundant_nil_coalescing
- overridden_super_call
- prohibited_super_call
- private_outlet
- operator_usage_whitespace
- no_extension_access_modifier
- nimble_operator
- multiline_parameters
- let_var_whitespace
- empty_count
- closure_spacing
- closure_end_indentation
- attributes
identifier_name:
min_length: 1 # only warning

0
CHANGELOG.md Normal file
View File

View File

@ -1,20 +1,19 @@
# MuKit
![Swift](https://img.shields.io/badge/swift-4.2-green.svg) ![Cocoapods](https://img.shields.io/cocoapods/v/HubKit.svg) ![Cocoapods](https://img.shields.io/cocoapods/l/HubKit.svg) ![Cocoapods platforms](https://img.shields.io/cocoapods/p/HubKit.svg)
MuKit is a user interface components library written in Swift.
As we always use the same or a really close object, with a one time definition with UIAppearence, we made severals components that we want to share with you.
# MuCore
## MuCore
Everything shared by all the components, as the MUNibView or other stuff.
# MuComponent
## MuComponent
All the components, and more soon.
## MUButton
### MUButton
An easy button to customize and use.