links-notation 0.8.0

package/README.md

@@ -0,0 +1,219 @@
+# Lino Protocol Parser for JavaScript
+
+JavaScript implementation of the Lino protocol parser using Bun and
+Peggy.js parser generator.
+
+## Installation
+
+### Installing from npm
+
+Install the package using your preferred package manager:
+
+#### Using npm (Node.js)
+
+```bash
+npm install links-notation
+```
+
+#### Using Bun
+
+```bash
+bun add links-notation
+```
+
+#### Using Deno
+
+```typescript
+import { Parser, Link } from "npm:links-notation@^0.6.0";
+```
+
+### Local Development Setup
+
+For contributors working on the source code:
+
+#### Using Bun (recommended)
+
+```bash
+cd js
+bun install
+```
+
+#### Using npm
+
+```bash
+cd js
+npm install
+```
+
+## Build
+
+Compile the Peggy.js grammar:
+
+```bash
+bun run build:grammar
+```
+
+Build the project:
+
+```bash
+bun run build
+```
+
+## Test
+
+Run tests:
+
+```bash
+bun test
+```
+
+Watch mode:
+
+```bash
+bun test --watch
+```
+
+## Usage
+
+### Basic Parsing
+
+```javascript
+import { Parser, Link } from 'links-notation';
+
+// Create parser
+const parser = new Parser();
+
+// Parse Lino format string
+const input = `papa (lovesMama: loves mama)
+son lovesMama
+daughter lovesMama
+all (love mama)`;
+
+const result = parser.parse(input);
+console.log(result);
+
+// Access parsed structure
+result.forEach(link => {
+    console.log(link.toString());
+});
+```
+
+### Working with Links
+
+```javascript
+import { Link } from 'links-notation';
+
+// Create links programmatically
+const link = new Link('parent', [
+    new Link('child1'),
+    new Link('child2')
+]);
+
+console.log(link.toString()); // (parent: child1 child2)
+
+// Access link properties
+console.log('ID:', link.id);
+console.log('Values:', link.values);
+```
+
+### Advanced Usage
+
+```javascript
+// Handle nested structures
+const input = `parent
+  child1
+  child2
+    grandchild1
+    grandchild2`;
+
+const parsed = await parser.parse(input);
+
+// Work with groups
+import { LinksGroup } from 'links-notation';
+const group = new LinksGroup(parsed);
+console.log(group.format());
+```
+
+## Syntax Examples
+
+### Doublets (2-tuple)
+
+```lino
+papa (lovesMama: loves mama)
+son lovesMama
+daughter lovesMama
+all (love mama)
+```
+
+### Triplets (3-tuple)
+
+```lino
+papa has car
+mama has house
+(papa and mama) are happy
+```
+
+### N-tuples with References
+
+```lino
+(linksNotation: links notation)
+(This is a linksNotation as well)
+(linksNotation supports (unlimited number (of references) in each link))
+```
+
+### Indented Structure
+
+```lino
+parent
+  child1
+  child2
+    grandchild1
+    grandchild2
+```
+
+## API Reference
+
+### Classes
+
+#### `Parser`
+
+Main parser class for converting strings to links.
+
+- `initialize()` - Initialize the parser (async)
+- `parse(input)` - Parse a Lino string and return links
+
+#### `Link`
+
+Represents a single link with ID and values.
+
+- `constructor(id, values = [])` - Create a new link
+- `toString()` - Convert link to string format
+- `id` - Link identifier
+- `values` - Array of child values/links
+
+#### `LinksGroup`
+
+Container for grouping related links.
+
+- `constructor(links)` - Create a new group
+- `format()` - Format the group as a string
+
+## Project Structure
+
+- `src/grammar.pegjs` - Peggy.js grammar definition
+- `src/Link.js` - Link data structure
+- `src/LinksGroup.js` - Links group container
+- `src/Parser.js` - Parser wrapper
+- `src/index.js` - Main entry point
+- `tests/` - Test files
+
+## Dependencies
+
+- Peggy.js (5.0.6) - Parser generator
+- Bun runtime (development)
+
+## Package Information
+
+- Package: `links-notation`
+- Version: 0.1.0
+- License: MIT

package/README.ru.md

