Skip to content

Commit

Permalink
chore: merge main
Browse files Browse the repository at this point in the history
  • Loading branch information
bruuuuuuuce committed Dec 18, 2023
2 parents 9fbb954 + 324c222 commit f197f53
Show file tree
Hide file tree
Showing 66 changed files with 14,802 additions and 8,487 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/dart.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Dart

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

# Note: This workflow uses the latest stable version of the Dart SDK.
# You can specify other versions if desired, see documentation here:
# https://github.com/dart-lang/setup-dart/blob/main/README.md
# - uses: dart-lang/setup-dart@v1
- uses: dart-lang/setup-dart@9a04e6d73cca37bd455e0608d7e5092f881fd603

- name: Install dependencies
run: dart pub get

# Uncomment this step to verify the use of 'dart format' on each commit.
- name: Verify formatting
run: dart format --output=none --set-exit-if-changed .

# Consider passing '--fatal-infos' for slightly stricter analysis.
- name: Analyze project source
run: dart analyze

# Your project will need to have tests in test/ and a dependency on
# package:test for this step to succeed. Note that Flutter projects will
# want to change this to 'flutter test'.
- name: Run tests
run: dart test
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ and the Flutter guide for
4. `brew info dart` to determine where the dart sdk is installed
5. followed [these](https://fluttermaster.com/config-dart-sdk-inside-intellij-idea-on-macos/) instructions on how to setup sdk inside of intellij

In VSCode, there's an extension for Dart and Flutter files.
To install dependencies using CLI: `dart pub get`
Running tests: `dart test`
Linting and formatting: `dart format .` and `dart fix`

TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.

Expand All @@ -40,6 +45,17 @@ to `/example` folder.
const like = 'sample';
```

## Logging

We use the [Dart logging package](https://github.com/dart-lang/logging) to create internal Loggers for producing Momento-related logs. The default logger does not do anything with the logs, so you must configure the logging level and handler at the beginning of your program:

```
Logger.root.level = Level.ALL; // defaults to Level.INFO
Logger.root.onRecord.listen((record) {
print('${record.level.name}: ${record.time}: ${record.message}');
});
```

## Additional information

TODO: Tell users more about the package: where to find more information, how to
Expand Down
6 changes: 3 additions & 3 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ include: package:lints/recommended.yaml
# rules:
# - camel_case_types

# analyzer:
# exclude:
# - path/to/excluded/files/**
analyzer:
exclude:
- lib/generated/**

# For more information about the core and recommended set of lints, see
# https://dart.dev/go/core-lints
Expand Down
6 changes: 2 additions & 4 deletions example/client_sdk_dart_example.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import 'package:client_sdk_dart/client_sdk_dart.dart';

void main() {
var awesome = Awesome();
print('awesome: ${awesome.isAwesome}');
// var awesome = Awesome();
// print('awesome: ${awesome.isAwesome}');
}
2 changes: 1 addition & 1 deletion lib/client_sdk_dart.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
/// More dartdocs go here.
library;

export 'src/client_sdk_dart_base.dart';
export 'src/topic_client.dart';

// TODO: Export any libraries intended for clients of this package.

0 comments on commit f197f53

Please sign in to comment.