https://github.com/miquido/mq-ios

Swift code essentials for better quality codebases. The project was made by Miquido: https://www.miquido.com/
https://github.com/miquido/mq-ios

ios ipados macos swift tvos watchos

Last synced: about 2 months ago
JSON representation

Swift code essentials for better quality codebases. The project was made by Miquido: https://www.miquido.com/

• Host: GitHub
• URL: https://github.com/miquido/mq-ios
• Owner: miquido
• License: apache-2.0
• Created: 2021-11-16T09:10:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-28T15:06:45.000Z (over 1 year ago)
• Last Synced: 2023-07-28T16:25:14.292Z (over 1 year ago)
• Topics: ios, ipados, macos, swift, tvos, watchos
• Language: Swift
• Homepage:
• Size: 153 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MQ

[![Platforms](https://img.shields.io/badge/platform-iOS%20|%20iPadOS%20|%20macOS-gray.svg?style=flat)]()

[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![SwiftVersion](https://img.shields.io/badge/Swift-5.7-brightgreen.svg)]()

## MQ is:

- a Swift package providing extensions for the language

- a foundation for writing code in a certain style

## MQ is not:

- a place to put commonly used fragments of code

- a place to implement domain or platform specific solutions

MQ package has no dependencies besides Swift itself and its standard library. However it can conditionally provide extensions and functionalities on platforms where some platform specific (iOS/macOS etc.) libraries are available.

Preferred code style is described as a part of this repository.

## What is inside?

MQ is a library providing Swift language extensions. It includes:

- `SourceCodeLocation`, `SourceCodeMeta`, `SourceCodeContext` - tools for gathering metadata from the source code.

- `TheError` - base interface for errors and error handling with a bunch of common error implementations.

- `CriticalSection` - easy to use data synchronization.

- `DisplayableString`, `LocalizationKey` - helpers for localization and displaying data.

- `void`, `always`, `noop` - placeholders for various of contexts.

- `runtimeAssert`, `runtimeAssertionFailure` - replacement for Swift assertions that can be manually controlled i.e. to allow unit test coverage for paths using assertions.

## License

Copyright 2021-2023 Miquido

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.