nitro.json

Nitro Modules configuration file. Documentation: https://margelo.nitro.com

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/nitro-json/latest.json
Source https://nitro.margelo.com/nitro.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

cxxNamespace string[] required

Represents the C++ namespace of the module that will be generated. This can have multiple sub-namespaces, and is always relative to margelo::nitro.

minItems=1
ios object required

Required: iOS configuration

1 nested properties
iosModuleName string required

Represents the iOS module name of the module that will be generated This will be used to generate Swift bridges, as those are always namespaced within the clang module. If you are using CocoaPods, this should be the Pod name defined in the .podspec.

minLength=1
android object required

Required: Android configuration

2 nested properties
androidNamespace string[] required

Represents the Android namespace ('package') of the module that will be generated. This can have multiple sub-namespaces, and is always relative to com.margelo.nitro.

minItems=1
androidCxxLibName string required

Represents the name of the Android C++ library (aka name in CMakeLists.txt add_library(..)). This will be loaded via System.loadLibrary(...).

minLength=1
autolinking object required

Configures the code that gets generated for autolinking (registering) Hybrid Object constructors.

ignorePaths string[]

A list of paths relative to the project directory that should be ignored by nitrogen. Nitrogen will not look for .nitro.ts files in these directories.

gitAttributesGeneratedFlag boolean

Configures whether all nitro-generated files should be marked as linguist-generated for GitHub. This excludes generated files from diffing and language statistics.

Default: true