Skip to content

Commit ad69f81

Browse files
ABridouxABridoux
authored
Merge pull request #182 from ABridoux/release/3.0.0
Release 3.0.0
2 parents b325a6a + 0b469cf commit ad69f81

File tree

131 files changed

+6100
-2293
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+6100
-2293
lines changed

‎.github/ISSUE_TEMPLATE.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:warning:
2+
3+
New issue checklist:
4+
5+
- [ ] Issue tracker does not already contain the same (or a very similar) issue
6+
- [ ] Title must be clear about what is the issue
7+
- [ ] All relevant fields of the description are filled
8+
- [ ] Issue is following the [CODE OF CONDUCT](https://github.com/ABridoux/scout/blob/master/CODE_OF_CONDUCT.md)
9+
10+
**Please delete this section once you're ready to finally create the issue.**
11+
12+
:warning:
13+
14+
# Short description
15+
16+
_Please fill this section with a short description of your issue / new feature._
17+
18+
---
19+
20+
**If the ticket is about an issue, use the following sections to give more details about the issue you're facing.**
21+
22+
### Expected outcome
23+
24+
_Please fill this section with a description of what you're expecting to happen._
25+
26+
### Actual outcome
27+
28+
_Please fill the following section with a description of what is actually happening. Please add as much information as you can (how easy it is to reproduce, steps, etc.)._
29+
30+
---
31+
32+
**If the ticket is about a new feature, use the following sections to give more details about the changes you ask for / want to implement.**
33+
34+
### Missing functionnality
35+
36+
_Please fill this section with a description of what's missing for you._
37+
38+
### Implementation
39+
40+
_Please fill this section with details of the implementation you expect or plan to do._
41+
42+
## Miscellaneous
43+
44+
| Information | Value |
45+
| ---------------- | ---------------- |
46+
| Scout version | e.g. 1.0.0 |
47+
| Platform | e.g. macOS/linux |
48+
| Platform version | e.g. 9.0 |

‎.github/ISSUE_TEMPLATE/bug_report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Report a bug with details
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Current behavior**
20+
What actually happened
21+
22+
**Screenshots**
23+
If applicable, add screenshots to help explain your problem.
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. *I'm always frustrated when [...]*
12+
13+
**Describe your idea briefly.**
14+
A general idea of the new feature the program/library could offer.
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what you want to happen. Don't hesitate to give examples of possible usage.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Summary
2+
3+
*Please fill this section with information related to the changes / fixes you introduced.*
4+
5+
## Miscellaneous
6+
7+
*Please fill this section with anything else that can be relevant to the review of your pull request (benchmarks, blogs, StackOverflow threads, etc.).*

‎.swiftpm/xcode/xcshareddata/xcschemes/Scout-Package.xcscheme

+34
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,20 @@
4848
ReferencedContainer = "container:">
4949
</BuildableReference>
5050
</BuildActionEntry>
51+
<BuildActionEntry
52+
buildForTesting = "YES"
53+
buildForRunning = "YES"
54+
buildForProfiling = "YES"
55+
buildForArchiving = "YES"
56+
buildForAnalyzing = "YES">
57+
<BuildableReference
58+
BuildableIdentifier = "primary"
59+
BlueprintIdentifier = "ScoutCLTCore"
60+
BuildableName = "ScoutCLTCore"
61+
BlueprintName = "ScoutCLTCore"
62+
ReferencedContainer = "container:">
63+
</BuildableReference>
64+
</BuildActionEntry>
5165
</BuildActionEntries>
5266
</BuildAction>
5367
<TestAction
@@ -66,6 +80,26 @@
6680
ReferencedContainer = "container:">
6781
</BuildableReference>
6882
</TestableReference>
83+
<TestableReference
84+
skipped = "NO">
85+
<BuildableReference
86+
BuildableIdentifier = "primary"
87+
BlueprintIdentifier = "ScoutCLTTests"
88+
BuildableName = "ScoutCLTTests"
89+
BlueprintName = "ScoutCLTTests"
90+
ReferencedContainer = "container:">
91+
</BuildableReference>
92+
</TestableReference>
93+
<TestableReference
94+
skipped = "NO">
95+
<BuildableReference
96+
BuildableIdentifier = "primary"
97+
BlueprintIdentifier = "ScoutCLTCoreTests"
98+
BuildableName = "ScoutCLTCoreTests"
99+
BlueprintName = "ScoutCLTCoreTests"
100+
ReferencedContainer = "container:">
101+
</BuildableReference>
102+
</TestableReference>
69103
</Testables>
70104
</TestAction>
71105
<LaunchAction

‎.swiftpm/xcode/xcshareddata/xcschemes/ScoutCLT.xcscheme

+24
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@
3434
ReferencedContainer = "container:">
3535
</BuildableReference>
3636
</BuildActionEntry>
37+
<BuildActionEntry
38+
buildForTesting = "YES"
39+
buildForRunning = "YES"
40+
buildForProfiling = "YES"
41+
buildForArchiving = "YES"
42+
buildForAnalyzing = "YES">
43+
<BuildableReference
44+
BuildableIdentifier = "primary"
45+
BlueprintIdentifier = "ScoutCLTCore"
46+
BuildableName = "ScoutCLTCore"
47+
BlueprintName = "ScoutCLTCore"
48+
ReferencedContainer = "container:">
49+
</BuildableReference>
50+
</BuildActionEntry>
3751
</BuildActionEntries>
3852
</BuildAction>
3953
<TestAction
@@ -52,6 +66,16 @@
5266
ReferencedContainer = "container:">
5367
</BuildableReference>
5468
</TestableReference>
69+
<TestableReference
70+
skipped = "NO">
71+
<BuildableReference
72+
BuildableIdentifier = "primary"
73+
BlueprintIdentifier = "ScoutCLTCoreTests"
74+
BuildableName = "ScoutCLTCoreTests"
75+
BlueprintName = "ScoutCLTCoreTests"
76+
ReferencedContainer = "container:">
77+
</BuildableReference>
78+
</TestableReference>
5579
</Testables>
5680
</TestAction>
5781
<LaunchAction

‎CHANGELOG.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
All notable changes to this project will be documented in this file. `Scout` adheres to [Semantic Versioning](http://semver.org).
44

55
---
6+
## [3.0.0](https://github.com/ABridoux/scout/tree/3.0.0) (21/02/2021)
7+
8+
### Added
9+
- YAML support [#132] [#142]
10+
- Conversion from one format to another [#133]
11+
- Disabled colorisation when the output is piped [#140]
12+
- List paths in the data [#151] [#154]
13+
- Array subscript with a negative index [#152]
14+
- Made `Path` implement several `Collection` protocols [#171]
15+
16+
### Changed
17+
- `set` functions adding a value to an array with the index `-1` removed. [#152]
18+
- Array slicing index targets a different range (shifted to the right) [#158]
19+
- `PathExplorer` requirements and default implementations changed [#163]
20+
- Optimized Jaro-Winkler match and removed the public access
21+
622
## [2.0.0](https://github.com/ABridoux/scout/tree/2.0.0) (05/09/2020)
723

824
### Added
@@ -12,7 +28,7 @@ All notable changes to this project will be documented in this file. `Scout` adh
1228
- Delete empty dictionaries and arrays when left empty [#109]
1329
- Dictionary filtering [#112]
1430
- CSV export [#103]
15-
- Commands.md new examples [#117]
31+
- *Commands.md* new examples [#117]
1632
- CLT scout command help license [#117]
1733
- Get a dictionary keys [#121]
1834
- CLT *read* command new `--output` option to export the read data or the CSV export into a file.

‎CODE_OF_CONDUCT.md

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement.
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Pull requests coming from branches which are not matching any of those pattern w
6666

6767
## Commits ##
6868

69-
Before commiting anything to you branch, make sure to add relevant message and description to your commit.
69+
Before committing anything to your branch, make sure to add a relevant message and description to your commit.
7070

7171
If you need to some insights on how to actually do this, here's some very interesting readings:
7272

@@ -75,20 +75,22 @@ If you need to some insights on how to actually do this, here's some very intere
7575

7676
## Unit testing ##
7777

78-
Rather than using TDD, you are encouraged to provide code that testes the API entry points, or critical parts. You can find some inspirations in this [article](https://www.swiftbysundell.com/articles/pragmatic-unit-testing-in-swift/).
78+
Rather than using TDD, you are encouraged to provide code that tests the API entry points, or critical parts. You can find some inspirations in this [article](https://www.swiftbysundell.com/articles/pragmatic-unit-testing-in-swift/).
7979

8080
Testing errors is heavily recommended to make sure the correct error is thrown when the program is misused.
8181

8282
## Linting ##
8383

8484
Currently, Scout uses `SwiftLint` before each push to enforce a general quality of the code.
85+
8586
## Issue checklist ##
8687

8788
- [ ] Issue tracker does not already contain the same (or a very similar) issue
8889
- [ ] Title must be clear about what is the issue
90+
8991
## Pull request checklist ##
9092

9193
- [ ] Title must be clear about what will change
9294
- [ ] Description must contain a comprehensive explanation of what changed and links toward related issues
9395
- [ ] Unit tests must put in place
94-
- [ ] New objects must be fully documented inline
96+
- [ ] New objects must be fully documented inline

0 commit comments

Comments
 (0)