react-native-nitro-xlsx 0.1.4 → 0.2.6

package/src/index.ts

@@ -1,21 +1,117 @@
 import { NitroModules } from 'react-native-nitro-modules'
-import type { NitroXlsx as NitroXlsxSpec, XlsxWorkbook as XlsxWorkbookSpec } from './specs/NitroXlsx.nitro'
+import type {
+  NitroXlsx as NitroXlsxSpec
+} from './specs/NitroXlsx.nitro'
 
-const NitroXlsxBridge = NitroModules.createHybridObject<NitroXlsxSpec>('NitroXlsx')
+export const NitroXlsx = NitroModules.createHybridObject<NitroXlsxSpec>('NitroXlsx')
 
-type JsonRecord = Record<string, string | number>
+export type {
+  XlsxWorkbook,
+  XlsxWorksheet,
+  XlsxCellFormat,
+  XlsxConditionalFormat,
+  XlsxConditionalFormats,
+  CellType,
+} from './specs/NitroXlsx.nitro'
 
-export const NitroXlsx = Object.assign(NitroXlsxBridge, {
-  fromJSON(data: JsonRecord[]): XlsxWorkbookSpec {
-    return NitroXlsxBridge.fromJSON(JSON.stringify(data))
-  },
-})
+/**
+ * Error codes emitted by the native layer.
+ * Native errors arrive as `Error` with message `methodName: CODE: detail`.
+ */
+export const XlsxErrorCode = {
+  INVALID_ARGUMENT: 'INVALID_ARGUMENT',
+  SHEET_NOT_FOUND: 'SHEET_NOT_FOUND',
+  SHEET_EXISTS: 'SHEET_EXISTS',
+  INDEX_OUT_OF_RANGE: 'INDEX_OUT_OF_RANGE',
+  CELL_NOT_FOUND: 'CELL_NOT_FOUND',
+  WORKBOOK_CLOSED: 'WORKBOOK_CLOSED',
+  IO_ERROR: 'IO_ERROR',
+  UNSUPPORTED: 'UNSUPPORTED',
+  XLSX_ERROR: 'XLSX_ERROR',
+  INTERNAL_ERROR: 'INTERNAL_ERROR',
+} as const
+
+export type XlsxErrorCode = (typeof XlsxErrorCode)[keyof typeof XlsxErrorCode]
+
+/**
+ * Structured XLSX error. Use `XlsxError.from(caught)` to convert a native throw.
+ */
+export class XlsxError extends Error {
+  readonly code: XlsxErrorCode | string
 
-export function toJSON(workbook: XlsxWorkbookSpec, keys?: string[]): JsonRecord[] {
-  return JSON.parse(workbook.toJSON(keys))
+  constructor(code: XlsxErrorCode | string, message: string) {
+    super(`[${code}] ${message}`)
+    this.name = 'XlsxError'
+    this.code = code
+  }
+
+  /**
+   * Convert an error thrown by the native module into an XlsxError.
+   * Non-XLSX errors are wrapped with code INTERNAL_ERROR.
+   */
+  static from(error: unknown): XlsxError {
+    if (error instanceof XlsxError) return error
+    const message = error instanceof Error ? error.message : String(error)
+    // Nitro prefixes "methodName: " then our "CODE: detail"
+    const match = message.match(/(?:^|:\s*)([A-Z_]+):\s*(.*)$/)
+    if (match && match[1] && (Object.values(XlsxErrorCode) as string[]).includes(match[1])) {
+      return new XlsxError(match[1], match[2] ?? '')
+    }
+    return new XlsxError(XlsxErrorCode.INTERNAL_ERROR, message)
+  }
 }
 
-export type { XlsxWorkbook, XlsxWorksheet, XlsxCellFormat } from './specs/NitroXlsx.nitro'
+// Conditional formatting rule types (OpenXLSX XLCfType)
+export const CfType = {
+  EXPRESSION: 0,
+  CELL_IS: 1,
+  COLOR_SCALE: 2,
+  DATA_BAR: 3,
+  ICON_SET: 4,
+  TOP10: 5,
+  UNIQUE_VALUES: 6,
+  DUPLICATE_VALUES: 7,
+  CONTAINS_TEXT: 8,
+  NOT_CONTAINS_TEXT: 9,
+  BEGINS_WITH: 10,
+  ENDS_WITH: 11,
+  CONTAINS_BLANKS: 12,
+  NOT_CONTAINS_BLANKS: 13,
+  CONTAINS_ERRORS: 14,
+  NOT_CONTAINS_ERRORS: 15,
+  TIME_PERIOD: 16,
+  ABOVE_AVERAGE: 17,
+} as const
+
+// Conditional formatting operators (OpenXLSX XLCfOperator)
+export const CfOperator = {
+  LESS_THAN: 0,
+  LESS_THAN_OR_EQUAL: 1,
+  EQUAL: 2,
+  NOT_EQUAL: 3,
+  GREATER_THAN_OR_EQUAL: 4,
+  GREATER_THAN: 5,
+  BETWEEN: 6,
+  NOT_BETWEEN: 7,
+  CONTAINS_TEXT: 8,
+  NOT_CONTAINS: 9,
+  BEGINS_WITH: 10,
+  ENDS_WITH: 11,
+} as const
+
+// Conditional formatting time periods (OpenXLSX XLCfTimePeriod)
+export const CfTimePeriod = {
+  TODAY: 0,
+  YESTERDAY: 1,
+  TOMORROW: 2,
+  LAST_7_DAYS: 3,
+  THIS_MONTH: 4,
+  LAST_MONTH: 5,
+  NEXT_MONTH: 6,
+  THIS_WEEK: 7,
+  LAST_WEEK: 8,
+  NEXT_WEEK: 9,
+} as const
 
 // Cell alignment (based on OpenXLSX XLAlignmentStyle)
 export const Align = {
@@ -197,11 +293,4 @@ export const NumFormat = {
   TIME_4: 23,
   DATETIME: 22,
   TEXT: 49,
-} as const
-
-// Image object position
-export const ImagePosition = {
-  MOVE_AND_SIZE: 1,
-  MOVE_DONT_SIZE: 2,
-  DONT_MOVE_DONT_SIZE: 3,
 } as const

package/src/specs/NitroXlsx.nitro.ts

@@ -1,4 +1,4 @@
-import { type HybridObject } from 'react-native-nitro-modules'
+import { type HybridObject, type AnyMap } from 'react-native-nitro-modules'
 
 export type CellType = 'empty' | 'string' | 'number' | 'boolean' | 'date' | 'error' | 'formula' | 'blank'
 
@@ -8,9 +8,12 @@ export interface XlsxWorkbook extends HybridObject<{ ios: 'c++'; android: 'c++'
   getWorksheetByName(name: string): XlsxWorksheet
   getOrAddWorksheet(name: string): XlsxWorksheet
   getWorksheetCount(): number
+  deleteSheet(name: string): void
+  updateSheetName(oldName: string, newName: string): void
+  clone(existingName: string, newName: string): XlsxWorksheet
   addCellFormat(): XlsxCellFormat
   getBuffer(): Promise<ArrayBuffer>
-  toJSON(keys?: string[]): string
+  toJSON(): Record<string, Array<AnyMap>>
 }
 
 export interface XlsxWorksheet extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
@@ -19,73 +22,167 @@ export interface XlsxWorksheet extends HybridObject<{ ios: 'c++'; android: 'c++'
   writeNumber(row: number, col: number, value: number, format?: XlsxCellFormat): void
   writeBoolean(row: number, col: number, value: boolean, format?: XlsxCellFormat): void
   writeBlank(row: number, col: number, format?: XlsxCellFormat): void
-  
+
   // Formula support
   writeFormula(row: number, col: number, formula: string, format?: XlsxCellFormat): void
   writeFormulaNum(row: number, col: number, formula: string, number: number, format?: XlsxCellFormat): void
   writeFormulaString(row: number, col: number, formula: string, str: string, format?: XlsxCellFormat): void
   writeFormulaBoolean(row: number, col: number, formula: string, boolVal: boolean, format?: XlsxCellFormat): void
   writeArrayFormula(firstRow: number, firstCol: number, lastRow: number, lastCol: number, formula: string, format?: XlsxCellFormat): void
-  
+
   // Date/DateTime support
   writeDatetime(row: number, col: number, datetime: number, format?: XlsxCellFormat): void
   writeURL(row: number, col: number, url: string, format?: XlsxCellFormat): void
-  
+
   // Column/Row operations
   setColumn(firstCol: number, lastCol: number, width: number, format?: XlsxCellFormat): void
   setRow(row: number, height: number, format?: XlsxCellFormat): void
-  
+  deleteRow(row: number): boolean
+  deleteColumn(col: number): boolean
+
   // Merge cells
   mergeRange(firstRow: number, firstCol: number, lastRow: number, lastCol: number, value: string, format?: XlsxCellFormat): void
   mergeRangeNum(firstRow: number, firstCol: number, lastRow: number, lastCol: number, value: number, format?: XlsxCellFormat): void
-  
-  // Image (uses file path)
-  insertImage(row: number, col: number, path: string, xOffset?: number, yOffset?: number, xScale?: number, yScale?: number): void
-  insertImageBuffer(row: number, col: number, buffer: ArrayBuffer, extension: string, xOffset?: number, yOffset?: number, xScale?: number, yScale?: number): void
-  
-  // Autofilter
-  autofilter(firstRow: number, firstCol: number, lastRow: number, lastCol: number): void
-  
-  // Freeze/Split panes
-  freezePanes(row: number, col: number): void
-  splitPanes(row: number, col: number): void
-  
+  unmergeCells(firstRow: number, firstCol: number, lastRow: number, lastCol: number): void
+
   // Tab appearance
-  setTabColor(color: number): void
   hide(): void
   activate(): void
-  setFirstSheet(): void
+
+  // Sheet protection
   protect(password?: string): void
-  
-  // Page setup
-  setPortrait(): void
-  setLandscape(): void
-  setPaper(paperType: number): void
-  setHeader(header: string): void
-  setFooter(footer: string): void
-  setPrintArea(firstRow: number, firstCol: number, lastRow: number, lastCol: number): void
-  fitToPages(width: number, height: number): void
-  setZoom(scale: number): void
-  setGridlines(option: number): void
-  centerHorizontally(): void
-  centerVertically(): void
-  
+  protectSheet(set?: boolean): void
+  protectObjects(set?: boolean): void
+  protectScenarios(set?: boolean): void
+
+  // Password
+  setPassword(password: string): void
+  setPasswordHash(hash: string): void
+  clearPassword(): void
+  clearSheetProtection(): void
+
+  // Fine-grained permissions (allow*/deny* pairs)
+  allowInsertColumns(set?: boolean): void
+  allowInsertRows(set?: boolean): void
+  allowDeleteColumns(set?: boolean): void
+  allowDeleteRows(set?: boolean): void
+  allowSelectLockedCells(set?: boolean): void
+  allowSelectUnlockedCells(set?: boolean): void
+
+  denyInsertColumns(): void
+  denyInsertRows(): void
+  denyDeleteColumns(): void
+  denyDeleteRows(): void
+  denySelectLockedCells(): void
+  denySelectUnlockedCells(): void
+
+  // Protection state
+  sheetProtected(): boolean
+  objectsProtected(): boolean
+  scenariosProtected(): boolean
+  insertColumnsAllowed(): boolean
+  insertRowsAllowed(): boolean
+  deleteColumnsAllowed(): boolean
+  deleteRowsAllowed(): boolean
+  selectLockedCellsAllowed(): boolean
+  selectUnlockedCellsAllowed(): boolean
+  passwordIsSet(): boolean
+  passwordHash(): string
+  sheetProtectionSummary(): string
+
   // Outline/Grouping
-  setOutline(level: number): void
   setColumnHidden(firstCol: number, lastCol: number, hidden: boolean): void
   setRowHidden(row: number, hidden: boolean): void
 
+  // Comments (XLComments)
+  setComment(row: number, col: number, text: string, authorId?: number): void
+  getComment(row: number, col: number): string
+  hasComment(row: number, col: number): boolean
+  deleteComment(row: number, col: number): boolean
+  getCommentCount(): number
+  addCommentAuthor(author: string): number
+  getCommentAuthor(authorId: number): string
+
+  // Conditional formatting (XLConditionalFormats)
+  getConditionalFormats(): XlsxConditionalFormats
+
   // Read methods
   getCellValue(row: number, col: number): string | number | boolean | null
   getCellString(row: number, col: number): string
   getCellRawValue(row: number, col: number): string
   getCellType(row: number, col: number): CellType
   getCellFormat(row: number, col: number): XlsxCellFormat
+  hasFormula(row: number, col: number): boolean
+  formula(row: number, col: number): string
+  findCell(row: number, col: number): boolean
   getRowCount(): number
   getColumnCount(): number
   getLastRow(): number
   getLastColumn(): number
   getName(): string
+
+  // JSON import / export for this worksheet
+  toJSON(keys?: string[]): Array<AnyMap>
+  fromJSON(data: Array<AnyMap>): void
+}
+
+/**
+ * A single <conditionalFormatting> entry: a cell range (sqref) plus its cfRules.
+ */
+export interface XlsxConditionalFormat extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  getSqref(): string
+  setSqref(sqref: string): void
+
+  // Rule collection
+  getRuleCount(): number
+  createRule(): number
+  deleteRule(index: number): boolean
+
+  // Rule type / dxf
+  getRuleType(index: number): number
+  setRuleType(index: number, type: number): void
+  getRuleDxfId(index: number): number
+  setRuleDxfId(index: number, dxfId: number): void
+
+  // Rule formula (supports up to 3 formulas: formula/formula2/formula3)
+  getRuleFormula(index: number, formulaIndex: number): string
+  setRuleFormula(index: number, formulaIndex: number, formula: string): void
+
+  // Rule attributes
+  getRuleOperator(index: number): number
+  setRuleOperator(index: number, op: number): void
+  getRuleText(index: number): string
+  setRuleText(index: number, text: string): void
+  getRulePriority(index: number): number
+  setRulePriority(index: number, priority: number): void
+  getRuleStopIfTrue(index: number): boolean
+  setRuleStopIfTrue(index: number, stop: boolean): void
+  getRuleTimePeriod(index: number): number
+  setRuleTimePeriod(index: number, period: number): void
+  getRuleRank(index: number): number
+  setRuleRank(index: number, rank: number): void
+  getRuleStdDev(index: number): number
+  setRuleStdDev(index: number, stdDev: number): void
+  getRuleAboveAverage(index: number): boolean
+  setRuleAboveAverage(index: number, set: boolean): void
+  getRulePercent(index: number): boolean
+  setRulePercent(index: number, set: boolean): void
+  getRuleBottom(index: number): boolean
+  setRuleBottom(index: number, set: boolean): void
+  getRuleEqualAverage(index: number): boolean
+  setRuleEqualAverage(index: number, set: boolean): void
+
+  summary(): string
+}
+
+/**
+ * All <conditionalFormatting> entries of a worksheet.
+ */
+export interface XlsxConditionalFormats extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  getCount(): number
+  create(sqref: string): XlsxConditionalFormat
+  getByIndex(index: number): XlsxConditionalFormat
+  summary(): string
 }
 
 export interface XlsxCellFormat extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
