Skip to content

Commit

Permalink
Created pkg mq_remote_client
Browse files Browse the repository at this point in the history
  • Loading branch information
Eldar2021 committed Jul 27, 2024
1 parent 3724dca commit 18c7881
Show file tree
Hide file tree
Showing 12 changed files with 97 additions and 55 deletions.
1 change: 0 additions & 1 deletion packages/mq_client/README.md

This file was deleted.

14 changes: 0 additions & 14 deletions packages/mq_client/analysis_options.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions packages/mq_client/lib/mq_client.dart

This file was deleted.

7 changes: 0 additions & 7 deletions packages/mq_client/lib/src/mq_client.dart

This file was deleted.

17 changes: 0 additions & 17 deletions packages/mq_client/pubspec.yaml

This file was deleted.

12 changes: 0 additions & 12 deletions packages/mq_client/test/src/mq_client_test.dart

This file was deleted.

62 changes: 62 additions & 0 deletions packages/mq_remote_client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Mq Remote Client

[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
[![License: MIT][license_badge]][license_link]

MyQuran Remote Client

## Installation 💻

**❗ In order to start using Mq Remote Client you must have the [Dart SDK][dart_install_link] installed on your machine.**

Install via `dart pub add`:

```sh
dart pub add mq_remote_client
```

---

## Continuous Integration 🤖

Mq Remote Client comes with a built-in [GitHub Actions workflow][github_actions_link] powered by [Very Good Workflows][very_good_workflows_link] but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI `formats`, `lints`, and `tests` the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses [Very Good Analysis][very_good_analysis_link] for a strict set of analysis options used by our team. Code coverage is enforced using the [Very Good Workflows][very_good_coverage_link].

---

## Running Tests 🧪

To run all unit tests:

```sh
dart pub global activate coverage 1.2.0
dart test --coverage=coverage
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
```

To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).

```sh
# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html
```

[dart_install_link]: https://dart.dev/get-dart
[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
[mason_link]: https://github.com/felangel/mason
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_coverage_link]: https://github.com/marketplace/actions/very-good-coverage
[very_good_ventures_link]: https://verygood.ventures
[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only
[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only
[very_good_workflows_link]: https://github.com/VeryGoodOpenSource/very_good_workflows
1 change: 1 addition & 0 deletions packages/mq_remote_client/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include: package:very_good_analysis/analysis_options.6.0.0.yaml
4 changes: 4 additions & 0 deletions packages/mq_remote_client/lib/mq_remote_client.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/// MyQuran Remote Client
library;

export 'src/mq_remote_client.dart';
7 changes: 7 additions & 0 deletions packages/mq_remote_client/lib/src/mq_remote_client.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/// {@template mq_remote_client}
/// MyQuran Remote Client
/// {@endtemplate}
class MqRemoteClient {
/// {@macro mq_remote_client}
const MqRemoteClient();
}
12 changes: 12 additions & 0 deletions packages/mq_remote_client/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: mq_remote_client
description: MyQuran Remote Client
version: 0.1.0+1
publish_to: none

environment:
sdk: ^3.4.0

dev_dependencies:
mocktail: ^1.0.4
test: ^1.25.7
very_good_analysis: ^6.0.0
11 changes: 11 additions & 0 deletions packages/mq_remote_client/test/mq_remote_client_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// ignore_for_file: prefer_const_constructors
import 'package:mq_remote_client/mq_remote_client.dart';
import 'package:test/test.dart';

void main() {
group('MqRemoteClient', () {
test('can be instantiated', () {
expect(MqRemoteClient(), isNotNull);
});
});
}

0 comments on commit 18c7881

Please sign in to comment.