react-native-nitro-markdown 0.1.0

package/nitrogen/generated/shared/c++/HybridMarkdownParserSpec.cpp

@@ -0,0 +1,22 @@
+///
+/// HybridMarkdownParserSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#include "HybridMarkdownParserSpec.hpp"
+
+namespace margelo::nitro::NitroMarkdown {
+
+  void HybridMarkdownParserSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("parse", &HybridMarkdownParserSpec::parse);
+      prototype.registerHybridMethod("parseWithOptions", &HybridMarkdownParserSpec::parseWithOptions);
+    });
+  }
+
+} // namespace margelo::nitro::NitroMarkdown

package/nitrogen/generated/shared/c++/HybridMarkdownParserSpec.hpp

@@ -0,0 +1,65 @@
+///
+/// HybridMarkdownParserSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `ParserOptions` to properly resolve imports.
+namespace margelo::nitro::NitroMarkdown { struct ParserOptions; }
+
+#include <string>
+#include "ParserOptions.hpp"
+
+namespace margelo::nitro::NitroMarkdown {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `MarkdownParser`
+   * Inherit this class to create instances of `HybridMarkdownParserSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridMarkdownParser: public HybridMarkdownParserSpec {
+   * public:
+   *   HybridMarkdownParser(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridMarkdownParserSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridMarkdownParserSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridMarkdownParserSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual std::string parse(const std::string& text) = 0;
+      virtual std::string parseWithOptions(const std::string& text, const ParserOptions& options) = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "MarkdownParser";
+  };
+
+} // namespace margelo::nitro::NitroMarkdown

package/nitrogen/generated/shared/c++/ParserOptions.hpp

@@ -0,0 +1,79 @@
+///
+/// ParserOptions.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <optional>
+
+namespace margelo::nitro::NitroMarkdown {
+
+  /**
+   * A struct which can be represented as a JavaScript object (ParserOptions).
+   */
+  struct ParserOptions {
+  public:
+    std::optional<bool> gfm     SWIFT_PRIVATE;
+    std::optional<bool> math     SWIFT_PRIVATE;
+
+  public:
+    ParserOptions() = default;
+    explicit ParserOptions(std::optional<bool> gfm, std::optional<bool> math): gfm(gfm), math(math) {}
+  };
+
+} // namespace margelo::nitro::NitroMarkdown
+
+namespace margelo::nitro {
+
+  // C++ ParserOptions <> JS ParserOptions (object)
+  template <>
+  struct JSIConverter<margelo::nitro::NitroMarkdown::ParserOptions> final {
+    static inline margelo::nitro::NitroMarkdown::ParserOptions fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::NitroMarkdown::ParserOptions(
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "gfm")),
+        JSIConverter<std::optional<bool>>::fromJSI(runtime, obj.getProperty(runtime, "math"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::NitroMarkdown::ParserOptions& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "gfm", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.gfm));
+      obj.setProperty(runtime, "math", JSIConverter<std::optional<bool>>::toJSI(runtime, arg.math));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "gfm"))) return false;
+      if (!JSIConverter<std::optional<bool>>::canConvert(runtime, obj.getProperty(runtime, "math"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "react-native-nitro-markdown",
+  "version": "0.1.0",
+  "description": "High-performance Markdown parser for React Native using Nitro Modules and md4c",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index.ts",
+  "source": "src/index.ts",
+  "files": [
+    "src",
+    "lib",
+    "cpp",
+    "android",
+    "ios",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!cpp/core/*Test.cpp",
+    "!cpp/build",
+    "!scripts"
+  ],
+  "scripts": {
+    "build": "bob build",
+    "clean": "rimraf lib nitrogen/generated",
+    "codegen": "nitrogen --logLevel=\"debug\"",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "benchmark": "node ../../scripts/benchmark-comparison.js",
+    "prepack": "node -e \"require('fs').copyFileSync('../../README.md','./README.md')\"",
+    "postpack": "node -e \"const fs=require('fs');if(fs.existsSync('./README.md'))fs.unlinkSync('./README.md')\"",
+    "test:cpp": "node scripts/test-cpp.js"
+  },
+  "keywords": [
+    "react-native",
+    "markdown",
+    "md4c",
+    "nitro",
+    "jsi",
+    "native-module",
+    "gfm",
+    "parser"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JoaoPauloCMarra/react-native-nitro-markdown.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/JoaoPauloCMarra/react-native-nitro-markdown/issues"
+  },
+  "homepage": "https://github.com/JoaoPauloCMarra/react-native-nitro-markdown#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "rimraf": "^6.0.1",
+    "@types/node": "^20.0.0",
+    "jest": "^29.7.0",
+    "nitrogen": "^0.31.10",
+    "react-native-builder-bob": "^0.31.0",
+    "react-native-nitro-modules": "^0.31.10",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": ">=0.75.0",
+    "react-native-nitro-modules": ">=0.31.0"
+  },
+  "codegenConfig": {
+    "name": "NitroMarkdownSpec",
+    "type": "all",
+    "jsSrcsDir": "src"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      "typescript"
+    ]
+  }
+}

package/react-native-nitro-markdown.podspec

@@ -0,0 +1,42 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-nitro-markdown"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :git => "https://github.com/JoaoPauloCMarra/react-native-nitro-markdown.git", :tag => "#{s.version}" }
+
+  # All source files including md4c and our C++ implementation
+  s.source_files = [
+    "ios/**/*.{h,m,mm,swift}",
+    "cpp/**/*.{h,hpp,c,cpp}"
+  ]
+
+  # Ensure md4c.c is compiled as C, not C++
+  s.pod_target_xcconfig = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
+    "CLANG_CXX_LIBRARY" => "libc++",
+    "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited) MD4C_USE_UTF8=1",
+    "HEADER_SEARCH_PATHS" => [
+      "\"$(PODS_TARGET_SRCROOT)/cpp/md4c\"",
+      "\"$(PODS_TARGET_SRCROOT)/cpp/core\"",
+      "\"$(PODS_TARGET_SRCROOT)/cpp/bindings\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/shared/c++\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/ios\""
+    ].join(" ")
+  }
+
+  # React Native dependency
+  s.dependency "React-Core"
+  
+  # Add Nitro autolinking
+  load 'nitrogen/generated/ios/NitroMarkdown+autolinking.rb'
+  add_nitrogen_files(s)
+end

package/src/Markdown.nitro.ts

@@ -0,0 +1,12 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface ParserOptions {
+  gfm?: boolean;
+  math?: boolean;
+}
+
+export interface MarkdownParser
+  extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  parse(text: string): string;
+  parseWithOptions(text: string, options: ParserOptions): string;
+}

package/src/MarkdownJS.nitro.ts

@@ -0,0 +1,113 @@
+import { NitroModules } from 'react-native-nitro-modules';
+
+export interface MarkdownNode {
+  type: string;
+  content?: string;
+  level?: number;
+  href?: string;
+  title?: string;
+  alt?: string;
+  language?: string;
+  ordered?: boolean;
+  start?: number;
+  checked?: boolean;
+  isHeader?: boolean;
+  align?: string;
+  children?: MarkdownNode[];
+}
+
+export interface ParserOptions {
+  gfm?: boolean;
+  math?: boolean;
+}
+
+// Pure JavaScript implementation using JSI
+export class JSMarkdownParser {
+  private parseImpl(text: string, options: ParserOptions): MarkdownNode {
+    // Simple regex-based parser for comparison
+    // This is much slower than the C++ version but demonstrates JSI usage
+    const root: MarkdownNode = { type: 'document', children: [] };
+    const lines = text.split('\n');
+    let i = 0;
+
+    while (i < lines.length) {
+      const line = lines[i].trim();
+      if (!line) {
+        i++;
+        continue;
+      }
+
+      // Headers
+      const headerMatch = line.match(/^(#{1,6})\s+(.+)$/);
+      if (headerMatch) {
+        root.children!.push({
+          type: 'heading',
+          level: headerMatch[1].length,
+          children: [{ type: 'text', content: headerMatch[2] }]
+        });
+        i++;
+        continue;
+      }
+
+      // Bold
+      const boldMatch = line.match(/\*\*(.+?)\*\*/);
+      if (boldMatch) {
+        root.children!.push({
+          type: 'paragraph',
+          children: [{
+            type: 'bold',
+            children: [{ type: 'text', content: boldMatch[1] }]
+          }]
+        });
+        i++;
+        continue;
+      }
+
+      // Default paragraph
+      root.children!.push({
+        type: 'paragraph',
+        children: [{ type: 'text', content: line }]
+      });
+      i++;
+    }
+
+    return root;
+  }
+
+  parse(text: string, options: ParserOptions = { gfm: true, math: true }): MarkdownNode {
+    return this.parseImpl(text, options);
+  }
+}
+
+// JSI-enabled version using Nitro but with JS implementation
+export class JSINitroMarkdownParser {
+  parse(text: string, options: ParserOptions = { gfm: true, math: true }): MarkdownNode {
+    // This would use JSI to call into JavaScriptCore
+    // For now, we'll simulate it
+    const parser = new JSMarkdownParser();
+    return parser.parse(text, options);
+  }
+}
+
+// Hybrid approach: C++ for complex parsing, JS for simple cases
+export class HybridMarkdownParser {
+  private cppParser: any;
+  private jsParser: JSMarkdownParser;
+
+  constructor() {
+    // In real implementation, this would be the Nitro C++ parser
+    this.cppParser = null;
+    this.jsParser = new JSMarkdownParser();
+  }
+
+  parse(text: string, options: ParserOptions = { gfm: true, math: true }): MarkdownNode {
+    // Use C++ parser for complex cases, JS for simple
+    if (text.length > 1000 || options.gfm || options.math) {
+      // Would call C++ parser via Nitro
+      return this.jsParser.parse(text, options);
+    } else {
+      // Use JS parser for simple cases
+      return this.jsParser.parse(text, options);
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,65 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type { MarkdownParser, ParserOptions } from './Markdown.nitro';
+
+export type { ParserOptions } from './Markdown.nitro';
+
+export interface MarkdownNode {
+  type:
+    | 'document'
+    | 'heading'
+    | 'paragraph'
+    | 'text'
+    | 'bold'
+    | 'italic'
+    | 'strikethrough'
+    | 'link'
+    | 'image'
+    | 'code_inline'
+    | 'code_block'
+    | 'blockquote'
+    | 'horizontal_rule'
+    | 'line_break'
+    | 'soft_break'
+    | 'table'
+    | 'table_head'
+    | 'table_body'
+    | 'table_row'
+    | 'table_cell'
+    | 'list'
+    | 'list_item'
+    | 'task_list_item'
+    | 'math_inline'
+    | 'math_block'
+    | 'html_block'
+    | 'html_inline';
+  content?: string;
+  level?: number;
+  href?: string;
+  title?: string;
+  alt?: string;
+  language?: string;
+  ordered?: boolean;
+  start?: number;
+  checked?: boolean;
+  isHeader?: boolean;
+  align?: string;
+  children?: MarkdownNode[];
+}
+
+export const MarkdownParserModule =
+  NitroModules.createHybridObject<MarkdownParser>('MarkdownParser');
+
+export function parseMarkdown(text: string): MarkdownNode {
+  const jsonStr = MarkdownParserModule.parse(text);
+  return JSON.parse(jsonStr) as MarkdownNode;
+}
+
+export function parseMarkdownWithOptions(
+  text: string,
+  options: ParserOptions
+): MarkdownNode {
+  const jsonStr = MarkdownParserModule.parseWithOptions(text, options);
+  return JSON.parse(jsonStr) as MarkdownNode;
+}
+
+export { MarkdownParser };