@diplodoc/yfmlint 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 YANDEX LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+[![NPM version](https://img.shields.io/npm/v/@diplodoc/yfmlint.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/yfmlint)
+
+# YFM syntax linter
+
+## Usage
+
+```
+npm install @diplodoc/yfmlint
+```
+
+```javascript
+import {yfmlint, log} from '@diplodoc/yfmlint';
+
+const errors = await yfmlint(content, path, options);
+
+if (errors) {
+  resourcemap(errors);
+  log(errors, logger);
+}
+```
+
+## YFM rules
+
+[All markdownlint rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
+
+### YFM001 - Inline code line length
+
+Tags: line_length
+
+Aliases: inline-code-length
+
+Parameters: maximum
+
+This rule is triggered when there are lines that are longer than the
+configured `value` (default: 100 characters).
+
+### YFM002 - No header found in the file for the link text
+
+Tags: links
+
+Aliases: no-header-found-for-link
+
+This rule is triggered when there are no headers in the file referenced by the link.
+
+### YFM003 - Link is unreachable
+
+Tags: links
+
+Aliases: unreachable-link
+
+This rule is triggered when there is no file referenced by the link.
+
+### YFM004 - Table not closed
+
+Tags: table
+
+Aliases: table-not-closed
+
+This rule is triggered when table don't have close token.
+
+### YFM005 - Tab list not closed
+
+Tags: tab
+
+Aliases: tab-list-not-closed
+
+This rule is triggered when tab list don't have close token.

package/build/config.d.ts

@@ -0,0 +1,17 @@
+import { LogLevels } from './utils';
+declare const _default: {
+    default: boolean;
+    YFM001: {
+        level: LogLevels;
+        maximum: number;
+    };
+    YFM002: LogLevels;
+    YFM003: LogLevels;
+    YFM004: LogLevels;
+    YFM005: LogLevels;
+    YFM006: LogLevels;
+    YFM007: LogLevels;
+    YFM008: LogLevels;
+    YFM009: LogLevels;
+};
+export default _default;

package/build/index.d.ts

@@ -0,0 +1,3 @@
+import type { LintError, Options } from './typings';
+export { LogLevels, log } from './utils';
+export declare function yfmlint(content: string, path: string, opts: Options): Promise<LintError[] | undefined>;