Merge pull request #840 from nextcloud/feature/automatic-spell-checking

Feature/automatic spell checking

.cspell/dart_flutter.txt

@@ -0,0 +1,9 @@
+autofocus
+gapless
+lerp
+pubspec
+sublist
+todos
+unawaited
+unfocus
+writeln

.cspell/misc.txt

@@ -0,0 +1,11 @@
+browsable
+cleartext
+deeplinking
+flathub
+foss
+fullscreen
+playstore
+postmarket
+provokateurin
+subroutes
+uncategorized

.cspell/neon.txt

@@ -0,0 +1,20 @@
+crypton
+exportables
+fcmup
+filesize
+gotify
+heckel
+mocktail
+nextpush
+noprovider
+ntfy
+oled
+oledas
+rxdart
+seti
+siacs
+sqflite
+underspecified
+updateshouldnotify
+wakelock
+zxing

.cspell/nextcloud.txt

@@ -0,0 +1,71 @@
+apirequest
+applist
+apppassword
+approximative
+appstore
+bigfilechunking
+bools
+bulkupload
+commenters
+csapi
+datetime
+deletedshares
+displayname
+etag
+fediverse
+getapppassword
+groupid
+hovercard
+iscustomavatar
+itemsperpage
+keepalive
+keypair
+lastmod
+licence
+logfile
+logoheader
+mimetypes
+mountpoint
+navigations
+nextcloud
+nextcloud's
+openlocaleditor
+organisation
+prio
+productname
+publicpreview
+reshares
+resharing
+rgdnvw
+r'sharebymail
+r'updatenotification
+r'uppush
+shareapi
+sharebymail
+sharee
+shareesapi
+shareinfo
+statuscode
+stime
+stylesheet
+subadmin
+subadmins
+subfiles
+subline
+tasktypes
+textprocessing
+totalitems
+transferownership
+trashbin
+undelete
+unifiedpush
+unsharing
+unstar
+updatenotification
+uppush
+usercount
+usergroup
+userid
+userroom
+versionstring
+whatsnew

.cspell/tools.txt

@@ -0,0 +1,60 @@
+aarch
+allprojects
+appindicator
+autoptr
+buildscript
+buildsystem
+buildx
+cest
+classpath
+cloc
+commitlint
+dapplication
+dists
+endforeach
+endfunction
+endlegend
+endswith
+enduml
+euxo
+exiftool
+extglob
+freedesktop
+fullpath
+gboolean
+gchar
+genhtml
+gradlew
+hicolor
+icudtl
+inkscape
+intellij
+jetbrains
+jvmargs
+klass
+lcov
+libapp
+libappindicator
+libayatana
+libflutter
+libindicator
+libsqlite
+mipmap
+ndebug
+nproc
+plantuml
+precache
+puml
+rpath
+startuml
+stdlib
+strconcat
+strdupv
+strfreev
+subprojects
+sysroot
+tsvg
+werror
+workdir
+xxxh
+xxxhdpi

.cspell/webdav.txt

@@ -0,0 +1,50 @@
+copymove
+dasl
+davgetcontentlength
+davgetcontenttype
+davgetetag
+davgetlastmodified
+davresourcetype
+fileid
+getcontentlength
+getcontenttype
+getetag
+getlastmodified
+largefile
+mkcol
+multistatus
+nccreationtime
+ncdatafingerprint
+nchaspreview
+ncisencrypted
+ncmetadataetag
+ncmounttype
+ncnote
+ncrichworkspace
+ncuploadtime
+nodestcoll
+noncoll
+noparent
+occommentscount
+occommentshref
+occommentsunread
+ocdownloadurl
+ocfavorite
+ocfileid
+ocid
+ocmsharepermissions
+ocownerdisplayname
+ocownerid
+ocpermissions
+ocsize
+ocssharepermissions
+owncloud
+propertyupdate
+propfind
+proppatch
+propstat
+propstats
+resourcetype
+sharees
+systemtag
+webdav

.github/workflows/spellcheck.yaml

@@ -0,0 +1,10 @@
+name: 'Check spelling'
+on:
+  pull_request:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@v3

README.md

