Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ra1028 committed Apr 10, 2022
0 parents commit 344799e
Show file tree
Hide file tree
Showing 178 changed files with 12,744 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: ra1028
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: checkboxes
attributes:
label: Checklist
options:
- label: This is not a bug caused by platform.
required: true
- label: Reviewed the README and documentation.
required: true
- label: Checked existing issues & PRs to ensure not duplicated.
required: true

- type: textarea
attributes:
label: What happened?
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
validations:
required: true

- type: textarea
attributes:
label: Reproduction Steps
value: |
1.
2.
3.
validations:
required: true

- type: input
attributes:
label: Swift Version
validations:
required: true

- type: input
attributes:
label: Library Version
validations:
required: true

- type: dropdown
attributes:
label: Platform
multiple: true
options:
- iOS
- tvOS
- macOS
- watchOS

- type: textarea
attributes:
label: Scrrenshot/Video/Gif
placeholder: |
Drag and drop screenshot, video, or gif here if you have.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation Request
description: Suggest a new doc/example or ask a question about an existing one
title: "[Doc Request]: "
labels: ["documentation"]
body:
- type: checkboxes
attributes:
label: Checklist
options:
- label: Reviewed the README and documentation.
required: true
- label: Confirmed that this is uncovered by existing docs or examples.
required: true
- label: Checked existing issues & PRs to ensure not duplicated.
required: true

- type: textarea
attributes:
label: Description
placeholder: Describe what the scenario you think is uncovered by the existing ones and why you think it should be covered.
validations:
required: true

- type: textarea
attributes:
label: Motivation & Context
placeholder: Feel free to describe any additional context, such as why you thought the scenario should be covered.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Suggest a new idea of feature
title: "[Feat Request]: "
labels: ["enhancement"]
body:
- type: checkboxes
attributes:
label: Checklist
options:
- label: Reviewed the README and documentation.
required: true
- label: Checked existing issues & PRs to ensure not duplicated.
required: true

- type: textarea
attributes:
label: Description
placeholder: Describe the feature that you want to propose.
validations:
required: true

- type: textarea
attributes:
label: Example Use Case
placeholder: Describe an example use case that the feature is useful.
validations:
required: true

- type: textarea
attributes:
label: Alternative Solution
placeholder: Describe alternatives solutions that you've considered.

- type: textarea
attributes:
label: Proposed Solution
placeholder: Describe how we can achieve the feature you'd like to suggest.

- type: textarea
attributes:
label: Motivation & Context
placeholder: Feel free to describe any additional context, such as why you want to suggest this feature.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Pull Request Type

- [ ] Bug fix
- [ ] New feature
- [ ] Refactoring
- [ ] Documentation update
- [ ] Chore

## Issue for this PR

Link:

## Description

## Motivation and Context

## Impact on Existing Code

## Screenshot/Video/Gif
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# https://github.com/actions/virtual-environments

name: docs

on:
release:
types: [published]
workflow_dispatch:

jobs:
test:
name: Test
runs-on: macos-12
strategy:
matrix:
xcode_version:
- 13.3
env:
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode_version }}.app
steps:
- uses: actions/checkout@v2
- name: Build docs
run: make docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
49 changes: 49 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# https://github.com/actions/virtual-environments

name: test

on:
pull_request:
push:
branches:
- main
workflow_dispatch:

jobs:
test:
name: Test
runs-on: macos-12
strategy:
matrix:
xcode_version:
- 13.3
env:
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode_version }}.app
steps:
- uses: actions/checkout@v2
- name: Show environments
run: |
swift --version
xcodebuild -version
- name: Test library
run: make test-library
- name: Test examples
run: make test-examples

validation:
name: Validation
runs-on: macos-12
env:
DEVELOPER_DIR: /Applications/Xcode_13.3.app
steps:
- uses: actions/checkout@v2
- name: Validate lint
run: make lint
- name: Validate format
run: |
make format
if [ -n "$(git status --porcelain)" ]; then echo "Make sure that the code is formated by 'make format'."; exit 1; fi
- name: Validate example project
run: |
make proj
if [ -n "$(git status --porcelain)" ]; then echo "Make sure that 'Examples/App.xcodeproj' is formated by 'make proj'."; exit 1; fi
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.DS_Store
*/build/*
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
profile
*.moved-aside
DerivedData
.idea/
*.hmap
*.xccheckout
*.xcuserstate
build/
archive/
*.xcframework
.swiftpm
.build
docs
55 changes: 55 additions & 0 deletions .swift-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"version": 1,
"indentation": {
"spaces": 4
},
"fileScopedDeclarationPrivacy": {
"accessLevel": "private"
},
"indentConditionalCompilationBlocks": true,
"indentSwitchCaseLabels": false,
"lineBreakAroundMultilineExpressionChainComponents": false,
"lineBreakBeforeControlFlowKeywords": true,
"lineBreakBeforeEachArgument": true,
"lineBreakBeforeEachGenericRequirement": true,
"lineLength": 150,
"maximumBlankLines": 1,
"prioritizeKeepingFunctionOutputTogether": false,
"respectsExistingLineBreaks": true,
"rules": {
"AllPublicDeclarationsHaveDocumentation": true,
"AlwaysUseLowerCamelCase": true,
"AmbiguousTrailingClosureOverload": true,
"BeginDocumentationCommentWithOneLineSummary": true,
"DoNotUseSemicolons": true,
"DontRepeatTypeInStaticProperties": false,
"FileScopedDeclarationPrivacy": true,
"FullyIndirectEnum": true,
"GroupNumericLiterals": true,
"IdentifiersMustBeASCII": true,
"NeverForceUnwrap": false,
"NeverUseForceTry": true,
"NeverUseImplicitlyUnwrappedOptionals": false,
"NoAccessLevelOnExtensionDeclaration": false,
"NoBlockComments": true,
"NoCasesWithOnlyFallthrough": true,
"NoEmptyTrailingClosureParentheses": true,
"NoLabelsInCasePatterns": true,
"NoLeadingUnderscores": false,
"NoParensAroundConditions": true,
"NoVoidReturnOnFunctionSignature": true,
"OneCasePerLine": true,
"OneVariableDeclarationPerLine": true,
"OnlyOneTrailingClosureArgument": false,
"OrderedImports": true,
"ReturnVoidInsteadOfEmptyTuple": true,
"UseEarlyExits": false,
"UseLetInEveryBoundCaseVariable": true,
"UseShorthandTypeNames": true,
"UseSingleLinePropertyGetter": true,
"UseSynthesizedInitializer": true,
"UseTripleSlashForDocumentationComments": true,
"UseWhereClausesInForLoops": false,
"ValidateDocumentationComments": true
}
}
Loading

0 comments on commit 344799e

Please sign in to comment.