Skip to content

Commit 452be54

Browse files
Merge pull request #9 from SomeRandomiOSDev/CodacyFixes
Fixed up Codacy issues
2 parents 4043fda + 0ae0d29 commit 452be54

34 files changed

+125
-134
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,16 @@ community include:
2020
* Demonstrating empathy and kindness toward other people
2121
* Being respectful of differing opinions, viewpoints, and experiences
2222
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the overall
26-
community
23+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
24+
* Focusing on what is best not just for us as individuals, but for the overall community
2725

2826
Examples of unacceptable behavior include:
2927

30-
* The use of sexualized language or imagery, and sexual attention or advances of
31-
any kind
28+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
3229
* Trolling, insulting or derogatory comments, and personal or political attacks
3330
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email address,
35-
without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
31+
* Publishing others' private information, such as a physical or email address, without their explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a professional setting
3833

3934
## Enforcement Responsibilities
4035

@@ -114,19 +109,12 @@ community.
114109

115110
## Attribution
116111

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.1, available at
119-
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
112+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
113+
version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
120114

121115
Community Impact Guidelines were inspired by
122-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
116+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
123117

124118
For answers to common questions about this code of conduct, see the FAQ at
125-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126-
[https://www.contributor-covenant.org/translations][translations].
127-
128-
[homepage]: https://www.contributor-covenant.org
129-
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130-
[Mozilla CoC]: https://github.com/mozilla/diversity
131-
[FAQ]: https://www.contributor-covenant.org/faq
132-
[translations]: https://www.contributor-covenant.org/translations
119+
https://www.contributor-covenant.org/faq. Translations are available at
120+
https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ There are three main ways in which you contribute:
88

99
1. Open a [Bug Report](https://github.com/SomeRandomiOSDev/ProjectTemplate/issues/new?assignees=SomeRandomiOSDev&labels=bug&template=BUG_REPORT.yml&title=%5BBUG%5D%3A+).
1010
2. Open a [Feature Request](https://github.com/SomeRandomiOSDev/ProjectTemplate/issues/new?assignees=SomeRandomiOSDev&labels=enhancement&template=FEATURE_REQUEST.yml&title=%5BFEATURE%5D%3A+).
11-
3. Create a [Pull Request](https://github.com/SomeRandomiOSDev/ProjectTemplate/compare/main...main?expand=1&template=PULL_REQUEST_TEMPLATE.md).
11+
3. Create a [Pull Request](https://github.com/SomeRandomiOSDev/ProjectTemplate/compare).
1212

1313
> If none of these really suit your needs, you could also open a [blank issue](https://github.com/SomeRandomiOSDev/ProjectTemplate/issues/new).
1414
1515
If you need further guidance or have additional questions, you can always reach out at
1616

17-
17+
1818

1919
Please also note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project.
2020

@@ -26,10 +26,10 @@ For contributing via *Bug Reports* or *Feature Requests* contribuing is as simpl
2626
2727
For contributing via *Pull Requests*, we ask the following of you prior to opening a `pull request` to help maintain code standards and quality:
2828

29-
- Please try and follow the implicit code conventions and naming schemes present within the project.
30-
- For variables specific to projects configured with this template, please follow the template naming scheme used throughout this project (e.g. <#TemplateProject#>).
29+
* Please try and follow the implicit code conventions and naming schemes present within the project.
30+
* For variables specific to projects configured with this template, please follow the template naming scheme used throughout this project (e.g. <#TemplateProject#>).
3131

32-
For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md) document.
32+
For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) document.
3333

3434
## Code of Conduct
3535

.github/CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributors
22

3-
## Special thanks for all the people who have contributed this project so far:
3+
## Special thanks for all the people who have contributed this project so far
44

55
I would like to give a special thanks to all of the people below who have contributed to this project and to all of those who will contribute to it moving forward.
66

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ A brief description of your `pull request`.
1212

1313
Ensure that your `pull request` has followed all the steps below:
1414

15-
- [ ] Added new unit tests, if applicable.
16-
- [ ] Extended the documentation (including README), if applicable.
17-
- [ ] Ran [unittests.sh](../../scripts/unittests.sh) and passed.
18-
- [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
15+
* [ ] Added new unit tests, if applicable.
16+
* [ ] Extended the documentation (including README), if applicable.
17+
* [ ] Ran [unittests.sh](../../scripts/unittests.sh) and passed.
18+
* [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
1919

2020
## Proposed changes
2121

.github/workflows/unittests.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ on:
88
- '**'
99
paths-ignore:
1010
- '.gitignore'
11-
- 'github'
11+
- '.remarkrc'
12+
- 'codecov.yml'
1213
- 'LICENSE'
1314
- 'README.md'
14-
- '<#TemplateREADME#>.md'
15+
- 'Replacements/**'
1516

1617
jobs:
1718
test:

.remarkrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"plugins": [
3+
"remark-preset-lint-recommended",
4+
["remark-lint-list-item-indent", "space"],
5+
["remark-lint-no-undefined-references", {"allow": [" ", "x", "X"]}],
6+
["remark-lint-no-file-name-irregular-characters", "\\.a-zA-Z0-9-_<#>"],
7+
["remark-lint-no-heading-punctuation", ".,;:"]
8+
]
9+
}

<#TemplateProject#>.xcodeproj/project.pbxproj

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,16 +107,16 @@
107107
DD48BCA1270E0FE200D842BC /* <#TemplateProject#> tvOS Tests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = "<#TemplateProject#> tvOS Tests.xctestplan"; sourceTree = "<group>"; };
108108
DD48BCA2270E101D00D842BC /* <#TemplateProject#> watchOS Tests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = "<#TemplateProject#> watchOS Tests.xctestplan"; sourceTree = "<group>"; };
109109
DD3BB7202731ADDA00DB55F8 /* <#TemplateProject#>.docc */ = {isa = PBXFileReference; lastKnownFileType = folder.documentationcatalog; path = <#TemplateProject#>.docc; sourceTree = "<group>"; };
110+
DD438A462742D18A00F0A1F6 /* Plists */ = {isa = PBXFileReference; lastKnownFileType = folder; name = Plists; sourceTree = "<group>"; };
110111
DDA42148273E153D00F2B0BC /* github */ = {isa = PBXFileReference; lastKnownFileType = folder; name = github; path = .github; sourceTree = "<group>"; };
111112
DD17A9F9257744BC00D30599 /* scripts */ = {isa = PBXFileReference; lastKnownFileType = folder; path = scripts; sourceTree = "<group>"; };
112-
DD86D5E023D22DB90046E63E /* <#TemplateProject#>.podspec */ = {isa = PBXFileReference; explicitFileType = text.script.ruby; path = <#TemplateProject#>.podspec; sourceTree = SOURCE_ROOT; };
113-
DD86D5DF23D22DB90046E63E /* Package.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Package.swift; sourceTree = SOURCE_ROOT; };
113+
DD86D5E023D22DB90046E63E /* <#TemplateProject#>.podspec */ = {isa = PBXFileReference; explicitFileType = text.script.ruby; path = <#TemplateProject#>.podspec; sourceTree = "<group>"; };
114+
DD86D5DF23D22DB90046E63E /* Package.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Package.swift; sourceTree = "<group>"; };
114115
DDB1DE5C2405EEE300C20FED /* codecov.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = codecov.yml; sourceTree = "<group>"; };
115-
DD86D5E323D22DC30046E63E /* .swiftlint.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = .swiftlint.yml; sourceTree = SOURCE_ROOT; };
116-
DD86D5E123D22DB90046E63E /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = SOURCE_ROOT; };
117-
DD86D5DE23D22DB90046E63E /* LICENSE */ = {isa = PBXFileReference; lastKnownFileType = text; path = LICENSE; sourceTree = SOURCE_ROOT; };
118-
DD86D54123D11B3E0046E63E /* <#TemplateProject#>-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = "<#TemplateProject#>-Info.plist"; path = "Plists/<#TemplateProject#>-Info.plist"; sourceTree = "<group>"; };
119-
DD5D044A261FA56400BA0FC2 /* <#TemplateProject#>Tests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = "<#TemplateProject#>Tests-Info.plist"; path = "Plists/<#TemplateProject#>Tests-Info.plist"; sourceTree = "<group>"; };
116+
DD438A452742CFD900F0A1F6 /* .remarkrc */ = {isa = PBXFileReference; explicitFileType = text.json; path = .remarkrc; sourceTree = "<group>"; };
117+
DD86D5E323D22DC30046E63E /* .swiftlint.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = .swiftlint.yml; sourceTree = "<group>"; };
118+
DD86D5E123D22DB90046E63E /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
119+
DD86D5DE23D22DB90046E63E /* LICENSE */ = {isa = PBXFileReference; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
120120
DD86D53D23D11B3E0046E63E /* <#TemplateProject#>.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = <#TemplateProject#>.framework; sourceTree = BUILT_PRODUCTS_DIR; };
121121
DD86D54623D11B3E0046E63E /* <#TemplateProject#>Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = <#TemplateProject#>Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
122122
DD86D57023D11C860046E63E /* <#TemplateProject#>.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = <#TemplateProject#>.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -263,16 +263,16 @@
263263
DD86D55B23D11BA80046E63E /* Supporting Files */ = {
264264
isa = PBXGroup;
265265
children = (
266+
DD438A462742D18A00F0A1F6 /* Plists */,
266267
DDA42148273E153D00F2B0BC /* github */,
267268
DD17A9F9257744BC00D30599 /* scripts */,
268269
DD86D5E023D22DB90046E63E /* <#TemplateProject#>.podspec */,
269270
DD86D5DF23D22DB90046E63E /* Package.swift */,
270271
DDB1DE5C2405EEE300C20FED /* codecov.yml */,
272+
DD438A452742CFD900F0A1F6 /* .remarkrc */,
271273
DD86D5E323D22DC30046E63E /* .swiftlint.yml */,
272274
DD86D5E123D22DB90046E63E /* README.md */,
273275
DD86D5DE23D22DB90046E63E /* LICENSE */,
274-
DD86D54123D11B3E0046E63E /* <#TemplateProject#>-Info.plist */,
275-
DD5D044A261FA56400BA0FC2 /* <#TemplateProject#>Tests-Info.plist */,
276276
);
277277
name = "Supporting Files";
278278
sourceTree = "<group>";

github/CODE_OF_CONDUCT.md renamed to Replacements/.github/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,16 @@ community include:
2020
* Demonstrating empathy and kindness toward other people
2121
* Being respectful of differing opinions, viewpoints, and experiences
2222
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the overall
26-
community
23+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
24+
* Focusing on what is best not just for us as individuals, but for the overall community
2725

2826
Examples of unacceptable behavior include:
2927

30-
* The use of sexualized language or imagery, and sexual attention or advances of
31-
any kind
28+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
3229
* Trolling, insulting or derogatory comments, and personal or political attacks
3330
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email address,
35-
without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
31+
* Publishing others' private information, such as a physical or email address, without their explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a professional setting
3833

3934
## Enforcement Responsibilities
4035

@@ -114,19 +109,12 @@ community.
114109

115110
## Attribution
116111

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.1, available at
119-
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
112+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
113+
version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
120114

121115
Community Impact Guidelines were inspired by
122-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
116+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
123117

124118
For answers to common questions about this code of conduct, see the FAQ at
125-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126-
[https://www.contributor-covenant.org/translations][translations].
127-
128-
[homepage]: https://www.contributor-covenant.org
129-
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130-
[Mozilla CoC]: https://github.com/mozilla/diversity
131-
[FAQ]: https://www.contributor-covenant.org/faq
132-
[translations]: https://www.contributor-covenant.org/translations
119+
https://www.contributor-covenant.org/faq. Translations are available at
120+
https://www.contributor-covenant.org/translations.

github/CONTRIBUTING.md renamed to Replacements/.github/CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ There are three main ways in which you contribute:
88

99
1. Open a [Bug Report](https://github.com/<#TemplateUsername#>/<#TemplateProject#>/issues/new?assignees=<#TemplateUsername#>&labels=bug&template=BUG_REPORT.yml&title=%5BBUG%5D%3A+).
1010
2. Open a [Feature Request](https://github.com/<#TemplateUsername#>/<#TemplateProject#>/issues/new?assignees=<#TemplateUsername#>&labels=enhancement&template=FEATURE_REQUEST.yml&title=%5BFEATURE%5D%3A+).
11-
3. Create a [Pull Request](https://github.com/<#TemplateUsername#>/<#TemplateProject#>/compare/main...main?expand=1&template=PULL_REQUEST_TEMPLATE.md).
11+
3. Create a [Pull Request](https://github.com/<#TemplateUsername#>/<#TemplateProject#>/compare).
1212

1313
> If none of these really suit your needs, you could also open a [blank issue](https://github.com/<#TemplateUsername#>/<#TemplateProject#>/issues/new).
1414
1515
If you need further guidance or have additional questions, you can always reach out at
1616

17-
- <#templateemail#>
17+
* <#templateemail#>
1818

1919
Please also note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project.
2020

@@ -26,16 +26,16 @@ For contributing via *Bug Reports* or *Feature Requests* contribuing is as simpl
2626
2727
For contributing via *Pull Requests*, we ask the following of you prior to opening a `pull request` to help maintain code standards and quality (many of these are enforced with workflows, but who wants to push subsequent commits for a single PR?):
2828

29-
- Please try and follow the implicit code conventions and naming schemes present within the project.
30-
- All Swift files for this project lint successfully. The latest version of SwiftLint should be used for linting.
31-
- The builds for all platforms should succeed, along with all of the unit tests for each platform.
32-
- Any new code added should be accompanied by appropriate unit test code to cover (virtually) all cases and paths through that code. The code coverage for this project shouldn't decrease by a significant amount, but increases in code coverage are always welcome and appreciated.
33-
- Any new public APIs added should be accompanied by documentation in code, and as appropriate, in the [README](../README.md) file and in the Documentation Catalog.
34-
- Since this project is available via [CocoaPods](https://cocoapods.org), it should lint successfully for both `pod lib lint` and `pod lib lint --use-libraries` using the latest version of the `pod` utility.
29+
* Please try and follow the implicit code conventions and naming schemes present within the project.
30+
* All Swift files for this project lint successfully. The latest version of SwiftLint should be used for linting.
31+
* The builds for all platforms should succeed, along with all of the unit tests for each platform.
32+
* Any new code added should be accompanied by appropriate unit test code to cover (virtually) all cases and paths through that code. The code coverage for this project shouldn't decrease by a significant amount, but increases in code coverage are always welcome and appreciated.
33+
* Any new public APIs added should be accompanied by documentation in code, and as appropriate, in the [README](../README.md) file and in the Documentation Catalog.
34+
* Since this project is available via [CocoaPods](https://cocoapods.org), it should lint successfully for both `pod lib lint` and `pod lib lint --use-libraries` using the latest version of the `pod` utility.
3535

3636
> Tip: It's strongly recommended to use the [workflowtests.sh](../scripts/workflowtests.sh) script for testing all of the various builds & linting as this script is a mirror of the workflows that are ran for `pull requests`.
3737
38-
For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md) document.
38+
For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) document.
3939

4040
## Code of Conduct
4141

github/CONTRIBUTORS.md renamed to Replacements/.github/CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributors
22

3-
## Special thanks for all the people who have contributed this project so far:
3+
## Special thanks for all the people who have contributed this project so far
44

55
I would like to give a special thanks to all of the people below who have contributed to this project and to all of those who will contribute to it moving forward.
66

github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md renamed to Replacements/.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ A brief description of your `pull request`.
1212

1313
Ensure that your `pull request` has followed all the steps below:
1414

15-
- [ ] Code compilation.
16-
- [ ] All tests passing.
17-
- [ ] No new SwiftLint issues.
18-
- [ ] Added new unit tests, if applicable.
19-
- [ ] Extended the documentation (including README), if applicable.
20-
- [ ] Updated version in <#TemplateProject#>.podspec following [semver](https://semver.org) guidelines.
21-
- [ ] Ran [workflowtests.sh](../../scripts/workflowtests.sh) and passed.
22-
- [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
15+
* [ ] Code compilation.
16+
* [ ] All tests passing.
17+
* [ ] No new SwiftLint issues.
18+
* [ ] Added new unit tests, if applicable.
19+
* [ ] Extended the documentation (including README), if applicable.
20+
* [ ] Updated version in <#TemplateProject#>.podspec following [semver](https://semver.org) guidelines.
21+
* [ ] Ran [workflowtests.sh](../../scripts/workflowtests.sh) and passed.
22+
* [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
2323

2424
## Proposed changes
2525

github/workflows/carthage.yml renamed to Replacements/.github/workflows/carthage.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ on:
1010
- '.github/**' # Ignore all files under '.github'
1111
- '!.github/workflows/carthage.yml' # Except for this workflow
1212
- '.gitignore'
13+
- '.remarkrc'
1314
- 'codecov.yml'
1415
- 'Documentation/**'
1516
- 'LICENSE'

github/workflows/cocoapods.yml renamed to Replacements/.github/workflows/cocoapods.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ on:
1010
- '.github/**' # Ignore all files under '.github'
1111
- '!.github/workflows/cocoapods.yml' # Except for this workflow
1212
- '.gitignore'
13+
- '.remarkrc'
1314
- '.swiftlint.yml'
1415
- 'codecov.yml'
1516
- 'Documentation/**'

0 commit comments

Comments
 (0)