@ox-content/napi 2.2.0 → 2.4.0

package/index.d.ts

@@ -171,6 +171,53 @@ export interface JsLocaleInfo {
   dir: string
 }
 
+export interface JsMarkdownLintDiagnostic {
+  ruleId: string
+  severity: string
+  message: string
+  line: number
+  column: number
+  endLine: number
+  endColumn: number
+  language?: string
+  suggestions?: Array<string>
+}
+
+export interface JsMarkdownLintDictionaryOptions {
+  words?: Array<string>
+  byLanguage?: Array<JsMarkdownLintLanguageWords>
+  ignoredWords?: Array<string>
+}
+
+export interface JsMarkdownLintLanguageWords {
+  language: string
+  words: Array<string>
+}
+
+export interface JsMarkdownLintOptions {
+  languages?: Array<string>
+  rules?: JsMarkdownLintRuleOptions
+  dictionary?: JsMarkdownLintDictionaryOptions
+}
+
+export interface JsMarkdownLintResult {
+  diagnostics: Array<JsMarkdownLintDiagnostic>
+  errorCount: number
+  warningCount: number
+  infoCount: number
+  maskedDocument: string
+}
+
+export interface JsMarkdownLintRuleOptions {
+  duplicateHeadings?: boolean
+  headingIncrement?: boolean
+  maxConsecutiveBlankLines?: number
+  repeatedPunctuation?: boolean
+  repeatedWords?: boolean
+  spellcheck?: boolean
+  trailingSpaces?: boolean
+}
+
 /** OG image configuration for JavaScript. */
 export interface JsOgImageConfig {
   /** Image width in pixels. */
@@ -500,6 +547,10 @@ export interface JsTransformOptions {
   codeAnnotationDefaultLineNumbers?: boolean
 }
 
+export declare function lintMarkdown(source: string, options?: JsMarkdownLintOptions | undefined | null): JsMarkdownLintResult
+
+export declare function lintMarkdownDocuments(sources: Array<string>, options?: JsMarkdownLintOptions | undefined | null): Array<JsMarkdownLintResult>
+
 /**
  * Loads dictionaries from the given directory.
  *

package/index.js

@@ -72,6 +72,8 @@ module.exports = binding;
 module.exports.parse = binding.parse;
 module.exports.parseAndRender = binding.parseAndRender;
 module.exports.parseAndRenderAsync = binding.parseAndRenderAsync;
+module.exports.lintMarkdown = binding.lintMarkdown;
+module.exports.lintMarkdownDocuments = binding.lintMarkdownDocuments;
 module.exports.render = binding.render;
 module.exports.transform = binding.transform;
 module.exports.transformAsync = binding.transformAsync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/napi",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
   "keywords": [
     "markdown",
@@ -45,10 +45,10 @@
     ]
   },
   "optionalDependencies": {
-    "@ox-content/binding-darwin-x64": "2.2.0",
-    "@ox-content/binding-darwin-arm64": "2.2.0",
-    "@ox-content/binding-linux-x64-gnu": "2.2.0",
-    "@ox-content/binding-linux-arm64-gnu": "2.2.0",
-    "@ox-content/binding-win32-x64-msvc": "2.2.0"
+    "@ox-content/binding-darwin-x64": "2.4.0",
+    "@ox-content/binding-darwin-arm64": "2.4.0",
+    "@ox-content/binding-linux-x64-gnu": "2.4.0",
+    "@ox-content/binding-linux-arm64-gnu": "2.4.0",
+    "@ox-content/binding-win32-x64-msvc": "2.4.0"
   }
 }