From a4b089635fd7f3e63dbafd623fab5d5188404dab Mon Sep 17 00:00:00 2001 From: Nikolas Rimikis Date: Mon, 16 Oct 2023 12:29:06 +0200 Subject: [PATCH 1/2] refactor: remove flutter_package rules and require documentation for all rules Signed-off-by: Nikolas Rimikis --- packages/neon/neon/analysis_options.yaml | 2 +- packages/neon/neon_files/analysis_options.yaml | 4 ++++ packages/neon/neon_news/analysis_options.yaml | 4 ++++ packages/neon/neon_notes/analysis_options.yaml | 4 ++++ packages/neon/neon_notifications/analysis_options.yaml | 4 ++++ packages/neon_lints/lib/flutter.yaml | 2 -- packages/neon_lints/lib/flutter_package.yaml | 5 ----- 7 files changed, 17 insertions(+), 8 deletions(-) delete mode 100644 packages/neon_lints/lib/flutter_package.yaml diff --git a/packages/neon/neon/analysis_options.yaml b/packages/neon/neon/analysis_options.yaml index d67880af..331c0af6 100644 --- a/packages/neon/neon/analysis_options.yaml +++ b/packages/neon/neon/analysis_options.yaml @@ -1,4 +1,4 @@ -include: package:neon_lints/flutter_package.yaml +include: package:neon_lints/flutter.yaml linter: rules: diff --git a/packages/neon/neon_files/analysis_options.yaml b/packages/neon/neon_files/analysis_options.yaml index 66de1efd..243819ae 100644 --- a/packages/neon/neon_files/analysis_options.yaml +++ b/packages/neon/neon_files/analysis_options.yaml @@ -1,5 +1,9 @@ include: package:neon_lints/flutter.yaml +linter: + rules: + public_member_api_docs: false + analyzer: exclude: - lib/l10n/** diff --git a/packages/neon/neon_news/analysis_options.yaml b/packages/neon/neon_news/analysis_options.yaml index 66de1efd..243819ae 100644 --- a/packages/neon/neon_news/analysis_options.yaml +++ b/packages/neon/neon_news/analysis_options.yaml @@ -1,5 +1,9 @@ include: package:neon_lints/flutter.yaml +linter: + rules: + public_member_api_docs: false + analyzer: exclude: - lib/l10n/** diff --git a/packages/neon/neon_notes/analysis_options.yaml b/packages/neon/neon_notes/analysis_options.yaml index 66de1efd..243819ae 100644 --- a/packages/neon/neon_notes/analysis_options.yaml +++ b/packages/neon/neon_notes/analysis_options.yaml @@ -1,5 +1,9 @@ include: package:neon_lints/flutter.yaml +linter: + rules: + public_member_api_docs: false + analyzer: exclude: - lib/l10n/** diff --git a/packages/neon/neon_notifications/analysis_options.yaml b/packages/neon/neon_notifications/analysis_options.yaml index 66de1efd..243819ae 100644 --- a/packages/neon/neon_notifications/analysis_options.yaml +++ b/packages/neon/neon_notifications/analysis_options.yaml @@ -1,5 +1,9 @@ include: package:neon_lints/flutter.yaml +linter: + rules: + public_member_api_docs: false + analyzer: exclude: - lib/l10n/** diff --git a/packages/neon_lints/lib/flutter.yaml b/packages/neon_lints/lib/flutter.yaml index 67303d7c..65e82b6c 100644 --- a/packages/neon_lints/lib/flutter.yaml +++ b/packages/neon_lints/lib/flutter.yaml @@ -2,6 +2,4 @@ include: package:neon_lints/src/base.yaml linter: rules: - public_member_api_docs: false - library_private_types_in_public_api: false avoid_print: true diff --git a/packages/neon_lints/lib/flutter_package.yaml b/packages/neon_lints/lib/flutter_package.yaml deleted file mode 100644 index 65e82b6c..00000000 --- a/packages/neon_lints/lib/flutter_package.yaml +++ /dev/null @@ -1,5 +0,0 @@ -include: package:neon_lints/src/base.yaml - -linter: - rules: - avoid_print: true From 2a7ec854ddaf4373fc4071732191e07b83804887 Mon Sep 17 00:00:00 2001 From: Nikolas Rimikis Date: Mon, 16 Oct 2023 12:30:20 +0200 Subject: [PATCH 2/2] docs(app): document public members Signed-off-by: Nikolas Rimikis --- packages/app/lib/apps.dart | 1 + packages/app/lib/branding.dart | 3 +++ 2 files changed, 4 insertions(+) diff --git a/packages/app/lib/apps.dart b/packages/app/lib/apps.dart index 2ce3f151..ad1a2723 100644 --- a/packages/app/lib/apps.dart +++ b/packages/app/lib/apps.dart @@ -4,6 +4,7 @@ import 'package:neon_news/neon_news.dart'; import 'package:neon_notes/neon_notes.dart'; import 'package:neon_notifications/neon_notifications.dart'; +/// The collection of clients enabled for the Neon app. final Set appImplementations = { FilesApp(), NewsApp(), diff --git a/packages/app/lib/branding.dart b/packages/app/lib/branding.dart index 8a3acf75..18e979c0 100644 --- a/packages/app/lib/branding.dart +++ b/packages/app/lib/branding.dart @@ -3,11 +3,13 @@ import 'dart:ui'; import 'package:neon/theme.dart'; import 'package:vector_graphics/vector_graphics.dart'; +/// The custom theme used in the Neon app. const neonTheme = NeonTheme( branding: branding, colorScheme: colorScheme, ); +/// The custom branding used in the Neon app. const branding = Branding( name: 'Nextcloud Neon', logo: VectorGraphic( @@ -22,6 +24,7 @@ const branding = Branding( legalese: 'Copyright © 2023, provokateurin\nUnder GPLv3 license', ); +/// The custom color scheme used in the Neon app. const colorScheme = NeonColorScheme( primary: Color(0xFFF37736), );