Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔖 release v8.0.1 #625

Merged
merged 166 commits into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
166 commits
Select commit Hold shift + click to select a range
f25fbe4
Fix Header Option Casting (#260)
yousinix May 25, 2021
3d47735
Fix for #259 (#263)
JEuler May 31, 2021
8be965b
4.0.1 fixes (#264)
JEuler Jun 1, 2021
bcb0304
analyzer dependency upgraded (#296)
luis901101 Sep 18, 2021
4e4607e
fix(generator): fix PartValueFile value not nullable if arg is (#288)…
rIIh Sep 18, 2021
939a83f
Chopper generator release 4.0.2 (#297)
JEuler Sep 23, 2021
ff0ec87
fix: fix this.body cast of null value when response body is null (#29…
rIIh Sep 23, 2021
ffcd945
Interpolation fixes (#275)
JEuler Sep 23, 2021
82b951f
encodeQueryComponent now encodeComponent (#278)
JEuler Sep 23, 2021
f7255b7
Prevent double call on token refreshment (#276)
JEuler Oct 10, 2021
ddefa94
Fixes for #309 #308 (#310)
JEuler Dec 7, 2021
0386c74
Remove new keyword from interceptors.md (#312)
michalsrutek Jan 3, 2022
d4dab0d
Analyzer upgrade (#320)
JEuler Jan 16, 2022
bbe2c7a
Add unnecessary_brace_in_string_interps to lint ignores (#317)
pingbird Jan 16, 2022
6bdbd63
Extend pragma to quiet the linter (#318)
vipw Jan 22, 2022
4185d14
Fix converter getting called twice if using an authenticator with a J…
maxroehrl Jan 30, 2022
dbf4272
migrate example to nullsafety (#331)
ipcjs Feb 22, 2022
976d457
Resolve problem in main_json_serializable example (#328)
ibadin Apr 24, 2022
cc2da20
Add @FiledMap @PartMap @PartFileMap (#335)
meysam1717 May 1, 2022
659b9f8
Upgrade of analyzer (#340)
JEuler Jun 20, 2022
e167ba6
Fix nullable QueryMap fails to compile (#344)
techouse Jul 14, 2022
f9009ce
Change return type of decodeJson to FutureOr in order to be able to s…
techouse Sep 7, 2022
5f2eb82
Migrate from pedantic to lints ^2.0.0 with lints/recommended.yaml (#349)
techouse Sep 7, 2022
02cf2e0
Version bumped for release (#352)
JEuler Sep 13, 2022
34b3bda
Revert analyzer to ^4.1.0 and silence linters for Element.enclosingEl…
techouse Sep 13, 2022
426a16e
[chopper_generator] Update analyzer to ^4.4.0 and code_builde to ^4.3…
techouse Sep 17, 2022
35fdf8f
Add Makefiles to streamline development (#357)
techouse Sep 17, 2022
5a59ebf
Add Bug Report Github issue template (#359)
techouse Sep 18, 2022
fcf3478
[chopper_generator] Add types to the generated variables (#360)
techouse Sep 19, 2022
6b3b840
Provide an example using an Isolate Worker Pool with Squadron (#361)
techouse Sep 19, 2022
d74790c
mapToQuery changes (#364)
techouse Oct 8, 2022
0882a7e
Version bumped / changelog update (#367)
JEuler Oct 8, 2022
e3fd623
Request extends http.BaseRequest (#370)
techouse Oct 13, 2022
bd8d65f
Exclude null query vars by default and add new @Method annotation inc…
techouse Oct 14, 2022
786c153
5.1.0 (dev) (#373)
JEuler Oct 15, 2022
9b2b867
[workflow] Upgrade mono_repo to v6.4.1 (#375)
techouse Oct 15, 2022
233678e
Update analyzer to >=4.4.0 <6.0.0 (#378)
techouse Oct 17, 2022
1b2f1fa
Update mono_repo to 6.4.2 (#380)
techouse Oct 18, 2022
1e3e7f4
add techouse (#382)
JEuler Oct 18, 2022
b0fd18f
[Feature] Replace the String based path with Uri (#383)
Guldem Oct 31, 2022
9d1d86c
:memo: Add Authenticator example (#386)
techouse Nov 20, 2022
2775a73
Update getting-started.md (#391)
erlangparasu Dec 11, 2022
11a9ca5
Fix #388 Triggering Authenticator double encodes body in POST, PUT, P…
techouse Dec 11, 2022
bdbe210
Add image upload test (#392)
techouse Dec 11, 2022
b6ea960
Release 5.2.0 (#394)
JEuler Dec 13, 2022
1719c83
6.0.0 (#397)
JEuler Dec 14, 2022
7453582
Configurable HttpLoggingInterceptor (#399)
Guldem Jan 6, 2023
fa73de3
Made apply headers field name case insensitive. (#400)
Guldem Jan 8, 2023
bd3d7cc
:bulb: Clean up code in comments (#403)
techouse Jan 9, 2023
a910ede
Fix dead link on FAQs page (#404)
markasselin Jan 26, 2023
adfb1c5
Updated chopper version to 6.0.0 for chopper_built_value (#406)
Guldem Feb 2, 2023
253d69a
#290 implement Equatable (#410)
techouse Feb 22, 2023
9976752
Add Feature request Github issue template (#414)
techouse Mar 13, 2023
617f3f3
:construction_worker: add CODEOWNERS (#415)
techouse Mar 29, 2023
d83ad40
:arrow_up: Bump Dart SDK constraint to ">=2.17.0 <4.0.0" (#417)
techouse May 12, 2023
83f8c25
:green_heart: Fix CI publish (#419)
techouse May 13, 2023
64bd220
:green_heart: Fix CI publish credentials (#421)
techouse May 14, 2023
09774f1
:green_heart: Fix CI coverage reporting (#423)
techouse May 14, 2023
0145064
:construction_worker: only run CI publish / --dry-run when a package'…
techouse May 15, 2023
ef2fbf5
:green_heart: fix publish CI to run only on push (#425)
techouse May 15, 2023
08781c9
:green_heart: fix publish workflow (#427)
techouse May 20, 2023
485ef8f
Adding follow redirects to toHttpRequest (#430)
Joran-Dob May 26, 2023
a88aa3a
:arrow_up: update squadron example (#432)
techouse May 27, 2023
0546452
:arrow_up: update http constraint to ">=0.13.0 <2.0.0" (#431)
techouse May 27, 2023
ae8bff5
Add MultipartRequest log to CurlInterceptor (#435)
JosephNK May 27, 2023
d824ded
:green_heart: add cleanup step to publish workflow (#434)
techouse May 28, 2023
829d5b0
:twisted_rightwards_arrows: post release branch sync (#437)
techouse May 28, 2023
455cd34
:bug: fix Multipart for List<int> and List<String> (#439)
techouse Jun 3, 2023
1f8c596
:twisted_rightwards_arrows: post release branch sync (#441)
techouse Jun 4, 2023
917a463
:sparkles: Generating files in different directories (#444)
techouse Jun 19, 2023
ac90783
:twisted_rightwards_arrows: post release branch sync (#447)
techouse Jun 19, 2023
97959f0
:recycle: refactor chopper_generator (#448)
techouse Jul 4, 2023
0856b86
:twisted_rightwards_arrows: post release branch sync (#450)
techouse Jul 5, 2023
96f9dbc
:heavy_minus_sign: remove dart_code_metrics from dev_dependencies (#452)
techouse Jul 9, 2023
6afebb0
:sparkles: implement Dart 3 class modifiers (#453)
techouse Jul 29, 2023
93b4e8a
:twisted_rightwards_arrows: post release branch sync (#455)
techouse Jul 30, 2023
7cd824c
:passport_control: fix CODEOWNERS (#456)
techouse Jul 30, 2023
aa63283
:recycle: refactor chopper (#460)
techouse Aug 2, 2023
a386e86
:recycle: refactor ChopperClient constructor (#461)
techouse Aug 2, 2023
7a6b5b9
:arrow_up: update mono_repo (#462)
techouse Aug 2, 2023
e9fc26d
:sparkles: add final class modifier to generated Chopper API implemen…
techouse Aug 3, 2023
e07afcf
:twisted_rightwards_arrows: post release branch sync (#466)
techouse Aug 3, 2023
2f7f414
:construction_worker: add Dependabot workflow (#467)
techouse Aug 4, 2023
03f7bf7
:pencil2: fix typo in mono_repo.yaml (#468)
techouse Aug 4, 2023
8dbde76
:sparkles: HttpLoggingInterceptor: allow to pass custom logger (#470)
Maxr1998 Aug 5, 2023
2e00b6a
:construction_worker: use yq to manipulate pubspec.yaml in publish CI…
techouse Aug 7, 2023
0af17f8
:twisted_rightwards_arrows: post release branch sync (#473)
techouse Aug 7, 2023
1a01b60
:sparkles: Attach request/response to interceptor log lines (#475)
Maxr1998 Aug 10, 2023
764d57d
:twisted_rightwards_arrows: post release branch sync (#477)
techouse Aug 11, 2023
f8905ad
:adhesive_bandage: export ChopperLogRecord to library surface (#480)
Maxr1998 Aug 14, 2023
c658d39
:label: make ChopperLogRecord final (#481)
Maxr1998 Aug 14, 2023
a0d70ac
:twisted_rightwards_arrows: post release branch sync (#483)
techouse Aug 14, 2023
2ab9d87
:arrow_up: analyzer: ">=5.13.0 <7.0.0" (#484)
techouse Aug 16, 2023
08bab6c
:twisted_rightwards_arrows: post release branch sync (#486)
techouse Aug 17, 2023
4c52b09
Update README.md (#488)
hunterwilhelm Aug 19, 2023
c7b67a6
:twisted_rightwards_arrows: post release branch sync (#491)
techouse Aug 22, 2023
e706150
Adding support for top level variables (#493)
martinale14 Aug 31, 2023
31c3967
:label: add topics (#495)
techouse Sep 1, 2023
a0f106d
:bug: fix chopper base.dart send() authenticate sending wrong request…
techouse Sep 2, 2023
f85eacd
:twisted_rightwards_arrows: post release branch sync (#499)
techouse Sep 2, 2023
be71064
:rotating_light: ignore unnecessary_string_interpolations (#501)
techouse Sep 5, 2023
3ff8359
:twisted_rightwards_arrows: post release branch sync (#503)
techouse Sep 8, 2023
14bc48f
:rotating_light: correct static analysis suppression of *.chopper.dar…
techouse Oct 7, 2023
b48066d
:bug: remove charset from http request headers when the body is in by…
techouse Oct 7, 2023
cbb4a92
:construction_worker: update mono_repo (#509)
techouse Oct 7, 2023
ce0836d
:construction_worker: create Github release when publishing package (…
techouse Oct 7, 2023
fedb899
:twisted_rightwards_arrows: post release branch sync (#514)
techouse Oct 7, 2023
52133f6
:sparkles: encode DateTime as ISO8601 (#516)
techouse Oct 11, 2023
24179ab
:twisted_rightwards_arrows: post release branch sync (#518)
techouse Oct 11, 2023
4860d3a
Fix incorrect url generation when using new baseurl (#520)
martinale14 Oct 12, 2023
8dd5a84
:twisted_rightwards_arrows: post release branch sync (#522)
techouse Oct 13, 2023
08ee151
:arrow_up: Bump lints from 2.1.1 to 3.0.0 in /chopper (#525)
dependabot[bot] Oct 23, 2023
723b5fc
:arrow_up: Bump lints from 2.1.1 to 3.0.0 in /chopper_built_value (#524)
dependabot[bot] Oct 23, 2023
f061355
:arrow_up: Bump lints from 2.1.1 to 3.0.0 in /chopper_generator (#523)
dependabot[bot] Oct 23, 2023
e5417d1
Add mock mixins of Chopper components. (#529)
diegotori Oct 26, 2023
e34feea
Add success/failure callback hooks to Authenticator. (#527)
diegotori Oct 26, 2023
4178d7d
:bug: fix Makefile show_test_coverage (#530)
techouse Oct 29, 2023
9d392a1
:twisted_rightwards_arrows: post release branch sync (#532)
techouse Nov 1, 2023
eb3f6c9
:lipstick: cosmetic refactor (#534)
techouse Nov 16, 2023
33cb73a
:construction_worker: update CI (#535)
techouse Nov 18, 2023
e84d077
:sparkles: call .toString() on non-String headers (#538)
techouse Dec 30, 2023
8938d98
:twisted_rightwards_arrows: post release branch sync (#542)
techouse Jan 2, 2024
4ba5a83
Helper function for fetching errors of specific type (#543)
Guldem Jan 2, 2024
6420778
:sparkles: Feature: Omit Response in service (#545)
Guldem Jan 5, 2024
2dc868f
:memo: Improved documentation + added const annotations (#548)
Guldem Jan 5, 2024
33615ed
:bug: fix chopper_generator regression introduced in #534 (#549)
techouse Jan 8, 2024
a0d5bc5
:twisted_rightwards_arrows: post release branch sync (#556)
techouse Jan 15, 2024
78fae30
:construction_worker: use Dependabot to check for workflow action upd…
techouse Jan 15, 2024
d369217
:sparkles: add option to override build_extension (#562)
techouse Jan 21, 2024
b8f2fe2
:twisted_rightwards_arrows: post release branch sync (#565)
techouse Jan 23, 2024
168982f
:rewind: revert faq.md (#566)
techouse Jan 24, 2024
be1c370
:sparkles: Added Target annotations for the annotations (#567)
Guldem Jan 25, 2024
63e6d00
:twisted_rightwards_arrows: post release branch sync (#569)
techouse Jan 28, 2024
5585ffb
:bug: Export ChopperHttpException so developer can catch it. (#570)
Guldem Jan 31, 2024
3af6e4e
:arrow_up: Bump codecov/codecov-action from 3 to 4 (#571)
dependabot[bot] Feb 5, 2024
4a1de44
Revert ":arrow_up: Bump codecov/codecov-action from 3 to 4 (#571)" (#…
techouse Feb 8, 2024
655aafa
Support @FormUrlEncoded (#579)
lwj1994 Mar 7, 2024
49943bf
:arrow_up: Bump actions/cache from 3.3.1 to 4.0.1 (#580)
dependabot[bot] Mar 7, 2024
8900256
:twisted_rightwards_arrows: post release branch sync (#582)
techouse Mar 8, 2024
8ff4ecd
:arrow_up: Bump softprops/action-gh-release from 1 to 2 (#583)
dependabot[bot] Mar 11, 2024
7c65a25
Support @Tag (#586)
lwj1994 Mar 20, 2024
fd9747a
:arrow_up: Bump actions/checkout from 3.5.2 to 4.1.2 (#587)
dependabot[bot] Mar 20, 2024
153f13e
:bug: fix Request.copyWith lose tag param (#588)
lwj1994 Mar 21, 2024
5039e49
:arrow_up: Bump actions/cache from 4.0.1 to 4.0.2 (#590)
dependabot[bot] Mar 25, 2024
dd61ec1
:twisted_rightwards_arrows: post release branch sync (#593)
techouse Apr 4, 2024
84471e4
:zap: use qs_dart for query string encoding (#592)
techouse Apr 4, 2024
46e8c99
:arrow_up: update Github actions (#594)
techouse Apr 5, 2024
1e6a8ab
:twisted_rightwards_arrows: post release branch sync (#596)
techouse Apr 5, 2024
03f6769
:arrow_up: update cli_script to 1.0.0 (was 0.3.1) (#597)
techouse Apr 5, 2024
ab5a80f
:sparkles: Restructure interceptors (#547)
Guldem Apr 5, 2024
d5a8d4a
:twisted_rightwards_arrows: post pre-release branch sync (#599)
techouse Apr 6, 2024
4fe8ccf
:white_check_mark: Added test to see if exception are passed up (#601)
Guldem Apr 6, 2024
c558b3b
:sparkles: add per-request timeout (#604)
techouse May 2, 2024
707950b
:green_heart: fix codecov (#607)
techouse May 3, 2024
f5a56b6
:twisted_rightwards_arrows: post pre-release branch sync (#608)
techouse May 3, 2024
a7293f4
:sparkles: add `onlyErrors` option to `HttpLoggingInterceptor` (#610)
techouse May 8, 2024
5e05064
:twisted_rightwards_arrows: post release branch sync (#611)
techouse May 9, 2024
186ce16
:arrow_up: update dependencies and linters (#615)
techouse May 14, 2024
bb52f38
:memo: update build_runner reference in readme (#616)
techouse May 15, 2024
117fd80
:page_facing_up: create symlink to chopper/LICENSE (#617)
techouse May 17, 2024
b2b8d65
:busts_in_silhouette: update/fix contributors (#618)
techouse May 17, 2024
3482cc6
:lock: add Security Policy (#619)
techouse May 17, 2024
627ff1d
🐛 Fix null body converter (#623)
Guldem Jun 25, 2024
7e1f0f9
:package: directly export `qs.ListFormat` instead of internal wrapper…
techouse Jun 26, 2024
bf4753e
Merge branch 'refs/heads/develop' into release/v8.0.1
techouse Jun 26, 2024
1906938
:bookmark: release v8.0.1
techouse Jun 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 39 additions & 18 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -1,44 +1,67 @@
{
"projectName": "chopper",
"projectOwner": "lejard-h",
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"contributors": [
"imageSize": 64,
"commit": false,
"contributors": [
{
{
"login": "Vovanella95",
"name": "Uladzimir_Paliukhovich",
"name": "Uladzimir Paliukhovich",
"avatar_url": "https://avatars.githubusercontent.com/u/11267533?v=4",
"profile": "https://github.com/Vovanella95",
"contributions": [
"code"
]
},
{
]
},
{
"login": "fryette",
"name": "Eugeny Sampir",
"avatar_url": "https://avatars.githubusercontent.com/u/3999503?v=4",
"profile": "http://ysampir@gmail.com",
"contributions": [
"code"
]
},
]
},
{
"login": "Guldem",
"name": "Job Guldemeester",
"avatar_url": "https://avatars.githubusercontent.com/u/11982796?v=4",
"profile": "https://github.com/Guldem",
"contributions": [
"code",
"review",
"test",
"doc"
]
},
{
"login": "JEuler",
"name": "Ivan Terekhin",
"avatar_url": "https://avatars.githubusercontent.com/u/231950?v=4",
"profile": "https://www.upwork.com/freelancers/~01192eefd8a1c267f7",
"contributions": [
"contributions": [
"code",
"review",
"test",
"doc"
]
},
{
},
{
"login": "techouse",
"name": "Klemen Tusar",
"avatar_url": "https://avatars.githubusercontent.com/u/1174328?v=4",
"profile": "https://github.com/techouse",
"contributions": [
"code",
"review",
"test",
"doc"
]
},
{
"login": "stewemetal",
"name": "István Juhos",
"avatar_url": "https://avatars.githubusercontent.com/u/5860632?v=4",
Expand All @@ -49,8 +72,8 @@
"test",
"doc"
]
},
{
},
{
"login": "lejard-h",
"name": "Hadrien Lejard",
"avatar_url": "https://avatars.githubusercontent.com/u/7336262?v=4",
Expand All @@ -63,10 +86,8 @@
]
}
],
"contributorsPerLine": 7,
"projectName": "chopper",
"projectOwner": "lejard-h",
"repoType": "github",
"contributorsPerLine": 7,
"repoHost": "https://github.com",
"skipCi": true
}
133 changes: 133 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[techouse@gmail.com](mailto:techouse@gmail.com).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
111 changes: 111 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Contributing

Thank you for your interest in contributing to this project. This project relies on the help of volunteer developers for
its development and maintenance.

Before making any changes to this repository, please first discuss the proposed changes with the repository owners
through an issue, email, or any other appropriate method of communication.

Please note that a [code of conduct](CODE-OF-CONDUCT.md) is in place and should be adhered to during all interactions
related to the project.

## Dart version support

Currently, the package supports Dart versions 3.0 and above. Once a new Dart version is released, we will aim to support
it as soon as possible. If you encounter any issues with a new Dart version, please create an issue in the repository.

## Flutter support

This package is designed to work with Flutter 3.10 and above. We prioritize and are dedicated to maintaining
compatibility with these versions for a smooth user experience.

## Testing

Given the critical nature of correctly generating HTTP requests and handling API responses in the Chopper package, and
the potential for security vulnerabilities if this is not done correctly or consistently across platforms and versions
of Dart and Flutter, thorough testing is of utmost importance. Please remember to write tests for any new code you
create, using the [test](https://pub.dev/packages/test) package for all test cases.

### Running the test suite

To run the test suite, follow these commands:

```bash
git clone https://github.com/lejard-h/chopper.git

pushd chopper
dart pub get
dart test --platform vm
dart test --platform chrome
popd

pushd chopper_generator
dart pub get
dart test --platform vm
dart test --platform chrome
popd

pushd chopper_built_value
dart pub get
dart test --platform vm
dart test --platform chrome
popd
```

### Running the test suite with coverage

```bash
pushd chopper
make show_test_coverage
popd

pushd chopper_generator
make show_test_coverage
popd

pushd chopper_built_value
make show_test_coverage
popd
```

## Submitting changes

To contribute to this project, please submit a new pull request and provide a clear list of your changes. For guidance
on creating pull requests, you can refer to this resource. When sending a pull request, we highly appreciate the
inclusion of tests, as we strive to enhance our test coverage.
Following our coding conventions is essential, and it would be ideal if you ensure that each commit focuses on a single
feature. For commits, please write clear log messages. While concise one-line messages are suitable for small changes,
more substantial modifications should follow a format similar to the example below:

```bash
git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
```

## Coding standards

Prioritizing code readability and conciseness is essential. To achieve this, we recommend using `dart format` for code
formatting. Once your work is deemed complete, it is advisable to run the following command:

```bash
pushd chopper
dart format lib test --output=none --set-exit-if-changed .
dart analyze lib test --fatal-infos
popd

pushd chopper_generator
dart format lib test --output=none --set-exit-if-changed .
dart analyze lib test --fatal-infos
popd

pushd chopper_built_value
dart format lib test --output=none --set-exit-if-changed .
dart analyze lib test --fatal-infos
popd
```

This command runs the Dart analyzer to identify any potential issues or inconsistencies in your code. By following these
guidelines, you can ensure a high-quality codebase.

Thanks!
1 change: 1 addition & 0 deletions LICENSE
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Chopper

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![pub package](https://img.shields.io/pub/v/chopper.svg)](https://pub.dartlang.org/packages/chopper)
[![Dart CI](https://github.com/lejard-h/chopper/workflows/Dart%20CI/badge.svg)](https://github.com/lejard-h/chopper/actions?query=workflow%3A%22Dart+CI%22)
Expand Down Expand Up @@ -37,12 +37,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/lejard-h"><img src="https://avatars.githubusercontent.com/u/7336262?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hadrien Lejard</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Alejard-h" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/stewemetal"><img src="https://avatars.githubusercontent.com/u/5860632?v=4?s=100" width="100px;" alt=""/><br /><sub><b>István Juhos</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Astewemetal" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/lejard-h"><img src="https://avatars.githubusercontent.com/u/7336262?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Hadrien Lejard</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Alejard-h" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/stewemetal"><img src="https://avatars.githubusercontent.com/u/5860632?v=4&s=100" width="100px;" alt=""/><br /><sub><b>István Juhos</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Astewemetal" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/techouse"><img src="https://avatars.githubusercontent.com/u/1174328?v=4" width="100px;" alt=""/><br /><sub><b>Klemen Tusar</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Atechouse" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.upwork.com/freelancers/~01192eefd8a1c267f7"><img src="https://avatars.githubusercontent.com/u/231950?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Terekhin</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AJEuler" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Documentation">📖</a></td>
<td align="center"><a href="http://ysampir@gmail.com"><img src="https://avatars.githubusercontent.com/u/3999503?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Eugeny Sampir</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=fryette" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Vovanella95"><img src="https://avatars.githubusercontent.com/u/11267533?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Uladzimir_Paliukhovich</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Vovanella95" title="Code">💻</a></td>
<td align="center"><a href="https://www.upwork.com/freelancers/~01192eefd8a1c267f7"><img src="https://avatars.githubusercontent.com/u/231950?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Ivan Terekhin</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AJEuler" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/Guldem"><img src="https://avatars.githubusercontent.com/u/11982796?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Job Guldemeester</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AGuldem" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Documentation">📖</a></td>
<td align="center"><a href="http://ysampir@gmail.com"><img src="https://avatars.githubusercontent.com/u/3999503?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Eugeny Sampir</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=fryette" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Vovanella95"><img src="https://avatars.githubusercontent.com/u/11267533?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Uladzimir Paliukhovich</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Vovanella95" title="Code">💻</a></td>
</tr>
</table>

Expand Down
Loading
Loading