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

update the status of this package in the readme #46

Merged
merged 2 commits into from
Jun 12, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
6 changes: 2 additions & 4 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,20 @@ on:
pull_request:
branches: [ master ]

env:
PUB_ENVIRONMENT: bot.github

jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
sdk: [dev, 2.14.0]
sdk: [2.17.0, stable, dev]
steps:
- uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
- uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
with:
sdk: ${{ matrix.sdk }}
- run: dart pub get
- run: dart format --output=none --set-exit-if-changed .
if: ${{ matrix.sdk == 'stable' }}
- run: dart analyze --fatal-infos
- run: dart test
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 2.0.2

- Update the readme to indicate that this package is considered feature
complete.
- Require Dart 2.17.

## 2.0.1

- Remove the dependency on `package:quiver`.
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@

A library providing a tuple data structure.

## Status - complete

We consider this package to be feature complete. With Dart 3.0, users now have
the ability to use [Records](https://dart.dev/language/records):

> Records are an anonymous, immutable, aggregate type. Like other collection
types, they let you bundle multiple objects into a single object.

```dart
({int a, bool b}) record;
devoncarew marked this conversation as resolved.
Show resolved Hide resolved
record = (a: 123, b: true);
```

By and large, Records serve the same use cases that `package:tuple` had been
used for. New users coming to this package should likely look at using Dart
Records instead. Existing uses of package:tuple will continue to work, however
we don't intend to enhance the functionality of this package; we will continue
to maintain this package from the POV of bug fixes.

## Usage example

```dart
Expand Down
1 change: 1 addition & 0 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ include: package:lints/recommended.yaml

analyzer:
language:
strict-casts: true
strict-inference: true
6 changes: 3 additions & 3 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: tuple
version: 2.0.1
version: 2.0.2
description: A library providing a tuple data structure.
repository: https://github.com/google/tuple.dart

environment:
sdk: '>=2.14.0 <3.0.0'
sdk: '>=2.17.0 <3.0.0'

dependencies:

dev_dependencies:
lints: ^1.0.0
lints: ^2.0.0
test: ^1.16.0
2 changes: 0 additions & 2 deletions test/tuple_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// file for details. All rights reserved. Use of this source code is governed
// by a BSD-style license that can be found in the LICENSE file.

// ignore_for_file: prefer_const_constructors

import 'package:test/test.dart';
import 'package:tuple/tuple.dart';

Expand Down