Skip to content

Commit 6fa6a17

Browse files
committed
refactor: rename package to ht_kv_storage
- Updated package name - Moved to flutter package - Added ht_kv_storage_service
1 parent f611a3b commit 6fa6a17

10 files changed

+27
-115
lines changed

.github/cspell.json

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/dependabot.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ updates:
99
directory: "/"
1010
schedule:
1111
interval: "daily"
12+
ignore:
13+
- dependency-name: "ht_*"

.github/workflows/main.yaml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,7 @@ jobs:
1616
semantic_pull_request:
1717
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1
1818

19-
spell-check:
20-
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1
21-
with:
22-
includes: "**/*.md"
23-
modified_files_only: false
24-
2519
build:
26-
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
27-
20+
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/flutter_package.yml@v1
21+
with:
22+
min_coverage: 90

README.md

Lines changed: 0 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +0,0 @@
1-
# Kv Storage Shared Preferences
2-
3-
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
4-
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
5-
[![License: MIT][license_badge]][license_link]
6-
7-
A Very Good Project created by Very Good CLI.
8-
9-
## Installation 💻
10-
11-
**❗ In order to start using Kv Storage Shared Preferences you must have the [Dart SDK][dart_install_link] installed on your machine.**
12-
13-
Install via `dart pub add`:
14-
15-
```sh
16-
dart pub add kv_storage_shared_preferences
17-
```
18-
19-
---
20-
21-
## Continuous Integration 🤖
22-
23-
Kv Storage Shared Preferences 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.
24-
25-
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].
26-
27-
---
28-
29-
## Running Tests 🧪
30-
31-
To run all unit tests:
32-
33-
```sh
34-
dart pub global activate coverage 1.2.0
35-
dart test --coverage=coverage
36-
dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
37-
```
38-
39-
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
40-
41-
```sh
42-
# Generate Coverage Report
43-
genhtml coverage/lcov.info -o coverage/
44-
45-
# Open Coverage Report
46-
open coverage/index.html
47-
```
48-
49-
[dart_install_link]: https://dart.dev/get-dart
50-
[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions
51-
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
52-
[license_link]: https://opensource.org/licenses/MIT
53-
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
54-
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
55-
[mason_link]: https://github.com/felangel/mason
56-
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
57-
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
58-
[very_good_coverage_link]: https://github.com/marketplace/actions/very-good-coverage
59-
[very_good_ventures_link]: https://verygood.ventures
60-
[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only
61-
[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only
62-
[very_good_workflows_link]: https://github.com/VeryGoodOpenSource/very_good_workflows
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
/// A Very Good Project created by Very Good CLI.
22
library;
33

4-
export 'src/kv_storage_shared_preferences.dart';
4+
export 'src/ht_kv_storage_shared_preferences.dart';
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/// {@template ht_kv_storage_shared_preferences}
2+
/// A Very Good Project created by Very Good CLI.
3+
/// {@endtemplate}
4+
class HtKvStorageSharedPreferences {
5+
/// {@macro ht_kv_storage_shared_preferences}
6+
const HtKvStorageSharedPreferences();
7+
}

lib/src/kv_storage_shared_preferences.dart

Lines changed: 0 additions & 7 deletions
This file was deleted.

pubspec.yaml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
name: kv_storage_shared_preferences
1+
name: ht_kv_storage_shared_preferences
22
description: A Very Good Project created by Very Good CLI.
3-
version: 0.1.0+1
3+
repository: https://github.com/headlines-toolkit/ht-kv-storage-shared-preferences
44
publish_to: none
55

66
environment:
7-
sdk: ^3.5.0
7+
sdk: ^3.7.0
8+
9+
dependencies:
10+
flutter:
11+
sdk: flutter
12+
ht_kv_storage_service:
13+
git:
14+
url: https://github.com/headlines-toolkit/ht-kv-storage-service.git
15+
ref: main
816

917
dev_dependencies:
18+
flutter_test:
19+
sdk: flutter
1020
mocktail: ^1.0.4
11-
test: ^1.25.8
12-
very_good_analysis: ^6.0.0
21+
very_good_analysis: ^7.0.0

test/src/ht_kv_storage_shared_preferences_test.dart

Whitespace-only changes.

test/src/kv_storage_shared_preferences_test.dart

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)