Skip to content

chor/rename kotlin namespace #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
m-abs wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chor/rename kotlin namespace #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f77613
chore: kotlin namespace renamed to not have an underscore
m-abs May 27, 2026
d4cd13a
update CLAUDE.md
m-abs May 27, 2026
08dcc2f
Merge branch 'main' into chor/rename-kotlin-namespace
m-abs May 27, 2026
a6b4fd4
npm audid fix
m-abs May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"epubcfi",
"fimber",
"Fimber",
"flutterreadium",
"imgref",
"jsonable",
"kotlin",
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Key scripts (run from repo root):

### Android

- **Kotlin formatting**: after writing or editing any Kotlin file, run `ktlint --format` on it. The `standard:package-name` violation (underscores in `dk.nota.flutter_readium`) is pre-existing and cannot be auto-corrected — ignore it. All other violations must be resolved before committing.
- **Kotlin formatting**: after writing or editing any Kotlin file, run `ktlint --format` on it. All violations must be resolved before committing.
- **Android log messages**: every `PluginLog.*` call in Kotlin must start with `::functionName` (double colon, then the exact name of the enclosing function). For lambdas, use the name of the enclosing named function. Example: `Log.d(TAG, "::goBackward. Navigator not ready.")`. Single-colon or missing prefixes are bugs; wrong function names from copy-paste are also bugs.
- **Android navigator null guard**: every `suspend` function that needs the navigator must capture it as a local variable with a `?: run { }` early-return guard, then wrap direct navigator calls in `return withContext(coroutineContext) { }`. Functions that only call other wrapper functions (e.g. `evaluateJavascript`) do not need their own guard or `withContext` — delegate instead. Example:
```kotlin
Expand Down
4 changes: 2 additions & 2 deletions flutter_readium/android/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ plugins {
id 'org.jetbrains.kotlin.plugin.serialization' version '2.3.21'
}

group 'dk.nota.flutter_readium'
group 'dk.nota.flutterreadium'
version '1.0-SNAPSHOT'

rootProject.allprojects {
Expand All @@ -36,7 +36,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget

android {
if (project.android.hasProperty('namespace')) {
namespace 'dk.nota.flutter_readium'
namespace 'dk.nota.flutterreadium'
}

compileOptions {
Expand Down
2 changes: 1 addition & 1 deletion flutter_readium/android/src/main/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<manifest
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="dk.nota.flutter_readium">
package="dk.nota.flutterreadium">

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
Expand Down
2 changes: 1 addition & 1 deletion ...a/flutter_readium/ControlPanelInfoType.kt → ...ta/flutterreadium/ControlPanelInfoType.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

enum class ControlPanelInfoType {
STANDARD,
Expand Down
2 changes: 1 addition & 1 deletion .../nota/flutter_readium/CoroutineHelpers.kt → ...k/nota/flutterreadium/CoroutineHelpers.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
Expand Down
2 changes: 1 addition & 1 deletion ...lutter_readium/FlutterAudioPreferences.kt → ...flutterreadium/FlutterAudioPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import kotlinx.serialization.Serializable
import org.json.JSONObject
Expand Down
2 changes: 1 addition & 1 deletion ...r_readium/FlutterDecorationPreferences.kt → ...erreadium/FlutterDecorationPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.graphics.Color
import android.os.Parcelable
Expand Down
2 changes: 1 addition & 1 deletion ...flutter_readium/FlutterEpubPreferences.kt → .../flutterreadium/FlutterEpubPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
Expand Down
2 changes: 1 addition & 1 deletion .../flutter_readium/FlutterPdfPreferences.kt → ...a/flutterreadium/FlutterPdfPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import org.readium.adapter.pdfium.navigator.PdfiumPreferences
import org.readium.r2.navigator.preferences.Axis
Expand Down
2 changes: 1 addition & 1 deletion ...a/flutter_readium/FlutterReadiumPlugin.kt → ...ta/flutterreadium/FlutterReadiumPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.content.Context
import io.flutter.embedding.engine.plugins.FlutterPlugin
Expand Down
2 changes: 1 addition & 1 deletion .../flutter_readium/FlutterTtsPreferences.kt → ...a/flutterreadium/FlutterTtsPreferences.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import kotlinx.serialization.Serializable
import org.json.JSONObject
Expand Down
2 changes: 1 addition & 1 deletion ...ota/flutter_readium/LifecycleDelegates.kt → ...nota/flutterreadium/LifecycleDelegates.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import androidx.fragment.app.Fragment
import androidx.lifecycle.DefaultLifecycleObserver
Expand Down
4 changes: 2 additions & 2 deletions ...ota/flutter_readium/PluginMediaService.kt → ...nota/flutterreadium/PluginMediaService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

/*
* Modified version of kotlin-toolkit's example app MediaService.
Expand Down Expand Up @@ -328,7 +328,7 @@ class PluginMediaService :
}

companion object {
const val SERVICE_INTERFACE = "dk.nota.flutter_readium.MediaService"
const val SERVICE_INTERFACE = "dk.nota.flutterreadium.MediaService"

fun start(application: Application) {
val intent = intent(application)
Expand Down
2 changes: 1 addition & 1 deletion ...utter_readium/PluginMediaServiceFacade.kt → ...lutterreadium/PluginMediaServiceFacade.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* available in the top-level LICENSE file of the project.
*/

package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.app.Application
import kotlinx.coroutines.*
Expand Down
4 changes: 2 additions & 2 deletions ...ota/flutter_readium/PublicationChannel.kt → ...nota/flutterreadium/PublicationChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
@file:OptIn(ExperimentalReadiumApi::class)

package dk.nota.flutter_readium
package dk.nota.flutterreadium

import dk.nota.flutter_readium.models.TextSearchResult
import dk.nota.flutterreadium.models.TextSearchResult
import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.MethodChannel
import kotlinx.coroutines.CoroutineScope
Expand Down
2 changes: 1 addition & 1 deletion .../nota/flutter_readium/PublicationError.kt → ...k/nota/flutterreadium/PublicationError.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* available in the top-level LICENSE file of the project.
*/

package dk.nota.flutter_readium
package dk.nota.flutterreadium

import org.readium.navigator.media.audio.AudioEngine
import org.readium.navigator.media.audio.AudioNavigatorFactory
Expand Down
12 changes: 6 additions & 6 deletions ...nota/flutter_readium/ReadiumExtensions.kt → .../nota/flutterreadium/ReadiumExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
@file:OptIn(ExperimentalReadiumApi::class, ExperimentalReadiumApi::class)

package dk.nota.flutter_readium
package dk.nota.flutterreadium

import androidx.core.graphics.toColorInt
import dk.nota.flutter_readium.models.FlutterMediaOverlay
import dk.nota.flutter_readium.models.FlutterMediaOverlayItem
import dk.nota.flutter_readium.models.GuidedNavigationDocument
import dk.nota.flutter_readium.models.guidedNavigationMediaType
import dk.nota.flutter_readium.models.toMediaOverlays
import dk.nota.flutterreadium.models.FlutterMediaOverlay
import dk.nota.flutterreadium.models.FlutterMediaOverlayItem
import dk.nota.flutterreadium.models.GuidedNavigationDocument
import dk.nota.flutterreadium.models.guidedNavigationMediaType
import dk.nota.flutterreadium.models.toMediaOverlays
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.async
import kotlinx.coroutines.awaitAll
Expand Down
2 changes: 1 addition & 1 deletion ...ta/flutter_readium/ReadiumPluginLogger.kt → ...ota/flutterreadium/ReadiumPluginLogger.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.util.Log

Expand Down
32 changes: 16 additions & 16 deletions .../dk/nota/flutter_readium/ReadiumReader.kt → ...n/dk/nota/flutterreadium/ReadiumReader.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.app.Activity
import android.app.Application
Expand All @@ -8,20 +8,20 @@ import android.view.ViewGroup
import androidx.fragment.app.FragmentManager
import androidx.savedstate.SavedStateRegistry
import androidx.savedstate.SavedStateRegistryOwner
import dk.nota.flutter_readium.events.ReadiumError
import dk.nota.flutter_readium.events.ReadiumErrorEventChannel
import dk.nota.flutter_readium.events.ReadiumReaderStatus
import dk.nota.flutter_readium.events.ReadiumReaderStatusEventChannel
import dk.nota.flutter_readium.events.TextLocatorEventChannel
import dk.nota.flutter_readium.events.TimedBasedStateEventChannel
import dk.nota.flutter_readium.models.ReadiumTimebasedState
import dk.nota.flutter_readium.navigators.AudiobookNavigator
import dk.nota.flutter_readium.navigators.EpubNavigator
import dk.nota.flutter_readium.navigators.FlutterVisualNavigator
import dk.nota.flutter_readium.navigators.PdfNavigator
import dk.nota.flutter_readium.navigators.SyncAudiobookNavigator
import dk.nota.flutter_readium.navigators.TTSNavigator
import dk.nota.flutter_readium.navigators.TimebasedNavigator
import dk.nota.flutterreadium.events.ReadiumError
import dk.nota.flutterreadium.events.ReadiumErrorEventChannel
import dk.nota.flutterreadium.events.ReadiumReaderStatus
import dk.nota.flutterreadium.events.ReadiumReaderStatusEventChannel
import dk.nota.flutterreadium.events.TextLocatorEventChannel
import dk.nota.flutterreadium.events.TimedBasedStateEventChannel
import dk.nota.flutterreadium.models.ReadiumTimebasedState
import dk.nota.flutterreadium.navigators.AudiobookNavigator
import dk.nota.flutterreadium.navigators.EpubNavigator
import dk.nota.flutterreadium.navigators.FlutterVisualNavigator
import dk.nota.flutterreadium.navigators.PdfNavigator
import dk.nota.flutterreadium.navigators.SyncAudiobookNavigator
import dk.nota.flutterreadium.navigators.TTSNavigator
import dk.nota.flutterreadium.navigators.TimebasedNavigator
import io.flutter.plugin.common.BinaryMessenger
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
Expand Down Expand Up @@ -74,7 +74,7 @@ import kotlin.time.Duration

private const val TAG = "ReadiumReader"

private const val stateKey = "dk.nota.flutter_readium.ReadiumReaderState"
private const val stateKey = "dk.nota.flutterreadium.ReadiumReaderState"

private const val currentPublicationUrlKey = "currentPublicationUrl"
private const val ttsEnabledKey = "ttsEnabled"
Expand Down
2 changes: 1 addition & 1 deletion ...a/flutter_readium/ReadiumReaderChannel.kt → ...ta/flutterreadium/ReadiumReaderChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import io.flutter.plugin.common.BinaryMessenger
import io.flutter.plugin.common.MethodChannel
Expand Down
2 changes: 1 addition & 1 deletion ...utter_readium/ReadiumReaderViewFactory.kt → ...lutterreadium/ReadiumReaderViewFactory.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.content.Context
import io.flutter.plugin.common.BinaryMessenger
Expand Down
14 changes: 7 additions & 7 deletions ...ta/flutter_readium/ReadiumReaderWidget.kt → ...ota/flutterreadium/ReadiumReaderWidget.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.content.Context
import android.content.ContextWrapper
Expand All @@ -10,12 +10,12 @@ import android.widget.LinearLayout
import android.widget.LinearLayout.generateViewId
import androidx.fragment.app.FragmentActivity
import androidx.fragment.app.commitNow
import dk.nota.flutter_readium.events.ReadiumError
import dk.nota.flutter_readium.events.ReadiumReaderStatus
import dk.nota.flutter_readium.fragments.EpubReaderFragment
import dk.nota.flutter_readium.fragments.PdfReaderFragment
import dk.nota.flutter_readium.models.PageInformation
import dk.nota.flutter_readium.navigators.EpubNavigator
import dk.nota.flutterreadium.events.ReadiumError
import dk.nota.flutterreadium.events.ReadiumReaderStatus
import dk.nota.flutterreadium.fragments.EpubReaderFragment
import dk.nota.flutterreadium.fragments.PdfReaderFragment
import dk.nota.flutterreadium.models.PageInformation
import dk.nota.flutterreadium.navigators.EpubNavigator
import io.flutter.plugin.common.BinaryMessenger
import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.MethodChannel
Expand Down
2 changes: 1 addition & 1 deletion .../flutter_readium/SelectionActionConfig.kt → ...a/flutterreadium/SelectionActionConfig.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

/**
* Represents a configured selection action from Dart.
Expand Down
2 changes: 1 addition & 1 deletion ...n/kotlin/dk/nota/flutter_readium/Utils.kt → ...in/kotlin/dk/nota/flutterreadium/Utils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium
package dk.nota.flutterreadium

import android.app.Activity
import android.app.Application
Expand Down
2 changes: 1 addition & 1 deletion ...ter_readium/events/EventChannelWrapper.kt → ...tterreadium/events/EventChannelWrapper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium.events
package dk.nota.flutterreadium.events

import io.flutter.plugin.common.BinaryMessenger
import io.flutter.plugin.common.EventChannel
Expand Down
6 changes: 3 additions & 3 deletions ...eadium/events/ReadiumErrorEventChannel.kt → ...eadium/events/ReadiumErrorEventChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package dk.nota.flutter_readium.events
package dk.nota.flutterreadium.events

import dk.nota.flutter_readium.PluginLog
import dk.nota.flutter_readium.PublicationError
import dk.nota.flutterreadium.PluginLog
import dk.nota.flutterreadium.PublicationError
import io.flutter.plugin.common.BinaryMessenger
import kotlinx.coroutines.launch
import kotlinx.serialization.Serializable
Expand Down
4 changes: 2 additions & 2 deletions ...events/ReadiumReaderStatusEventChannel.kt → ...events/ReadiumReaderStatusEventChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package dk.nota.flutter_readium.events
package dk.nota.flutterreadium.events

import dk.nota.flutter_readium.PluginLog
import dk.nota.flutterreadium.PluginLog
import io.flutter.plugin.common.BinaryMessenger
import kotlinx.coroutines.launch
import kotlinx.serialization.SerialName
Expand Down
2 changes: 1 addition & 1 deletion ...readium/events/TextLocatorEventChannel.kt → ...readium/events/TextLocatorEventChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium.events
package dk.nota.flutterreadium.events

import io.flutter.plugin.common.BinaryMessenger
import kotlinx.coroutines.launch
Expand Down
6 changes: 3 additions & 3 deletions ...ium/events/TimedBasedStateEventChannel.kt → ...ium/events/TimedBasedStateEventChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package dk.nota.flutter_readium.events
package dk.nota.flutterreadium.events

import dk.nota.flutter_readium.jsonEncode
import dk.nota.flutter_readium.models.ReadiumTimebasedState
import dk.nota.flutterreadium.jsonEncode
import dk.nota.flutterreadium.models.ReadiumTimebasedState
import io.flutter.plugin.common.BinaryMessenger
import kotlinx.coroutines.launch

Expand Down
6 changes: 3 additions & 3 deletions ...r_readium/fragments/BaseReaderFragment.kt → ...erreadium/fragments/BaseReaderFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package dk.nota.flutter_readium.fragments
package dk.nota.flutterreadium.fragments

import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import dk.nota.flutter_readium.models.ReaderViewModel
import dk.nota.flutter_readium.PluginLog
import dk.nota.flutterreadium.models.ReaderViewModel
import dk.nota.flutterreadium.PluginLog
import org.readium.r2.navigator.Navigator
import org.readium.r2.shared.publication.Locator

Expand Down
20 changes: 10 additions & 10 deletions ...r_readium/fragments/EpubReaderFragment.kt → ...erreadium/fragments/EpubReaderFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dk.nota.flutter_readium.fragments
package dk.nota.flutterreadium.fragments

import android.os.Bundle
import android.view.ActionMode
Expand All @@ -7,15 +7,15 @@ import android.view.MenuItem
import android.view.View
import androidx.fragment.app.commitNow
import androidx.lifecycle.lifecycleScope
import dk.nota.flutter_readium.FlutterEpubPreferences
import dk.nota.flutter_readium.PluginLog
import dk.nota.flutter_readium.R
import dk.nota.flutter_readium.ReadiumReader
import dk.nota.flutter_readium.isFixed
import dk.nota.flutter_readium.models.EpubReaderViewModel
import dk.nota.flutter_readium.models.ViewPortSize
import dk.nota.flutter_readium.progression
import dk.nota.flutter_readium.withMainContext
import dk.nota.flutterreadium.FlutterEpubPreferences
import dk.nota.flutterreadium.PluginLog
import dk.nota.flutterreadium.R
import dk.nota.flutterreadium.ReadiumReader
import dk.nota.flutterreadium.isFixed
import dk.nota.flutterreadium.models.EpubReaderViewModel
import dk.nota.flutterreadium.models.ViewPortSize
import dk.nota.flutterreadium.progression
import dk.nota.flutterreadium.withMainContext
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.launch
Expand Down
10 changes: 5 additions & 5 deletions ...er_readium/fragments/PdfReaderFragment.kt → ...terreadium/fragments/PdfReaderFragment.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package dk.nota.flutter_readium.fragments
package dk.nota.flutterreadium.fragments

import android.os.Bundle
import android.util.Log
import android.view.View
import androidx.fragment.app.commitNow
import androidx.lifecycle.lifecycleScope
import dk.nota.flutter_readium.R
import dk.nota.flutter_readium.ReadiumReader
import dk.nota.flutter_readium.models.PdfReaderViewModel
import dk.nota.flutterreadium.R
import dk.nota.flutterreadium.ReadiumReader
import dk.nota.flutterreadium.models.PdfReaderViewModel
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.MainScope
Expand Down Expand Up @@ -66,7 +66,7 @@ class PdfReaderFragment :

/**
* Synchronous wrappers around the navigator's `go*` methods so the
* surrounding [dk.nota.flutter_readium.navigators.PdfNavigator] can await
* surrounding [dk.nota.flutterreadium.navigators.PdfNavigator] can await
* fragment-startup before calling.
*/
fun goBackward(animated: Boolean): Boolean {
Expand Down
Loading