From 3c2fb02cb0a981582e8086e711d7b7eb8451f83a Mon Sep 17 00:00:00 2001 From: Thomas Labrecque Date: Tue, 14 May 2024 10:58:01 -0400 Subject: [PATCH] feat: Empty Flutter Package --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .gitignore | 359 +++--------------------------- BREAKING_CHANGES.md | 11 - CHANGELOG.md | 8 + analysis_options.yaml | 30 +++ build/azure-pipelines.yml | 24 ++ lib/review_service.dart | 4 + lib/src/review_service.dart | 7 + pubspec.yaml | 17 ++ test/src/review_service_test.dart | 10 + 10 files changed, 137 insertions(+), 335 deletions(-) delete mode 100644 BREAKING_CHANGES.md create mode 100644 CHANGELOG.md create mode 100644 analysis_options.yaml create mode 100644 build/azure-pipelines.yml create mode 100644 lib/review_service.dart create mode 100644 lib/src/review_service.dart create mode 100644 pubspec.yaml create mode 100644 test/src/review_service_test.dart diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6aaf21e..e308936 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,7 +29,7 @@ Please check that your PR fulfills the following requirements: - [ ] Documentation has been added/updated. - [ ] Automated tests for the changes have been added/updated. -- [ ] Updated [BREAKING_CHANGES.md](../BREAKING_CHANGES.md) (if you introduced a breaking change). +- [ ] Updated [CHANGELOG.md](../CHANGELOG.md). diff --git a/.gitignore b/.gitignore index 9de1acd..06ef8e6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,331 +1,44 @@ -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. -## -## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore - -# User-specific files -*.suo -*.user -*.userosscache -*.sln.docstates - -# User-specific files (MonoDevelop/Xamarin Studio) -*.userprefs - -# Build results -[Dd]ebug/ -[Dd]ebugPublic/ -[Rr]elease/ -[Rr]eleases/ -x64/ -x86/ -bld/ -[Bb]in/ -[Oo]bj/ -[Ll]og/ - -# Visual Studio 2015/2017 cache/options directory -.vs/ -# Uncomment if you have tasks that create the project's static files in wwwroot -#wwwroot/ - -# Visual Studio 2017 auto generated files -Generated\ Files/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -# NUNIT -*.VisualState.xml -TestResult.xml - -# Build Results of an ATL Project -[Dd]ebugPS/ -[Rr]eleasePS/ -dlldata.c - -# Benchmark Results -BenchmarkDotNet.Artifacts/ - -# .NET Core -project.lock.json -project.fragment.lock.json -artifacts/ -**/Properties/launchSettings.json - -# StyleCop -StyleCopReport.xml - -# Files built by Visual Studio -*_i.c -*_p.c -*_i.h -*.ilk -*.meta -*.obj -*.iobj -*.pch -*.pdb -*.ipdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj +# Miscellaneous +*.class *.log -*.vspscc -*.vssscc -.builds -*.pidb -*.svclog -*.scc - -# Chutzpah Test files -_Chutzpah* - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opendb -*.opensdf -*.sdf -*.cachefile -*.VC.db -*.VC.VC.opendb - -# Visual Studio profiler -*.psess -*.vsp -*.vspx -*.sap - -# Visual Studio Trace Files -*.e2e - -# TFS 2012 Local Workspace -$tf/ - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper -*.DotSettings.user - -# JustCode is a .NET coding add-in -.JustCode - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# AxoCover is a Code Coverage Tool -.axoCover/* -!.axoCover/settings.json - -# Visual Studio code coverage results -*.coverage -*.coveragexml - -# NCrunch -_NCrunch_* -.*crunch*.local.xml -nCrunchTemp_* - -# MightyMoose -*.mm.* -AutoTest.Net/ - -# Web workbench (sass) -.sass-cache/ - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.[Pp]ublish.xml -*.azurePubxml -# Note: Comment the next line if you want to checkin your web deploy settings, -# but database connection strings (with potential passwords) will be unencrypted -*.pubxml -*.publishproj - -# Microsoft Azure Web App publish settings. Comment the next line if you want to -# checkin your Azure Web App publish settings, but sensitive information contained -# in these scripts will be unencrypted -PublishScripts/ - -# NuGet Packages -*.nupkg -# The packages folder can be ignored because of Package Restore -**/[Pp]ackages/* -# except build/, which is used as an MSBuild target. -!**/[Pp]ackages/build/ -# Uncomment if necessary however generally it will be regenerated when needed -#!**/[Pp]ackages/repositories.config -# NuGet v3's project.json files produces more ignorable files -*.nuget.props -*.nuget.targets - -# Microsoft Azure Build Output -csx/ -*.build.csdef - -# Microsoft Azure Emulator -ecf/ -rcf/ - -# Windows Store app package directories and files -AppPackages/ -BundleArtifacts/ -Package.StoreAssociation.xml -_pkginfo.txt -*.appx - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!*.[Cc]ache/ - -# Others -ClientBin/ -~$* -*~ -*.dbmdl -*.dbproj.schemaview -*.jfm -*.pfx -*.publishsettings -orleans.codegen.cs -*.DS_Store - -# Including strong name files can present a security risk -# (https://github.com/github/gitignore/pull/2483#issue-259490424) -#*.snk - -# Since there are multiple workflows, uncomment next line to ignore bower_components -# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) -#bower_components/ - -# RIA/Silverlight projects -Generated_Code/ - -# Backup & report files from converting an old project file -# to a newer Visual Studio version. Backup files are not needed, -# because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm -ServiceFabricBackup/ -*.rptproj.bak - -# SQL Server files -*.mdf -*.ldf -*.ndf - -# Business Intelligence projects -*.rdl.data -*.bim.layout -*.bim_*.settings -*.rptproj.rsuser - -# Microsoft Fakes -FakesAssemblies/ - -# GhostDoc plugin setting file -*.GhostDoc.xml - -# Node.js Tools for Visual Studio -.ntvs_analysis.dat -node_modules/ - -# Visual Studio 6 build log -*.plg - -# Visual Studio 6 workspace options file -*.opt - -# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) -*.vbw - -# Visual Studio LightSwitch build output -**/*.HTMLClient/GeneratedArtifacts -**/*.DesktopClient/GeneratedArtifacts -**/*.DesktopClient/ModelManifest.xml -**/*.Server/GeneratedArtifacts -**/*.Server/ModelManifest.xml -_Pvt_Extensions - -# Paket dependency manager -.paket/paket.exe -paket-files/ - -# FAKE - F# Make -.fake/ - -# JetBrains Rider -.idea/ -*.sln.iml - -# CodeRush -.cr/ - -# Python Tools for Visual Studio (PTVS) -__pycache__/ *.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ -# Cake - Uncomment if you are using it -# tools/** -# !tools/packages.config - -# Tabs Studio -*.tss - -# Telerik's JustMock configuration file -*.jmconfig - -# BizTalk build output -*.btp.cs -*.btm.cs -*.odx.cs -*.xsd.cs +# VSCode related +.vscode/* -# OpenCover UI analysis results -OpenCover/ +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ +pubspec.lock -# Azure Stream Analytics local run output -ASALocalRun/ +# Web related +lib/generated_plugin_registrant.dart -# MSBuild Binary and Structured Log -*.binlog +# Symbolication related +app.*.symbols -# NVidia Nsight GPU debugger configuration file -*.nvuser +# Obfuscation related +app.*.map.json -# MFractors (Xamarin productivity tool) working folder -.mfractor/ +# Test related +coverage \ No newline at end of file diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md deleted file mode 100644 index cb35164..0000000 --- a/BREAKING_CHANGES.md +++ /dev/null @@ -1,11 +0,0 @@ -# Breaking Changes - - diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d977cc6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) + +## Before Initial Release + +- feat: initial commit 🎉 diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 0000000..dee8927 --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1,30 @@ +# This file configures the static analysis results for your project (errors, +# warnings, and lints). +# +# This enables the 'recommended' set of lints from `package:lints`. +# This set helps identify many issues that may lead to problems when running +# or consuming Dart code, and enforces writing Dart using a single, idiomatic +# style and format. +# +# If you want a smaller set of lints you can change this to specify +# 'package:lints/core.yaml'. These are just the most critical lints +# (the recommended set includes the core lints). +# The core lints are also what is used by pub.dev for scoring packages. + +include: package:lints/recommended.yaml + +# Uncomment the following section to specify additional rules. + +# linter: +# rules: +# - camel_case_types + +# analyzer: +# exclude: +# - path/to/excluded/files/** + +# For more information about the core and recommended set of lints, see +# https://dart.dev/go/core-lints + +# For additional information about configuring this file, see +# https://dart.dev/guides/language/analysis-options diff --git a/build/azure-pipelines.yml b/build/azure-pipelines.yml new file mode 100644 index 0000000..5fd496e --- /dev/null +++ b/build/azure-pipelines.yml @@ -0,0 +1,24 @@ +trigger: + branches: + include: + - main + +variables: +- name: windowsHostedAgentImage + value: 'windows-2022' +- name: IsReleaseBranch # Should this branch name use the release stage. + value: $[or(eq(variables['Build.SourceBranch'], 'refs/heads/main'), startsWith(variables['Build.SourceBranch'], 'refs/heads/feature/'), startsWith(variables['Build.SourceBranch'], 'refs/heads/release/'))] + +stages: +- stage: OnWindows_ + jobs: + - job: Test Pipeline + + pool: + vmImage: $(windowsHostedAgentImage) + + workspace: + clean: all # Cleanup the workspace before starting. + + steps: + - script: echo Hello world! diff --git a/lib/review_service.dart b/lib/review_service.dart new file mode 100644 index 0000000..cbecdbd --- /dev/null +++ b/lib/review_service.dart @@ -0,0 +1,4 @@ +/// A multi-platform recipe to rate mobile apps. +library; + +export 'src/review_service.dart'; diff --git a/lib/src/review_service.dart b/lib/src/review_service.dart new file mode 100644 index 0000000..174b8a8 --- /dev/null +++ b/lib/src/review_service.dart @@ -0,0 +1,7 @@ +/// {@template review_service} +/// A multi-platform recipe to rate mobile apps. +/// {@endtemplate} +class ReviewService { + /// {@macro review_service} + const ReviewService(); +} diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 0000000..41ad1b4 --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,17 @@ +name: review_service +description: A multi-platform recipe to rate mobile apps. +version: 0.1.0+1 +homepage: https://github.com/nventive/ReviewService-Dart + +environment: + sdk: "^3.3.0" + flutter: "^3.19.0" + +dependencies: + flutter: + sdk: flutter + +dev_dependencies: + flutter_test: + sdk: flutter + lints: ^3.0.0 diff --git a/test/src/review_service_test.dart b/test/src/review_service_test.dart new file mode 100644 index 0000000..37e5108 --- /dev/null +++ b/test/src/review_service_test.dart @@ -0,0 +1,10 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:review_service/review_service.dart'; + +void main() { + group('ReviewService', () { + test('can be instantiated', () { + expect(ReviewService(), isNotNull); + }); + }); +}