@@ -22,7 +22,7 @@ The Neon project has three main goals:
 
 The Neon project uses [Dart](https://dart.dev/) and [Flutter](https://flutter.dev/) to help mobile client developers building apps. Flutter allows us to build convergent cross-platform clients that feel native. 
 We are a 100% FOSS framework and do not rely on any proprietary libraries making it easy for developers to publish their apps in places like the [F-Droid](https://f-droid.org/) store.
-We provide a generated [Nextcloud Dart client](packages/nextcloud) that is generated from the new OpenAPI specifications shipped with Nextcloud and is already being used by other Dart and Flutter projects. Gone are the days of looking at the PHP code and implementing an API client by hand wich can be time-consuming and very error-prone.
+We provide a generated [Nextcloud Dart client](packages/nextcloud) that is generated from the new OpenAPI specifications shipped with Nextcloud and is already being used by other Dart and Flutter projects. Gone are the days of looking at the PHP code and implementing an API client by hand which can be time-consuming and very error-prone.
 
 We provide abstractions, common utilities and prebuilt UI components (called Widgets in Flutter) that can be re-used. This allows Neon to make developing a new Nextcloud client as easy as adding a few custom UI elements and the necessary state management, while everything else is already taken care of for you.
 

cspell.json

@@ -0,0 +1,60 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "OpenAPI"
+  ],
+  "ignorePaths": [
+    "**.iml",
+    "**.log",
+    "**.svg",
+    "**/assets/**",
+    "**/build/**",
+    "**/coverage/**",
+    "**/ephemeral/**",
+    "**/l10n/!(en.arb)",
+    "external",
+    "packages/app/android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java",
+    "packages/app/android/gradlew*",
+    "packages/file_icons/lib/src/data.dart",
+    "packages/neon_lints/lib",
+    "packages/nextcloud/test/files"
+  ],
+  "dictionaries": [
+    "bash",
+    "dart_flutter",
+    "en_US",
+    "misc",
+    "neon",
+    "nextcloud",
+    "softwareTerms",
+    "tools",
+    "webdav"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "dart_flutter",
+      "path": ".cspell/dart_flutter.txt"
+    },
+    {
+      "name": "misc",
+      "path": ".cspell/misc.txt"
+    },
+    {
+      "name": "neon",
+      "path": ".cspell/neon.txt"
+    },
+    {
+      "name": "nextcloud",
+      "path": ".cspell/nextcloud.txt"
+    },
+    {
+      "name": "tools",
+      "path": ".cspell/tools.txt"
+    },
+    {
+      "name": "webdav",
+      "path": ".cspell/webdav.txt"
+    }
+  ]
+}

packages/file_icons/bin/file_icons.dart

@@ -98,7 +98,7 @@ void generateData() {
     "import 'package:flutter/widgets.dart';",
     '',
     '// Code points',
-    // This filters unused codepoints.
+    // This filters unused code points.
     for (final type in codePoints.keys
         .where((final type) => iconSet.keys.map((final pattern) => iconSet[pattern]![0] == type).contains(true))) ...[
       'const ${_toVariableName(type)} = ${codePoints[type]};',

packages/neon/neon/lib/l10n/en.arb

@@ -12,7 +12,7 @@
   "loginOpenAgain": "Open again",
   "loginSwitchToBrowserWindow": "Please switch to the browser window that just opened and proceed there",
   "loginWorksWith": "works with",
-  "loginUsingQrcode": "Login using a QR code",
+  "loginUsingQRcode": "Login using a QR code",
   "loginUsingServerAddress": "Login using the server address",
   "loginCheckingServerVersion": "Checking server version",
   "loginSupportedServerVersion": "Supported server version: {version}",
@@ -69,7 +69,7 @@
   },
   "errorEmptyField": "This field can not be empty",
   "errorInvalidURL": "Invalid URL provided",
-  "errorInvalidQrcode": "Invalid QR-Code provided",
+  "errorInvalidQRcode": "Invalid QR-Code provided",
   "errorRouteNotFound": "Route not found: {route}",
   "@errorRouteNotFound" : {
     "placeholders": {

packages/neon/neon/lib/l10n/localizations.dart

@@ -131,11 +131,11 @@ abstract class AppLocalizations {
   /// **'works with'**
   String get loginWorksWith;
 
-  /// No description provided for @loginUsingQrcode.
+  /// No description provided for @loginUsingQRcode.
   ///
   /// In en, this message translates to:
   /// **'Login using a QR code'**
-  String get loginUsingQrcode;
+  String get loginUsingQRcode;
 
   /// No description provided for @loginUsingServerAddress.
   ///
@@ -263,11 +263,11 @@ abstract class AppLocalizations {
   /// **'Invalid URL provided'**
   String get errorInvalidURL;
 
-  /// No description provided for @errorInvalidQrcode.
+  /// No description provided for @errorInvalidQRcode.
   ///
   /// In en, this message translates to:
   /// **'Invalid QR-Code provided'**
-  String get errorInvalidQrcode;
+  String get errorInvalidQRcode;
 
   /// No description provided for @errorRouteNotFound.
   ///

packages/neon/neon/lib/l10n/localizations_en.dart

@@ -42,7 +42,7 @@ class AppLocalizationsEn extends AppLocalizations {
   String get loginWorksWith => 'works with';
 
   @override
-  String get loginUsingQrcode => 'Login using a QR code';
+  String get loginUsingQRcode => 'Login using a QR code';
 
   @override
   String get loginUsingServerAddress => 'Login using the server address';
@@ -121,7 +121,7 @@ class AppLocalizationsEn extends AppLocalizations {
   String get errorInvalidURL => 'Invalid URL provided';
 
   @override
-  String get errorInvalidQrcode => 'Invalid QR-Code provided';
+  String get errorInvalidQRcode => 'Invalid QR-Code provided';
 
   @override
   String errorRouteNotFound(String route) {

packages/neon/neon/lib/models.dart

@@ -1,4 +1,4 @@
-export 'package:neon/src/models/account.dart' hide Credentials, LoginQrcode;
+export 'package:neon/src/models/account.dart' hide Credentials, LoginQRcode;
 export 'package:neon/src/models/app_ids.dart';
 export 'package:neon/src/models/app_implementation.dart';
 export 'package:neon/src/models/notifications_interface.dart';