react-native-marcus 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,227 @@
+![react-native-marcus](./assets/hero-animation.gif)
+
+# react-native-marcus
+
+Marcus is a rich text markdown editor. It is a fork or [Expensify/react-native-live-markdown](https://github.com/Expensify/react-native-live-markdown) that's a bit more a bit more ambitious.
+
+Marcus takes a different approach to editing markdown: formatting is rendered live on every keystroke and syntax is highlighted but not removed. This way you get instant visual feedback and a good idea what rendered markdown will look like without losing the ability to easily edit the source.
+
+## Features
+
+- ⚛️ Drop-in replacement for `<TextInput>` component
+- ⌨️ Live synchronous formatting on every keystroke
+- ⚡ Fully native experience (selection, spellcheck, autocomplete)
+- 🔧 Customizable logic
+- 🎨 Customizable styles
+- 🌐 Universal support (Android, iOS, web)
+- 🏗️ Supports only the New Architecture
+
+## Differences from Expensify/react-native-live-markdown
+
+- Native side written mostly in Swift and Kotlin as opposed to Objective-C++ and Java
+- Uses established and maintained [micromark](https://github.com/micromark/micromark) parser
+- At least twice as fast; on small inputs and slow devices up to 8X faster
+- Fully CommonMark and GFM compliant
+
+## Installation
+
+First, install the library from npm:
+
+```sh
+npm install react-native-marcus react-native-worklets
+```
+
+Or if using expo:
+
+```sh
+npx expo install react-native-marcus react-native-worklets
+```
+
+> [!IMPORTANT]
+> Please follow the `react-native-worklets` [Getting Started](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/getting-started/#react-native-community-cli) guide to avoid issues.
+
+Then, install the iOS dependencies with CocoaPods:
+
+```sh
+npx pod-install
+```
+
+The library includes native code so you will need to re-build the native app.
+
+> [!NOTE]
+> The library does not support Expo Go, you will need to setup Expo Dev Client (see [here](https://docs.expo.dev/workflow/prebuild/)).
+
+## Usage
+
+```tsx
+import { useState } from "react"
+import { MarkdownTextInput, parseMicroMark } from "react-native-marcus"
+
+export default function App() {
+  const [text, setText] = useState("Hello, **world**!")
+
+  return <MarkdownTextInput value={text} onChangeText={setText} parser={parseMicroMark} />
+}
+```
+
+## Styling
+
+`MarkdownTextInput` can be styled using `style` prop just like regular `TextInput` component.
+
+It is also possible to customize the styling of the formatted contents of `MarkdownTextInput` component. The style object supports all color representations from React Native including `PlatformColor` and `DynamicColorIOS` according to the [color reference](https://reactnative.dev/docs/colors). Currently, a limited set of styles is customizable but this is subject to change in the future.
+
+```tsx
+import type { MarkdownStyle } from "react-native-marcus"
+
+const FONT_FAMILY_MONOSPACE = Platform.select({
+  ios: "Courier",
+  default: "monospace",
+})
+
+const FONT_FAMILY_EMOJI = Platform.select({
+  ios: "System",
+  android: "Noto Color Emoji",
+  default: "System, Apple Color Emoji, Segoe UI Emoji, Noto Color Emoji",
+})
+
+const markdownStyle: MarkdownStyle = {
+  syntax: {
+    color: "gray",
+  },
+  link: {
+    color: "blue",
+  },
+  h1: {
+    fontSize: 25,
+  },
+  emoji: {
+    fontSize: 20,
+    fontFamily: FONT_FAMILY_EMOJI,
+  },
+  blockquote: {
+    borderColor: "gray",
+    borderWidth: 6,
+    marginLeft: 6,
+    paddingLeft: 6,
+  },
+  code: {
+    fontFamily: FONT_FAMILY_MONOSPACE,
+    fontSize: 20,
+    color: "black",
+    backgroundColor: "lightgray",
+  },
+  pre: {
+    fontFamily: FONT_FAMILY_MONOSPACE,
+    fontSize: 20,
+    color: "black",
+    backgroundColor: "lightgray",
+  },
+  mentionHere: {
+    color: "green",
+    backgroundColor: "lime",
+  },
+  mentionUser: {
+    color: "blue",
+    backgroundColor: "cyan",
+  },
+}
+```
+
+The style object can be passed to multiple `MarkdownTextInput` components using `markdownStyle` prop:
+
+```tsx
+<MarkdownTextInput
+  value={text}
+  onChangeText={setText}
+  style={styles.input}
+  markdownStyle={markdownStyle}
+/>
+```
+
+> [!TIP]
+> We recommend to store the style object outside of a component body or memoize the style object with `React.useMemo`.
+
+## Parsing logic
+
+`MarkdownTextInput` behavior can be customized via `parser` property. Parser is a function that accepts a plaintext string and returns an array of `MarkdownRange` objects:
+
+```ts
+interface MarkdownRange {
+  type: MarkdownType
+  start: number
+  length: number
+}
+```
+
+Currently, only the following types are supported:
+
+```ts
+type MarkdownType =
+  | "bold"
+  | "italic"
+  | "strikethrough"
+  | "emoji"
+  | "mention"
+  | "link"
+  | "code"
+  | "pre"
+  | "blockquote"
+  | "h1"
+  | "syntax"
+```
+
+Parser needs to be marked as a [worklet](https://docs.swmansion.com/react-native-worklets/docs/fundamentals/glossary#worklet) because it's executed on the UI thread as the user types.
+
+Here's a sample function that parses all substrings located between two asterisks as italic text:
+
+```ts
+function parser(input: string) {
+  "worklet"
+
+  const ranges = []
+  const regexp = /\*(.*?)\*/g
+  let match
+  while ((match = regexp.exec(input)) !== null) {
+    ranges.push({ start: match.index, length: 1, type: "syntax" })
+    ranges.push({ start: match.index + 1, length: match[1]!.length, type: "emphasis" })
+    ranges.push({ start: match.index + 1 + match[1]!.length, length: 1, type: "syntax" })
+  }
+  return ranges
+}
+```
+
+> [!TIP]
+> We recommend to store the parser function outside of a component body or memoize the parser function with `React.useMemo`.
+
+## Markdown flavors support
+
+Currently, `react-native-marcus` supports only [CommonMark](https://spec.commonmark.org/0.31.2/) flavor with [GFM (Github Flavored Markdown)](https://github.github.com/gfm/) extensions out-of-the-box. You can customize the behavior by passing a custom parser worklet function via the `parser` prop, as detailed in the [Parsing logic](#parsing-logic) section.
+
+## API reference
+
+`MarkdownTextInput` inherits all props of React Native's `TextInput` component as well as introduces the following properties:
+
+| Prop            | Type                                 | Default     | Note                                                                                                                                                   |
+| --------------- | ------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `parser`        | `(value: string) => MarkdownRange[]` | `undefined` | A function that parses the current value and returns an array of ranges.                                                                               |
+| `markdownStyle` | `MarkdownStyle`                      | `undefined` | Adds custom styling to Markdown text. The provided value is merged with default style object. See [Styling](./README.md#styling) for more information. |
+
+## Compatibility
+
+`react-native-marcus` supports only latest React Native minor releases with the New Architecture enabled.
+
+### React Native compatibility
+
+|        | 0.81 | 0.82 | 0.83 | 0.84 | 0.85 | 0.86 |
+| :----: | :--: | :--: | :--: | :--: | :--: | :--: |
+| 0.0.1+ |  ✅  |  ✅  |  ✅  |  ✅  |  ✅  |  ✅  |
+
+### `react-native-worklets` compatibility
+
+|        | 0.6.x | 0.7.x | 0.8.x | 0.9.x | 0.10.2+ |
+| :----: | :---: | :---: | :---: | :---: | :-----: |
+| 0.0.1+ |  ❌   |  ✅   |  ✅   |  ✅   |   ✅    |
+
+## License
+
+Apache-2.0

package/RNMarcus.podspec

@@ -0,0 +1,78 @@
+require "json"
+
+react_native_node_modules_dir = ENV['REACT_NATIVE_NODE_MODULES_DIR'] || File.join(File.dirname(`cd "#{Pod::Config.instance.installation_root.to_s}" && node --print "require.resolve('react-native/package.json')"`), '..')
+react_native_json = JSON.parse(File.read(File.join(react_native_node_modules_dir, 'react-native/package.json')))
+react_native_minor_version = react_native_json['version'].split('.')[1].to_i
+
+pods_root = Pod::Config.instance.project_pods_root
+react_native_worklets_node_modules_dir = ENV['REACT_NATIVE_WORKLETS_NODE_MODULES_DIR'] ||
+ File.dirname(`cd "#{Pod::Config.instance.installation_root.to_s}" && node --print "require.resolve('react-native-worklets/package.json')"`)
+react_native_worklets_node_modules_dir_from_pods_root = Pathname.new(react_native_worklets_node_modules_dir).relative_path_from(pods_root).to_s
+
+react_native_react_common_dir = File.join(react_native_node_modules_dir, 'react-native/ReactCommon')
+react_native_react_common_dir_from_pods_root = Pathname.new(react_native_react_common_dir).relative_path_from(pods_root).to_s
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "RNMarcus"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "16.0", :visionos => "1.0" }
+  s.source       = { :git => "https://github.com/getbullet-app/react-native-marcus.git", :tag => "#{s.version}" }
+
+  s.source_files = "apple/**/*.{h,m,mm,cpp,swift}", "cpp/**/*.{h,cpp}"
+
+  s.swift_version = "5.9"
+
+  # Headers that pull in C++ (Fabric, JSI, or the standard library). Swift's
+  # importer parses headers in Objective-C mode, so anything reachable from the
+  # generated umbrella must be parseable as plain Objective-C. Marking these
+  # private keeps them out of the umbrella while leaving them importable from
+  # the .mm/.cpp sources that actually need them.
+  s.private_header_files = [
+    "apple/MarcusModule.h",
+    "apple/MarkdownSwiftInterop.h",
+    "apple/MarcusTextInputDecoratorComponentView.h",
+    "apple/MarcusTextInputDecoratorShadowNode.h",
+    "apple/RCTMarcusStyle+Codegen.h",
+    "apple/RCTTextInputComponentView+Marcus.h",
+    "cpp/MarkdownGlobal.h",
+    "cpp/MarkdownWorkletParser.h",
+    "cpp/RuntimeDecorator.h",
+    "cpp/react/renderer/components/RNMarcusSpec/*.h",
+  ]
+
+  s.dependency "RNWorklets"
+
+  s.xcconfig = {
+    "OTHER_CFLAGS" => "$(inherited) -DREACT_NATIVE_MINOR_VERSION=#{react_native_minor_version}",
+    "HEADER_SEARCH_PATHS" => [
+      "\"$(PODS_ROOT)/#{react_native_worklets_node_modules_dir_from_pods_root}/apple\"",
+      "\"$(PODS_ROOT)/#{react_native_worklets_node_modules_dir_from_pods_root}/Common/cpp\"",
+      "\"$(PODS_ROOT)/#{react_native_react_common_dir_from_pods_root}\"",
+    ].join(' '),
+  }
+
+  s.pod_target_xcconfig = {
+    "HEADER_SEARCH_PATHS" => "\"$(PODS_TARGET_SRCROOT)/cpp\"",
+    # Lets the Swift parser call into the pure-C++ worklet parser directly.
+    "OTHER_SWIFT_FLAGS" => "$(inherited) -cxx-interoperability-mode=default -Xcc -std=c++20 " +
+      "-Xcc -fmodule-map-file=\"$(PODS_TARGET_SRCROOT)/cpp/MarkdownCxx.modulemap\"",
+  }
+
+  install_modules_dependencies(s)
+
+  if ENV['USE_FRAMEWORKS'] != nil
+    add_dependency(s, "React-FabricComponents", :additional_framework_paths => [
+      "react/renderer/textlayoutmanager/platform/ios",
+      "react/renderer/components/textinput/platform/ios",
+    ])
+    add_dependency(s, "React-rendererconsistency")
+  end
+end