Skip to content

Generated Files and Integration

s edited this page Aug 1, 2026 · 3 revisions

Files the Generator Creates

Files you can edit

Backend Edit this
Kotlin/Java android/src/main/java/<namespace-path>/
JNI android/src/main/cpp/
JSI android/src/main/cpp/

These paths are relative to the generated package below local_modules/. Update preserves them, except for generated packages below the Kotlin/Java source root. Remove deletes the complete module, including these files.

Package layout

your-plugin/
├── package.json
├── android/
└── local_modules/
    └── your-module/
        ├── .supernote-module.json
        ├── README.md
        ├── package.json
        ├── index.js
        ├── index.d.ts
        ├── react-native.config.js
        └── android/

The generator adds a file: dependency to your plugin's package.json. React Native autolinking discovers the package through its generated metadata.

What differs by backend

  • Native: generated annotation processing, bridge, and registration expose marked Kotlin/Java methods through a Promise-based module.
  • JNI: generated bindings convert supported values, register native methods, load the library, and expose a Promise-based module.
  • JSI: generated HostFunctions, Kotlin loading, and native installation expose marked C++ functions synchronously.

Files Update may replace

Update may replace:

  • package files, JavaScript wrappers, TypeScript declarations, and the generated README;
  • React Native autolinking metadata;
  • Android build, manifest, bridge, binding, loading, and registration files;
  • generated annotation and processor files for Kotlin/Java modules;
  • the managed registration block in your plugin's Android settings.

Do not customize those files unless you are prepared to restore the changes after Update. Keep project notes outside the generated README because Update replaces it.

How Update tracks files

The generator uses .supernote-module.json to remember the module type and which files Update may replace. Do not edit it manually.

See Managing Modules before running Update or Remove.

Clone this wiki locally