@@ -98,7 +195,7 @@ export interface XlsxCellFormat extends HybridObject<{ ios: 'c++'; android: 'c++
   setItalic(): void
   setUnderline(style?: number): void
   setStrikeout(): void
-  
+
   // Alignment
   setAlign(align: number): void
   setVerticalAlign(align: number): void
@@ -106,16 +203,16 @@ export interface XlsxCellFormat extends HybridObject<{ ios: 'c++'; android: 'c++
   setRotation(angle: number): void
   setIndent(level: number): void
   setShrink(): void
-  
+
   // Number format
   setNumFormat(format: string): void
   setNumFormatIndex(index: number): void
-  
+
   // Colors/Pattern
   setBgColor(color: number): void
   setFgColor(color: number): void
   setPattern(pattern: number): void
-  
+
   // Borders
   setBorder(style: number): void
   setBorderColor(color: number): void
@@ -129,11 +226,11 @@ export interface XlsxCellFormat extends HybridObject<{ ios: 'c++'; android: 'c++
   setRightColor(color: number): void
   setDiagonal(style: number): void
   setDiagonalColor(color: number): void
-  
+
   // Protection
   setLocked(): void
   setUnlocked(): void
-  
+
   // Other
   setHyperlink(): void
   setFontOnly(): void
@@ -149,8 +246,8 @@ export interface XlsxCellFormat extends HybridObject<{ ios: 'c++'; android: 'c++
 }
 
 export interface NitroXlsx extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
-  createWorkbook(tempDir?: string): XlsxWorkbook
+  createWorkbook(): XlsxWorkbook
   openWorkbook(path: string): XlsxWorkbook
   openWorkbookFromBuffer(buffer: ArrayBuffer): XlsxWorkbook
-  fromJSON(data: string): XlsxWorkbook
-}
+  fromJSON(data: Record<string, Array<AnyMap>>): XlsxWorkbook
+}

package/thirdparty/OpenXLSX/.clang-format

@@ -0,0 +1,118 @@
+Language: Cpp
+Standard: c++11
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlines: Left
+AlignOperands: Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: false
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Always
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: true
+  AfterControlStatement: MultiLine
+  AfterEnum: false
+  AfterFunction: true
+  AfterNamespace: true
+  AfterObjCDeclaration: false
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: true
+  BeforeCatch: true
+  BeforeElse: true
+  BeforeLambdaBody: false
+  BeforeWhile: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyNamespace: true
+  SplitEmptyRecord: true
+BreakAfterJavaFieldAnnotations: true
+BreakBeforeBinaryOperators: None
+#BreakBeforeInheritanceComma: true
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+#BreakConstructorInitializersBeforeComma: false
+BreakInheritanceList: BeforeColon
+BreakStringLiterals: true
+ColumnLimit: 140
+CommentPragmas: '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: false
+DeriveLineEnding: false
+DerivePointerAlignment: false
+DisableFormat: false
+ExperimentalAutoDetectBinPacking: true
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks: Preserve
+IncludeCategories:
+  - Priority: 2
+    Regex: ^"(llvm|llvm-c|clang|clang-c)/
+  - Priority: 3
+    Regex: ^(<|"(gtest|gmock|isl|json)/)
+  - Priority: 1
+    Regex: .*
+IncludeIsMainRegex: (Test)?$
+IndentCaseLabels: true
+IndentExternBlock: AfterExternBlock
+IndentGotoLabels: false
+IndentPPDirectives: AfterHash
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCBlockIndentWidth: 7
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: false
+PointerAlignment: Left
+ReflowComments: true
+SortIncludes: true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 4
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 8
+UseTab: Never

package/thirdparty/OpenXLSX/.clang-tidy

@@ -0,0 +1,28 @@
+---
+Checks: >-
+  *,
+  -llvmlibc-*,
+  -llvm-header-guard,
+  -fuchsia-*,
+  -modernize-use-trailing-return-type,
+  -modernize-use-nodiscard,
+  -modernize-avoid-c-arrays,
+  -modernize-pass-by-value,
+  -readability-braces-around-statements,
+  -readability-implicit-bool-conversion,
+  -readability-else-after-return,
+  -readability-convert-member-functions-to-static,
+  -cppcoreguidelines-avoid-c-arrays,
+  -hicpp-avoid-c-arrays,
+  -hicpp-braces-around-statements,
+  -google-readability-braces-around-statements,
+  -google-build-using-namespace,
+  -bugprone-infinite-loop,
+  -abseil-string-find-startswith,
+  -abseil-string-find-str-contains,
+  -altera-unroll-loops,
+  -cppcoreguidelines-pro-bounds-array-to-pointer-decay
+
+WarningsAsErrors: '*'
+HeaderFilterRegex: ''
+FormatStyle:     none

package/thirdparty/OpenXLSX/.gitignore

@@ -0,0 +1,130 @@
+# ignore everything
+/*
+
+# include generic files
+!/.clang-format
+!/.clang-tidy
+!/.gitignore
+!/LICENSE.md
+!/NOTICE
+!/README.md
+
+# include root directory files
+!/CMakeLists.txt
+!/Makefile.GNU
+!/vcpkg.json
+
+# include Benchmarks folder
+!/Benchmarks
+# exclude everything *in* Benchmarks folder
+/Benchmarks/*
+# re-include specifically what is desired from Benchmarks folder
+!/Benchmarks/*.cpp
+!/Benchmarks/*.txt
+!/Benchmarks/2024-07-29-benchmarks_before_XMLNode_wrappers
+!/Benchmarks/2024-07-29-benchmarks_with_XMLNode_wrappers_and_namespace_and_stripping
+!/Benchmarks/2024-07-29-benchmarks_with_XMLNode_wrappers_and_namespace_char_support
+!/Benchmarks/2024-07-29-benchmarks_with_XMLNode_wrappers_and_namespaced_name_disabled
+!/Benchmarks/2024-07-29-benchmarks_with_XMLNode_wrappers_and_namespace_support
+!/Benchmarks/2024-08-11-benchmarks_post-XLCellIterator-Rework
+!/Benchmarks/2024-08-14-benchmarks_post-default-row-column-style-support
+!/Benchmarks/2024-09-02-benchmarks
+!/Benchmarks/2024-12-19-benchmarks
+!/Benchmarks/2024-12-30-benchmarks-post-XLSharedStrings-by-ref
+!/Benchmarks/2025-01-09-benchmarks-post-conditionalFormatsAndSheetProtection
+!/Benchmarks/2025-01-10-benchmarks-post-XLCellValue-bugfix
+!/Benchmarks/2025-01-31-benchmarks-post-XLComments-implementation
+!/Benchmarks/2025-02-02-benchmarks-post-XLRowIterator-Rework
+!/Benchmarks/2025-07-20-benchmarks-after-hiding-pugixml-internals
+!/Benchmarks/2025-08-29-benchmarks-after-code-review-with-libzip
+
+# include cmake folder
+!/cmake
+# exclude everything *in* cmake folder
+/cmake/*
+# re-include specifically what is desired from cmake folder
+!/cmake/get-git-HEAD-ID.cmake
+!/cmake/libopenxlsxCPackOptions.cmake.in
+!/cmake/manage_dependency.cmake
+!/cmake/recursive_library_type_test.cmake
+
+# include Documentation folder
+!/Documentation
+# exclude everything *in* Documentation folder
+/Documentation/*
+# re-include specifically what is desired from Documentation folder
+!/Documentation/*.txt
+!/Documentation/*.css
+!/Documentation/*.in
+!/Documentation/*.xml
+
+# include Examples folder
+!/Examples
+# exclude everything *in* Examples folder
+/Examples/*
+# re-include specifically what is desired from Examples folder
+!/Examples/cmake
+!/Examples/cmake/*
+!/Examples/CMakeLists.txt
+!/Examples/*.cpp
+!/Examples/external
+!/Examples/external/*
+
+# include gnu-make-crutch folder
+!/gnu-make-crutch
+# exclude everything *in* gnu-make-crutch folder
+/gnu-make-crutch/*
+# re-include specifically what is desired from gnu-make-crutch folder
+!/gnu-make-crutch/OpenXLSX-Exports-shared.hpp
+!/gnu-make-crutch/OpenXLSX-Exports-static.hpp
+
+# include Notes folder
+!/Notes
+# exclude everything *in* Notes folder
+/Notes/*
+# re-include specifically what is desired from Notes folder
+!/Notes/styles-missing-support.xml
+!/Notes/todo-list.txt
+!/Notes/confirmed-TBCs.txt
+!/Notes/TBDs.txt
+
+# include OpenXLSX folder
+!/OpenXLSX
+# exclude everything *in* OpenXLSX folder
+/OpenXLSX/*
+# re-include specifically what is desired from OpenXLSX folder
+!/OpenXLSX/CMakeLists.txt
+!/OpenXLSX/cmake
+!/OpenXLSX/cmake/*
+!/OpenXLSX/headers
+!/OpenXLSX/headers/*
+!/OpenXLSX/OpenXLSXConfig.cmake
+!/OpenXLSX/OpenXLSX.hpp
+!/OpenXLSX/sources
+!/OpenXLSX/sources/*
+
+# include Scripts folder
+!/Scripts
+# exclude everything *in* Scripts folder
+/Scripts/*
+# re-include specifically what is desired from Scripts folder
+!/Scripts/demos-cleanup.sh
+!/Scripts/cmake-cleanup.sh
+!/Scripts/compile.sh
+!/Scripts/demos-cleanup.sh
+!/Scripts/demos-run-all.sh
+!/Scripts/guarded-xml-format.sh
+!/Scripts/make-gnu.sh
+!/Scripts/uninstall-manifest.sh
+!/Scripts/xml-format-all.sh
+!/Scripts/xml-format.sh
+
+# include Tests folder
+!/Tests
+# exclude everything *in* Tests folder
+/Tests/*
+# re-include specifically what is desired from Tests folder
+!/Tests/catch
+!/Tests/catch/*.hpp
+!/Tests/CMakeLists.txt
+!/Tests/*.cpp