@@ -0,0 +1,193 @@
+# Парсер протокола Lino для JavaScript
+
+Реализация парсера протокола Lino для JavaScript с использованием Bun и
+генератора парсеров Peggy.js.
+
+## Установка
+
+### Использование Bun (рекомендуется)
+
+```bash
+cd js
+bun install
+```
+
+### Использование npm
+
+```bash
+cd js
+npm install
+```
+
+## Сборка
+
+Компиляция грамматики Peggy.js:
+
+```bash
+bun run build:grammar
+```
+
+Сборка проекта:
+
+```bash
+bun run build
+```
+
+## Тестирование
+
+Запуск тестов:
+
+```bash
+bun test
+```
+
+Режим наблюдения:
+
+```bash
+bun test --watch
+```
+
+## Использование
+
+### Базовый парсинг
+
+```javascript
+import { Parser, Link } from 'links-notation';
+
+// Создание парсера
+const parser = new Parser();
+
+// Парсинг строки в формате Lino
+const input = `папа (любитМаму: любит маму)
+сын любитМаму
+дочь любитМаму
+все (любят маму)`;
+
+const result = parser.parse(input);
+console.log(result);
+
+// Обращение к распарсенной структуре
+result.forEach(link => {
+    console.log(link.toString());
+});
+```
+
+### Работа со связями
+
+```javascript
+import { Link } from 'links-notation';
+
+// Создание связей программно
+const link = new Link('родитель', [
+    new Link('ребенок1'),
+    new Link('ребенок2')
+]);
+
+console.log(link.toString()); // (родитель: ребенок1 ребенок2)
+
+// Доступ к свойствам связи
+console.log('ID:', link.id);
+console.log('Значения:', link.values);
+```
+
+### Расширенное использование
+
+```javascript
+// Обработка вложенных структур
+const input = `родитель
+  ребенок1
+  ребенок2
+    внук1
+    внук2`;
+
+const parsed = await parser.parse(input);
+
+// Работа с группами
+import { LinksGroup } from 'links-notation';
+const group = new LinksGroup(parsed);
+console.log(group.format());
+```
+
+## Примеры синтаксиса
+
+### Дуплеты (2-кортежи)
+
+```lino
+папа (любитМаму: любит маму)
+сын любитМаму
+дочь любитМаму
+все (любят маму)
+```
+
+### Триплеты (3-кортежи)
+
+```lino
+папа имеет машину
+мама имеет дом
+(папа и мама) счастливы
+```
+
+### N-кортежи со ссылками
+
+```lino
+(нотацияСвязей: нотация связей)
+(Это тоже нотацияСвязей)
+(нотацияСвязей поддерживает (неограниченное количество (ссылок) в каждой связи))
+```
+
+### Структура с отступами
+
+```lino
+родитель
+  ребенок1
+  ребенок2
+    внук1
+    внук2
+```
+
+## Справочник API
+
+### Классы
+
+#### `Parser`
+
+Основной класс парсера для преобразования строк в связи.
+
+- `initialize()` - Инициализация парсера (асинхронно)
+- `parse(input)` - Парсинг строки Lino и возвращение связей
+
+#### `Link`
+
+Представляет одну связь с ID и значениями.
+
+- `constructor(id, values = [])` - Создание новой связи
+- `toString()` - Преобразование связи в строковый формат
+- `id` - Идентификатор связи
+- `values` - Массив дочерних значений/связей
+
+#### `LinksGroup`
+
+Контейнер для группировки связанных связей.
+
+- `constructor(links)` - Создание новой группы
+- `format()` - Форматирование группы в строку
+
+## Структура проекта
+
+- `src/grammar.pegjs` - Определение грамматики Peggy.js
+- `src/Link.js` - Структура данных связи
+- `src/LinksGroup.js` - Контейнер групп связей
+- `src/Parser.js` - Обертка парсера
+- `src/index.js` - Главная точка входа
+- `tests/` - Файлы тестов
+
+## Зависимости
+
+- Peggy.js (5.0.6) - Генератор парсеров
+- Среда выполнения Bun (разработка)
+
+## Информация о пакете
+
+- Пакет: `links-notation`
+- Версия: 0.1.0
+- Лицензия: MIT

package/bun.lock

@@ -0,0 +1,33 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "@linksplatform/protocols-lino",
+      "devDependencies": {
+        "bun-types": "^1.2.19",
+        "peggy": "^5.0.6",
+      },
+    },
+  },
+  "packages": {
+    "@peggyjs/from-mem": ["@peggyjs/from-mem@3.1.1", "", { "dependencies": { "semver": "7.7.2" } }, "sha512-m5OEjgJaePWpyNtQCvRZkpLoV+z44eh6QIO9yEwQuOThdUdkECO3wcKLT3tFA3H8WM5bxU/K/dpmo7r/X16UEw=="],
+
+    "@types/node": ["@types/node@24.2.1", "", { "dependencies": { "undici-types": "~7.10.0" } }, "sha512-DRh5K+ka5eJic8CjH7td8QpYEV6Zo10gfRkjHCO3weqZHWDtAaSTFtl4+VMqOJ4N5jcuhZ9/l+yy8rVgw7BQeQ=="],
+
+    "@types/react": ["@types/react@19.1.9", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-WmdoynAX8Stew/36uTSVMcLJJ1KRh6L3IZRx1PZ7qJtBqT3dYTgyDTx8H1qoRghErydW7xw9mSJ3wS//tCRpFA=="],
+
+    "bun-types": ["bun-types@1.2.19", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-uAOTaZSPuYsWIXRpj7o56Let0g/wjihKCkeRqUBhlLVM/Bt+Fj9xTo+LhC1OV1XDaGkz4hNC80et5xgy+9KTHQ=="],
+
+    "commander": ["commander@14.0.0", "", {}, "sha512-2uM9rYjPvyq39NwLRqaiLtWHyDC1FvryJDa2ATTVims5YAS4PupsEQsDvP14FqhFr0P49CYDugi59xaxJlTXRA=="],
+
+    "csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
+
+    "peggy": ["peggy@5.0.6", "", { "dependencies": { "@peggyjs/from-mem": "3.1.1", "commander": "^14.0.0", "source-map-generator": "2.0.2" }, "bin": { "peggy": "bin/peggy.js" } }, "sha512-Sud8Zus0JAgE+U4zwkJv29OOaXhviFI7J90/6cGfy3OoqR8dpnieeF9a46dj0bTtqiFnrFatldA6ltQyOJvNmg=="],
+
+    "semver": ["semver@7.7.2", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA=="],
+
+    "source-map-generator": ["source-map-generator@2.0.2", "", {}, "sha512-unCl5BQhF/us51DiT7SvlSY3QUPhyfAdHJxd8l7FXdwzqxli0UDMV2dEuei2SeGp3Z4rB/AJ9zKi1mGOp2K2ww=="],
+
+    "undici-types": ["undici-types@7.10.0", "", {}, "sha512-t5Fy/nfn+14LuOc2KNYg75vZqClpAiqscVvMygNnlsHBFpSXdJaYtXMcdNLpl/Qvc3P2cB3s6lOV51nqsFq4ag=="],
+  }
+}