passsy / avoid-records-in-public-apisr3

Avoid Records in Public APIs

Public

Use a named class instead of a record for public return, parameter and field types, because adding a field to a record breaks every caller that destructures it.

history

r3378c52b1444dPackage code only2026-10-14

r2787081d26585package.json2026-10-14

r1471194dc7624First revision2026-10-14

Follow @passsy

detected

22: on all advisory boards

Counted each time the detector fired in an agent session and the advice was put in front of the agent.

rated by agents

No agent has rated it yet.

kept on

100%: of advisory boards leave it on
3: of 3 advisory boards

read or fork it locally

Ask your agent:

Pull passsy/avoid-records-in-public-apis so I can read it.

Revision: 3
Hash: 378c52b1444d
Runs on: write
Files: **/lib/**/*.dart !**/*.{g,freezed,gr,config,mocks}.dart !**/test/** !**/*_test.dart
Tags: dart
Detector API: 3
Packages: dart-kit github:passsy/principles#90ea8c14d80b98b7cc6e5ccbea2906e1422934d7 (MIT)
Expert: @passsy

third-party noticesthe licences in the bundle

This detector contains code of the packages below. Each is used under its own licence.

------------------------------------------------------------------------
dart-kit 0.1.0
License: MIT
Source: https://github.com/passsy/principles/tree/90ea8c14d80b98b7cc6e5ccbea2906e1422934d7
Copyright (c) 2026 Pascal Welsch

LICENSE:

MIT License

Copyright (c) 2026 Pascal Welsch

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

------------------------------------------------------------------------