capacitor-sora-editor 0.0.1

package/README.md

@@ -0,0 +1,110 @@
+# Capacitor Sora Editor Plugin
+
+A powerful, high-performance code editor for Capacitor Android applications, built with [Sora Editor](https://github.com/Rosemoe/sora-editor) and **Jetpack Compose**. 
+
+This plugin provides a full-featured native code editor experience within your hybrid app, significantly outperforming web-based editors (like Monaco or CodeMirror in a WebView) on mobile devices, especially for large files.
+
+## 🚀 Features
+
+*   **High Performance**: Native rendering ensures smooth typing and scrolling, even for large files (thousands of lines).
+*   **Jetpack Compose UI**: Modern, clean, and customizable Material Design 3 interface.
+*   **Rich Editing Tools**:
+    *   Undo / Redo
+    *   Search & Replace (with Regex support)
+    *   Go to Line
+    *   Real-time Line & Column counters
+*   **Productivity Features**:
+    *   **Table of Contents (TOC)**: Automatically generates a TOC based on content (chapters or line chunks).
+    *   **Symbol Bar**: Quick access to common programming symbols above the keyboard.
+    *   **Read-Only Mode**: Toggle between browsing and editing.
+    *   **Auto-Save**: Securely saves changes to the local filesystem.
+    *   **Smart Renaming**: Automatically detects "new" files and proposes a rename based on the first line of text upon exit.
+*   **Customization**:
+    *   Toggle Line Numbers
+    *   Toggle Word Wrap
+    *   Adjust Font Size
+    *   System Dark/Light Theme support
+    *   Customizable colors for background, UI, etc.
+
+## 🛠 Tech Stack & Requirements
+
+*   **Capacitor**: ^6.0.0
+*   **Android**:
+    *   `minSdkVersion`: 22+
+    *   `compileSdkVersion`: 34+
+    *   Kotlin: 1.9.0+
+    *   Jetpack Compose enabled
+*   **Sora Editor**: 0.24.4
+
+## 📦 Installation
+
+```bash
+npm install capacitor-sora-editor
+npx cap sync
+```
+
+## 🔧 Android Configuration
+
+Since this plugin allows file editing, you generally deal with local files. Ensure your app asks for necessary storage permissions if accessing files outside your app's sandbox.
+
+No special initialization is required in `MainActivity.java` for Capacitor 3+ as plugins are auto-detected.
+
+However, ensure your `variables.gradle` or project `build.gradle` meets the minimum Kotlin and SDK versions.
+
+## 📖 Usage
+
+### 1. Import the Plugin
+
+```typescript
+import { SoraEditor } from 'capacitor-sora-editor';
+```
+
+### 2. Open the Editor
+
+The plugin works by launching a native Android Activity on top of your current WebView. You trigger it by passing the absolute URI of the file you want to edit.
+
+```typescript
+const openNativeEditor = async () => {
+  try {
+    // You need a valid "file://" URI to a local file.
+    // Use @capacitor/filesystem to get the URI if needed.
+    const fileUri = "file:///data/user/0/com.your.app/files/Documents/my_script.js";
+    
+    await SoraEditor.openEditor({ 
+        filePath: fileUri 
+    });
+    
+    console.log("Editor closed");
+    // You might want to reload the file content in your web app here
+    // as the native editor has modified it.
+  } catch (error) {
+    console.error("Failed to open editor", error);
+  }
+};
+```
+
+### 3. File Handling & Lifecycle
+
+*   **Opening**: When `openEditor` is called, the Native Activity starts. The implementation reads the file from the disk directly.
+*   **Saving**: The editor handles saving internally. It auto-saves on typing (debounced) and performs a final save/rename check when the user exits (presses Back).
+*   **Return**: When the user presses the Back button in the Native UI, the Activity finishes, and the Promise returned by `openEditor` resolves. Development flow usually involves reloading the file content in your JS layer after the promise resolves.
+
+## 🎨 UI & Customization
+
+The editor includes a built-in "Settings" screen (accessible via the "More" menu in the top-right corner) where the user can configure:
+
+*   Font Size
+*   Theme Colors
+*   Line Numbers / Word Wrap
+*   Auto-save behavior
+
+These settings are persisted natively in `SharedPreferences` by the plugin.
+
+## ⚠️ Notes
+
+*   **Android Only**: This plugin currently implements the native editor **only for Android**. Calling it on iOS or Web will print a warning and do nothing (or throw an error based on configuration).
+*   **Context**: This was extracted from a personal note-taking app "Squircle CE", designed for high-performance offline text editing.
+
+## 📄 License
+
+MIT

package/android/build.gradle

@@ -0,0 +1,77 @@
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.2.1'
+        classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.22'
+        classpath 'org.jetbrains.kotlin:compose-compiler-gradle-plugin:2.0.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'org.jetbrains.kotlin.plugin.compose'
+
+android {
+    namespace "com.github.soraeditor.capacitor"
+    compileSdk 34
+
+    defaultConfig {
+        minSdkVersion 22
+        targetSdkVersion 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles "consumer-rules.pro"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+    kotlinOptions {
+        jvmTarget = '21'
+    }
+    buildFeatures {
+        compose true
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "androidx.core:core-ktx:1.12.0"
+    
+    // Sora Editor
+    implementation 'io.github.Rosemoe.sora-editor:editor:0.24.4'
+    implementation 'io.github.Rosemoe.sora-editor:language-textmate:0.24.4'
+
+    // Jetpack Compose
+    def composeBom = platform('androidx.compose:compose-bom:2024.02.00')
+    implementation composeBom
+    implementation 'androidx.compose.ui:ui'
+    implementation 'androidx.compose.material3:material3'
+    implementation 'androidx.compose.material:material-icons-extended'
+    implementation 'androidx.activity:activity-compose:1.8.2'
+    implementation 'androidx.compose.ui:ui-tooling-preview'
+    implementation 'androidx.lifecycle:lifecycle-viewmodel-compose:2.7.0'
+    implementation 'androidx.lifecycle:lifecycle-runtime-compose:2.7.0'
+    
+    testImplementation "junit:junit:4.13.2"
+    androidTestImplementation "androidx.test.ext:junit:1.1.5"
+    androidTestImplementation "androidx.test.espresso:espresso-core:3.5.1"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,13 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.github.soraeditor.capacitor">
+
+    <!-- Permissions can be added here if needed, e.g. READ_EXTERNAL_STORAGE -->
+
+    <application>
+        <activity
+            android:name=".EditorActivity"
+            android:theme="@style/Theme.AppCompat.NoActionBar"
+            android:exported="true">
+        </activity>
+    </application>
+</manifest>

package/android/src/main/java/com/github/soraeditor/capacitor/EditorActivity.kt

@@ -0,0 +1,54 @@
+package com.github.soraeditor.capacitor
+
+import android.os.Bundle
+import androidx.activity.ComponentActivity
+import androidx.activity.compose.setContent
+import androidx.activity.viewModels
+import androidx.compose.foundation.layout.*
+import androidx.compose.material3.*
+import androidx.compose.runtime.*
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalContext
+import com.github.soraeditor.capacitor.ui.EditorScreen
+import com.github.soraeditor.capacitor.ui.theme.NotesTheme
+
+class EditorActivity : ComponentActivity() {
+    private val viewModel: EditorViewModel by viewModels()
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        
+        // Get file path from intent
+        val filePath = intent.getStringExtra("FILE_PATH") ?: ""
+        android.util.Log.d("EditorActivity", "onCreate with filePath: $filePath")
+        
+        if (filePath.isNotEmpty()) {
+            viewModel.loadFile(this, filePath)
+        } else {
+            android.util.Log.e("EditorActivity", "No file path provided")
+        }
+
+        setContent {
+            val uiState by viewModel.uiState.collectAsState()
+            
+            NotesTheme(darkTheme = uiState.isDarkTheme) {
+                Surface(
+                    modifier = Modifier.fillMaxSize(),
+                    color = MaterialTheme.colorScheme.background
+                ) {
+                    EditorScreen(
+                        uiState = uiState,
+                        viewModel = viewModel,
+                        onBack = { finish() }
+                    )
+                }
+            }
+        }
+    }
+
+    override fun onPause() {
+        super.onPause()
+        // Auto-save logic is handled inside saveOnExit, including rename check on exit
+        viewModel.saveOnExit(this)
+    }
+}