-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 18c2cab
Showing
24 changed files
with
1,262 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: "fix: " | ||
labels: bug | ||
--- | ||
|
||
**Description** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**Steps To Reproduce** | ||
|
||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected Behavior** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional Context** | ||
|
||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Feature Request | ||
about: A new feature to be added to the project | ||
title: "feat: " | ||
labels: feature | ||
--- | ||
|
||
**Description** | ||
|
||
Clearly describe what you are looking to add. The more context the better. | ||
|
||
**Requirements** | ||
|
||
- [ ] Checklist of requirements to be fulfilled | ||
|
||
**Additional Context** | ||
|
||
Add any other context or screenshots about the feature request go here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- | ||
Thanks for contributing! | ||
Provide a description of your changes below and a general summary in the title | ||
Please look at the following checklist to ensure that your PR can be accepted quickly: | ||
--> | ||
|
||
## Description | ||
|
||
<!--- Describe your changes in detail --> | ||
|
||
## Type of Change | ||
|
||
<!--- Put an `x` in all the boxes that apply: --> | ||
|
||
- [ ] ✨ New feature (non-breaking change which adds functionality) | ||
- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue) | ||
- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change) | ||
- [ ] 🧹 Code refactor | ||
- [ ] ✅ Build configuration change | ||
- [ ] 📝 Documentation | ||
- [ ] 🗑️ Chore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"version": "0.2", | ||
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", | ||
"dictionaries": ["vgv_allowed", "vgv_forbidden"], | ||
"dictionaryDefinitions": [ | ||
{ | ||
"name": "vgv_allowed", | ||
"path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/allowed.txt", | ||
"description": "Allowed VGV Spellings" | ||
}, | ||
{ | ||
"name": "vgv_forbidden", | ||
"path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/forbidden.txt", | ||
"description": "Forbidden VGV Spellings" | ||
} | ||
], | ||
"useGitignore": true, | ||
"words": [ | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
version: 2 | ||
enable-beta-ecosystems: true | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" | ||
- package-ecosystem: "pub" | ||
directory: "/" | ||
schedule: | ||
interval: "daily" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
name: flutter_compile | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- ".github/workflows/flutter_compile.yaml" | ||
- "lib/**" | ||
- "test/**" | ||
- "pubspec.yaml" | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- ".github/workflows/flutter_compile.yaml" | ||
- "lib/**" | ||
- "test/**" | ||
- "pubspec.yaml" | ||
|
||
jobs: | ||
semantic-pull-request: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1 | ||
|
||
build: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1 | ||
|
||
spell-check: | ||
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1 | ||
with: | ||
includes: | | ||
**/*.md | ||
!brick/**/*.md | ||
.*/**/*.md | ||
modified_files_only: false | ||
|
||
verify-version: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: 📚 Git Checkout | ||
uses: actions/checkout@v2 | ||
|
||
- name: 🎯 Setup Dart | ||
uses: dart-lang/setup-dart@v1 | ||
with: | ||
sdk: "stable" | ||
|
||
- name: 📦 Install Dependencies | ||
run: | | ||
dart pub get | ||
- name: 🔎 Verify version | ||
run: dart run test --run-skipped -t version-verify |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# See https://www.dartlang.org/guides/libraries/private-files | ||
|
||
# Files and directories created by pub | ||
.dart_tool/ | ||
.packages | ||
build/ | ||
pubspec.lock | ||
|
||
# Files generated during tests | ||
.test_coverage.dart | ||
coverage/ | ||
.test_runner.dart | ||
|
||
# Android studio and IntelliJ | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
## flutter_compile | ||
|
||
![coverage][coverage_badge] | ||
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] | ||
[![License: MIT][license_badge]][license_link] | ||
|
||
Generated by the [Very Good CLI][very_good_cli_link] 🤖 | ||
|
||
A Dart CLI to simplify the setting up your framework development environment, which describes and automates the steps you need to configure your computer to work on Flutter's Framework. | ||
|
||
--- | ||
|
||
## Getting Started 🚀 | ||
|
||
If the CLI application is available on [pub](https://pub.dev), activate globally via: | ||
|
||
```sh | ||
dart pub global activate flutter_compile | ||
``` | ||
|
||
Or locally via: | ||
|
||
```sh | ||
dart pub global activate --source=path <path to this package> | ||
``` | ||
|
||
## Usage | ||
|
||
```sh | ||
# Sample command | ||
$ flutter_compile sample | ||
|
||
# Sample command option | ||
$ flutter_compile sample --cyan | ||
|
||
# Show CLI version | ||
$ flutter_compile --version | ||
|
||
# Show usage help | ||
$ flutter_compile --help | ||
``` | ||
|
||
## Running Tests with coverage 🧪 | ||
|
||
To run all unit tests use the following command: | ||
|
||
```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 | ||
``` | ||
|
||
--- | ||
|
||
[coverage_badge]: coverage_badge.svg | ||
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg | ||
[license_link]: https://opensource.org/licenses/MIT | ||
[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_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
include: package:very_good_analysis/analysis_options.6.0.0.yaml | ||
linter: | ||
rules: | ||
public_member_api_docs: false |
Oops, something went wrong.