GitHub - lad-tech/nsc-cli

⚠️ Breaking Change: Версии выше 1.0.0 (например, 2.0.0+) содержат критические изменения и несовместимы с версией 1.0.0 и ниже. Все генерируемые сервисы теперь используют ESM модули вместо CommonJS.

NSC-Toolkit-CLI — это набор инструментов командной строки, включающий две основные утилиты: NSC-CRUD и NSC-CLI. Эти утилиты предназначены для автоматизации различных аспектов разработки сервисов, обеспечивая быстрое и эффективное создание CRUD операций и генерацию новых сервисов на основе JSON-схем.

Содержание

Введение
- Breaking Changes в версиях выше 1.0.0
Установка
NSC-CRUD
NSC-CLI
Поддержка

Введение

NSC-Toolkit — это мощный набор инструментов командной строки, разработанный для автоматизации создания CRUD операций и генерации новых сервисов на основе JSON-схем. Включает две основные утилиты:

NSC-CRUD: Автоматизирует генерацию CRUD (Create, Read, Update, Delete) операций для ваших сущностей.
NSC-CLI: Обеспечивает быстрое создание новых сервисов с использованием JSON-схем и поддерживает интеграцию с nsc-toolkit.

⚠️ Breaking Changes в версиях выше 1.0.0

Внимание! Версии выше 1.0.0 (например, 2.0.0+) содержат критические breaking changes и несовместимы с версией 1.0.0 и ниже.

Миграция на ESM модули

Начиная с версии 2.0.0, все генерируемые сервисы используют ES Modules (ESM) вместо CommonJS. Это breaking change, который требует:

Node.js версии 18.0.0 или выше (для поддержки import attributes)
Обновление всех импортов в существующих проектах
Изменение структуры package.json (добавление type: "module")

Что изменилось:

Импорты JSON схем: Теперь используется import serviceSchema from './schema.json' with { type: 'json' } вместо деструктуризации
Расширения файлов: Все локальные импорты требуют расширения .js (например, ./interfaces.js)
Структура package.json: Автоматически добавляются поля type: "module" и exports
Синтаксис экспорта: Используется ESM синтаксис вместо CommonJS

Преимущества новой версии:

Современный синтаксис импорта/экспорта
Лучшая поддержка tree-shaking
Соответствие современным стандартам JavaScript
Импорт JSON файлов через with { type: 'json' }
Автоматическая настройка package.json с полями type: "module" и exports
Улучшенная система логирования с уровнями (DEBUG, INFO, WARN, ERROR)
Профессиональная обработка ошибок с кастомными классами ошибок
Расширенная валидация входных данных
Оптимизация производительности (кеширование, async операции)
Улучшенный CLI интерфейс с verbose режимом и детальной справкой

Миграция существующих проектов

Если у вас есть проекты, созданные с версией 1.0.0 или ниже, и вы хотите обновиться до версии 2.0.0+, вам необходимо:

Обновить все импорты, добавив расширения .js
Изменить импорты JSON схем на новый формат
Обновить package.json, добавив type: "module"
Убедиться, что Node.js версии 18.0.0 или выше

Установка

Для установки NSC-Toolkit глобально с помощью npm или yarn выполните следующие команды:

# Установка последней версии (2.0.0+ с ESM)
npm install -g @lad-tech/nsc-cli

# Или с использованием yarn
yarn global add @lad-tech/nsc-cli

# Для установки стабильной версии 1.0.0 (CommonJS)
npm install -g @lad-tech/nsc-cli@^1.0.0

⚠️ Внимание: Убедитесь, что вы используете правильную версию в зависимости от ваших требований:

Версия 2.0.0+: ESM модули, требует Node.js 18+, несовместима с версией 1.0.0
Версия 1.0.0: CommonJS модули, стабильная версия, совместима со старыми версиями Node.js

Требования

⚠️ Важно: Требования зависят от версии:

Для версии 2.0.0+ (ESM):

Node.js: версия 18.0.0 или выше (обязательно для поддержки ESM и import attributes)
TypeScript: версия 5.0.0 или выше (рекомендуется)
npm или yarn для установки зависимостей

Для версии 1.0.0 (CommonJS):

Node.js: версия 14.0.0 или выше
TypeScript: версия 4.0.0 или выше
npm или yarn для установки зависимостей

Примечание: Версия 1.0.0 генерирует CommonJS модули. Версии 2.0.0+ генерируют только ESM модули и несовместимы с версией 1.0.0.

NSC-CRUD

NSC-CRUD — это утилита из набора NSC-Toolkit, предназначенная для автоматизации генерации CRUD операций для ваших сущностей на основе предварительно определенной JSON-схемы. API.md

Особенности NSC-CRUD

Валидация Схемы: Проверяет соответствие предоставленной схемы необходимой структуре с помощью AJV.
Автоматическая Генерация Файлов: Создает необходимые CRUD файлы, такие как репозитории, интерфейсы, сервисы и другие.
Неизменяемость Сгенерированных Методов: Уже сгенерированные методы не изменяются при повторной генерации, изменяются только интерфейсы.
Поддержка .nscignore: Можно разместить файл .nscignore в корне сервиса (синтаксис gitignore), и указанные файлы не будут перезаписаны.
Использование $ref в Контрактах Методов: В service.schema.json можно описать блок Ref для использования ссылок в контрактах методов.
Поддержка TypeScript: Использует ts-morph для бесшовной интеграции с TypeScript проектом.
Поддержка ESM модулей: Генерируемые файлы используют ES Modules (ESM) с полной поддержкой современного синтаксиса импорта/экспорта.

Использование NSC-CRUD

Структура Команды NSC-CRUD

Основная структура команды NSC-CRUD выглядит следующим образом:

nsc-crud --schema <путь-к-схеме>

Опции NSC-CRUD

Опция	Описание	Обязательно	По Умолчанию
`--schema` `<path>`	Путь к файлу JSON-схемы, определяющему сущность, для которой будут сгенерированы CRUD операции.	Да	N/A
`-h`, `--help`	Отображает справку по команде.	Нет	N/A

Пример Использования NSC-CRUD

nsc-crud --schema ./schemas/notification.schema.json

Эта команда генерирует CRUD операции на основе файла notification.schema.json, расположенного в директории ./schemas.

Определение Схемы NSC-CRUD

NSC-CRUD использует определенную структуру JSON-схемы для генерации необходимых CRUD файлов. Схема определяет свойства сущности, их типы, правила валидации и методы сервиса.

Пример Схемы NSC-CRUD

{
  "entityName": "Notification",
  "entityData": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string",
        "description": "Заголовок уведомления",
        "minLength": 1
      },
      "description": {
        "type": "string",
        "description": "Описание уведомления",
        "minLength": 1
      },
      "deeplink": {
        "type": "string",
        "format": "uri",
        "description": "URL для диплинков"
      },
      "topic": {
        "type": "string",
        "enum": ["general", "direct"],
        "description": "Тип уведомления: general - всем, direct - конкретным пользователям"
      },
      "fcm": {
        "type": "array",
        "description": "Fcm пользователей, для которых это уведомление. Если пустой, то для всех",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "default": []
      },
      "userIds": {
        "type": "array",
        "description": "ID пользователей, для которых это уведомление. Если пустой, то для всех",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "default": []
      }
    },
    "required": ["title", "description", "topic"],
    "additionalProperties": false
  },
  "filterColumns": ["title", "description", "topic"]
}

Компоненты Схемы NSC-CRUD

entityName: Название сущности, для которой будут сгенерированы CRUD операции.
entityData: Определяет структуру и свойства сущности.
- type: Должно быть "object".
- properties: Опишите поля как в JsonSchema
- required: Обязательные поля.
- additionalProperties: Запрещает свойства, не определенные в разделе properties.
filterColumns: Массив строк, указывающих, какие столбцы могут использоваться для фильтрации.

Валидация Схемы NSC-CRUD

Перед генерацией CRUD файлов, NSC-CRUD валидирует предоставленную схему с помощью AJV . Это гарантирует, что схема соответствует необходимой структуре и правилам.

Если валидация схемы не проходит, NSC-CRUD выведет ошибки валидации и завершит процесс.

Генерируемые Файлы NSC-CRUD

После успешной валидации схемы, NSC-CRUD генерирует несколько важных файлов для облегчения CRUD операций в вашем сервисе. Ниже приведен список генерируемых файлов и их назначение:

Файлы Схем:
- service.schema.json: Основной файл схемы для сервиса.
- crudSchema.json: Валидированная CRUD схема.
CRUD Файлы:
- aggregate.ts: Логика агрегации для сущности.
- crudMethods.ts: Стандартные CRUD методы (Create, Read, Update, Delete).
- repository.ts: Реализация паттерна репозитория для доступа к данным.
- interfaces.ts: TypeScript интерфейсы, определяющие структуру сущности.
- di.ts: Настройка Dependency Injection для сервиса.
- index.ts: Точка входа для CRUD операций.
Общие Файлы:
- generalFiles.ts: Общие утилиты и помощники.
- generateStartFile.ts: Скрипт для запуска сервиса.
- generateServerFile.ts: Конфигурация и настройка сервера.
- generateIndexFile.ts: Основной индексный файл для экспорта модулей.
Конфигурационные Файлы:
- tsconfig.json: Файл конфигурации TypeScript (если не существует).

Примечание: Точная структура и наименование генерируемых файлов могут варьироваться в зависимости от конвенций проекта и конкретных деталей реализации NSC-CRUD.

NSC-CLI

NSC-CLI — это утилита из набора NSC-Toolkit, предназначенная для быстрого создания новых сервисов на основе JSON-схем. Создана для быстрой генерации сервисов с использованием nsc-toolkit.

Особенности NSC-CLI

Основные возможности

Валидация Схемы: Расширенная валидация предоставленной схемы с детальными сообщениями об ошибках
Генерация Базового Содержания Сервиса: Автоматически создает базовые файлы и структуру для нового сервиса
Неизменяемость Уже Сгенерированных Файлов: Уже сгенерированные файлы не изменяются, только интерфейсы обновляются
Поддержка .nscignore: Можно разместить файл .nscignore в корне сервиса (синтаксис gitignore), и указанные файлы не будут перезаписаны
Использование $ref в Контрактах Методов: В service.schema.json можно описать блок Ref для использования ссылок в контрактах методов
Поддержка ESM модулей: Генерируемые сервисы используют ES Modules (ESM) с полной поддержкой современного синтаксиса импорта/экспорта
Импорт JSON схем: JSON схемы импортируются с использованием with { type: 'json' } для корректной работы в ESM окружении

Качество кода и надежность

Система логирования: Профессиональное логирование с уровнями (DEBUG, INFO, WARN, ERROR, SILENT)
Обработка ошибок: Кастомные классы ошибок для различных сценариев (ValidationError, FileNotFoundError, GenerationError и др.)
Расширенная валидация: Проверка расширений файлов, структуры данных, существования путей
Типобезопасность: Полная типизация TypeScript без использования any
JSDoc документация: Все публичные функции документированы на русском языке
Оптимизация производительности: Кеширование часто используемых операций, асинхронные операции с файловой системой
Безопасность: Защита от command injection в операциях с shell

Структура Команды NSC-CLI

Основная структура команды NSC-CLI выглядит следующим образом:

nsc-cli --schema <путь-к-схеме>

Опции NSC-CLI

Опция	Короткий вариант	Описание	Обязательно	По Умолчанию
`--schema <path>`	`-s <path>`	Путь к файлу JSON-схемы, определяющему сервис для генерации (должен быть .json файл)	Да	N/A
`--prettier-config <path>`	`-p <path>`	Путь к файлу конфигурации prettier	Нет	`.prettierrc.json`
`--verbose`	`-v`	Включить детальное логирование (DEBUG уровень)	Нет	false
`--output <path>`	`-o <path>`	Директория для вывода (по умолчанию директория схемы)	Нет	Директория схемы
`--version`	`-V`	Показать версию утилиты	Нет	N/A
`--help`	`-h`	Отображает справку по команде	Нет	N/A

Примеры Использования NSC-CLI

# Базовое использование
nsc-cli --schema ./services/myService/service.json

# С короткими опциями
nsc-cli -s ./services/myService/service.json

# С детальным логированием
nsc-cli -s ./service.schema.json -v

# С указанием prettier конфигурации
nsc-cli -s ./service.schema.json -p ./.prettierrc

# С указанием директории вывода
nsc-cli -s ./service.schema.json -o ./generated-services

# Показать версию
nsc-cli --version

# Показать справку
nsc-cli --help

Система логирования

NSC-CLI использует продвинутую систему логирования с несколькими уровнями:

DEBUG: Детальная информация для отладки (включается через --verbose или переменную окружения LOG_LEVEL=DEBUG)
INFO: Информационные сообщения о ходе выполнения (по умолчанию)
WARN: Предупреждения о потенциальных проблемах
ERROR: Ошибки выполнения
SILENT: Отключить все логи

Уровень логирования можно контролировать через переменную окружения:

# Включить DEBUG логирование
LOG_LEVEL=DEBUG nsc-cli -s ./service.schema.json

# Отключить все логи
LOG_LEVEL=SILENT nsc-cli -s ./service.schema.json

Эта команда генерирует новый сервис на основе файла service.json, расположенного в директории ./services/myService.

Применение `.nscignore` в NSC-CLI

Вы можете создать файл .nscignore в корне сервиса для указания файлов, которые не должны перезаписываться при генерации. Синтаксис аналогичен файлу .gitignore.

Пример .nscignore:

**/service.ts
**/package.json

В данном примере файлы service.ts и package.json не будут перезаписываться при повторной генерации.

Определение Схемы NSC-CLI

NSC-CLI использует определенную структуру JSON-схемы для генерации необходимых файлов сервиса. Схема определяет свойства сервиса, методы, их запросы и ответы.

Пример Схемы NSC-CLI

{
  "name": "Math",
  "description": "Mathematics service",
  "methods": {
    "Sum": {
      "action": "sum",
      "description": "Addition of two numbers",
      "options": {},
      "request": {
        "type": "object",
        "properties": {
          "a": {
            "type": "number"
          },
          "b": {
            "type": "number"
          }
        },
        "required": [
          "a",
          "b"
        ]
      },
      "response": {
        "type": "object",
        "properties": {
          "result": {
            "type": "number"
          }
        },
        "required": [
          "result"
        ]
      }
    },
    "Fibonacci": {
      "action": "fibonacci",
      "description": "Return Fibonacci sequence given length",
      "options": {
        "useStream": {
          "response": true
        }
      },
      "request": {
        "type": "object",
        "properties": {
          "length": {
            "type": "number"
          }
        },
        "required": [
          "length"
        ]
      },
      "response": {
        "type": "number"
      }
    },
    "SumStream": {
      "action": "sumstream",
      "description": "Adding all the numbers of the stream",
      "options": {
        "useStream": {
          "request": true
        }
      },
      "request": {
        "type": "number"
      },
      "response": {
        "type": "object",
        "properties": {
          "result": {
            "type": "number"
          }
        },
        "required": [
          "result"
        ]
      }
    }
  }
}

Компоненты Схемы NSC-CLI

name: Название сервиса.
description: Описание сервиса.
methods: Определяет методы сервиса с их действиями, описаниями, запросами и ответами.
- action: Действие, выполняемое методом.
- description: Описание метода.
- options: Дополнительные опции для метода (например, использование стримов).
- request: Описание структуры запроса.
  - type: Тип данных (обычно "object").
  - properties: Свойства запроса с их типами.
  - required: Обязательные поля запроса.
- response: Описание структуры ответа.
  - type: Тип данных ответа (может быть объектом или примитивом).
  - properties: Свойства ответа с их типами (если тип — объект).
  - required: Обязательные поля ответа.
definitions: Содержит определения для повторного использования, например, для ссылок $ref.

Использование `$ref` в NSC-CLI

Вы можете использовать $ref для переиспользования определений в схеме. Это полезно для сокращения повторяющегося кода и улучшения структуры схемы.

Пример использования $ref:

{
  "name": "Payments",
  "description": "Сервис payments",
  "methods": {
    "CreatePayment": {
      "action": "createPayment",
      "description": "Создание платежа",
      "request": {
        "type": "object",
        "properties": {
          "paymentProviderType": {
            "enum": ["youkassa"],
            "description": "Платежная система"
          },
          "meta": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "string",
                "description": "Сумма оплаты за заказ"
              },
              "orderNumber": {
                "type": "string",
                "description": "Номер заказа"
              },
              "clientIp": {
                "type": "string",
                "description": "IP Клиента"
              },
              "paymentToken": {
                "type": "string",
                "description": "IP Клиента"
              },
              "paymentType": {
                "type": "string",
                "description": "Пока доступны bank_card и ]yoo_money",

                "enum": [
                  "bank_card",
                  "apple_pay",
                  "google_pay",
                  "yoo_money",
                  "qiwi",
                  "webmoney",
                  "sberbank",
                  "alfabank",
                  "tinkoff_bank",
                  "b2b_sberbank",
                  "sbp",
                  "mobile_balance",
                  "cash",
                  "installments"
                ]
              }
            },
            "required": ["amount", "orderNumber"]
          }
        },
        "required": ["paymentProviderType", "meta"]
      },
      "response": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Уникальный идентификатор платежа"
                  },
                  "status": {
                    "type": ["string", "null"],
                    "description": "Статус платежа"
                  },
                  "paid": {
                    "type": "boolean",
                    "description": "Флаг, указывающий, был ли платеж оплачен"
                  },
                  "amount": {
                    "type": ["object", "null"],
                    "description": "Сумма платежа",
                    "properties": {
                      "value": {
                        "type": "string",
                        "description": "Сумма платежа"
                      },
                      "currency": {
                        "type": "string",
                        "description": "Код валюты"
                      }
                    }
                  },
                  "incomeAmount": {
                    "type": ["object", "null"],
                    "description": "Сумма, зачисленная получателю"
                  },
                  "refundedAmount": {
                    "type": ["object", "null"],
                    "description": "Возвращенная сумма"
                  },
                  "createdAt": {
                    "type": "string",
                    "description": "Дата и время создания платежа"
                  },
                  "expiresAt": {
                    "type": ["string", "null"],
                    "description": "Дата и время истечения платежа"
                  },
                  "capturedAt": {
                    "type": ["string", "null"],
                    "description": "Дата и время подтверждения платежа"
                  },
                  "description": {
                    "type": "string",
                    "description": "Описание платежа"
                  },
                  "paymentToken": {
                    "type": "string",
                    "description": "Токен платежа"
                  },
                  "paymentMethodId": {
                    "type": "string",
                    "description": "Идентификатор способа оплаты"
                  },
                  "paymentMethodData": {
                    "type": ["object", "null"],
                    "description": "Данные способа оплаты"
                  },
                  "paymentMethod": {
                    "type": ["object", "null"],
                    "description": "Метод оплаты"
                  },
                  "recipient": {
                    "type": ["object", "null"],
                    "description": "Получатель платежа",
                    "properties": {
                      "account_id": {
                        "type": "string",
                        "description": "Идентификатор учетной записи получателя"
                      },
                      "gateway_id": {
                        "type": "string",
                        "description": "Идентификатор шлюза получателя"
                      }
                    }
                  },
                  "confirmation": {
                    "type": ["object", "null"],
                    "description": "Подтверждение платежа",
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "Тип подтверждения"
                      },
                      "confirmation_url": {
                        "type": "string",
                        "description": "URL для подтверждения платежа"
                      }
                    }
                  },
                  "refundable": {
                    "type": "boolean",
                    "description": "Флаг, указывающий, можно ли вернуть платеж"
                  },
                  "clientIp": {
                    "type": "string",
                    "description": "IP-адрес клиента"
                  },
                  "receipt": {
                    "type": ["object", "null"],
                    "description": "Квитанция"
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Дополнительные данные"
                  }
                },
                "required": [
                  "id",
                  "paid",
                  "createdAt",
                  "description",
                  "paymentToken",
                  "paymentMethodId",
                  "refundable",
                  "clientIp",
                  "metadata"
                ]
              }
            },
            "required": ["data"]
          },

          {
            "type": "object",
            "properties": {
              "error": {
                "$ref": "PaymentsServiceAdditional.json#/properties/ErrorResponse"
              }
            },
            "required": ["error"]
          }
        ]
      }
    },
    "PaymentCallbackRequest": {
      "action": "paymentCallbackRequest",
      "description": "Обработка веб хука оплаты",
      "request": {
        "$ref": "PaymentsServiceAdditional.json#/properties/PaymentCallback"
      },
      "response": {
        "oneOf": [
          {
            "type": "object",
            "properties": {}
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "$ref": "PaymentsServiceAdditional.json#/properties/ErrorResponse"
              }
            },
            "required": ["error"]
          }
        ]
      }
    }
  },
  "Ref": {
    "$id": "PaymentsServiceAdditional.json",
    "type": "object",
    "properties": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 8,
            "maxLength": 255
          },
          "message": {
            "type": "string",
            "minLength": 8,
            "maxLength": 255
          },
          "statusCode": {
            "type": "number",
            "description": "HTTP код ошибки",
            "minimum": 100,
            "maximum": 511
          }
        },
        "required": ["message"]
      },
      "pagination": {
        "type": "object",
        "properties": {
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "Номер страницы"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "description": "Размер страницы"
          },
          "total": {
            "type": "integer",}
    }
  },
  "events": {
    "list": {
      "PaymentUpdateEvent": {
        "action": "PaymentUpdateEvent",
        "description": "Событие изменения соcтояния оплаты",
        "event": {
          "type": "object",
          "properties": {
            "event": {
              "type": "string",
              "enum": ["payment.waiting_for_capture", "payment.succeeded", "payment.canceled", "refund.succeeded"],
              "description": "Событие, например, 'payment.succeeded' или 'payment.canceled'."
            },
            "id": {
              "type": "string",
              "description": "Уникальный идентификатор платежа в системе ЮKassa."
            },
            "orderNumber": {
              "type": "string",
              "description": "Уникальный идентификатор платежа в системе ЮKassa."
            },

            "status": {
              "type": "string",
              "description": "Статус платежа, например, 'succeeded' или 'canceled'."
            },
            "amount": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Сумма платежа в виде строки для поддержки формата денежных значений."
                },
                "currency": {
                  "type": "string",
                  "description": "Валюта платежа, например, 'RUB'."
                }
              },
              "required": ["value", "currency"],
              "additionalProperties": false
            },
            "created": {
              "type": "string",
              "format": "date-time",
              "description": "Дата и время создания платежа в формате ISO 8601."
            },
            "description": {
              "type": "string",
              "description": "Описание платежа, если указано.",
              "nullable": true
            }
          },
          "required": ["event", "id", "orderNumber", "status", "amount", "created", "description"]
        }
      }
    },
    "streamOptions": {
      "prefix": "stream",
      "actions": [
        {
          "action": "*",
          "storage": "file",
          "retentionPolicy": "limits",
          "discardPolicy": "old",
          "messageTTL": 1209600,
          "duplicateTrackingTime": 86400,
          "replication": 1,
          "rollUps": true
        }
      ]
    }
  }
}

В данном примере ответ метода CreatePayment ссылается на определение ErrorResponse, что позволяет избежать повторения структуры объекта.

Генерируемые Файлы NSC-CLI

После успешной валидации схемы, NSC-CLI генерирует несколько важных файлов для создания нового сервиса с использованием современных стандартов ES Modules. Ниже приведен список генерируемых файлов и их назначение:

Базовые Файлы Сервиса:
- service.ts: Основной файл сервиса с импортом JSON схемы через ESM (import serviceSchema from './service.schema.json' with { type: 'json' }). Содержит функцию main() для инициализации сервиса и подключения к NATS с настройками по умолчанию.
- start.ts: Точка входа для запуска сервиса. Вызывает функцию main() из service.ts и обрабатывает ошибки.
- index.ts: Основной индексный файл с экспортом клиента сервиса. Создает класс-клиент для взаимодействия с сервисом через NATS.
- package.json: Файл конфигурации npm пакета с настройками ESM модулей.
Методы Сервиса:
- methods/{MethodName}/index.ts: Реализация каждого метода сервиса.
- methods/{MethodName}/index.test.ts: Шаблон тестового файла для метода.
Конфигурационные Файлы:
- tsconfig.json: Файл конфигурации TypeScript (если не существует).
Файлы Интерфейсов и Типов:
- interfaces.ts: TypeScript интерфейсы, определяющие структуру запросов и ответов.
Схема Сервиса:
- service.schema.json: JSON схема сервиса, импортируемая через ESM с with { type: 'json' }.

Структура package.json для ESM

Генерируемый package.json включает следующие настройки для поддержки ESM:

{
  "type": "module",
  "main": "./dist/start.js",
  "scripts": {
    "start": "npx tsx start.ts",
    "build": "rm -rf ./dist && npx tsc"
  },
  "exports": {
    ".": {
      "import": "./dist/index.js",
      "types": "./dist/index.d.ts"
    },
    "./interfaces": "./dist/interfaces.js",
    "./schema": "./dist/service.schema.json",
    "./*": {
      "types": "./dist/*.d.ts"
    }
  }
}

Импорт JSON схемы

JSON схема импортируется как default import с использованием import attributes:

import serviceSchema from './service.schema.json' with { type: 'json' };
const { name, methods, events } = serviceSchema;

Примечание: Точная структура и наименование генерируемых файлов могут варьироваться в зависимости от конвенций проекта и конкретных деталей реализации NSC-CLI.

Name		Name	Last commit message	Last commit date
Latest commit History 112 Commits
.cursor/rules		.cursor/rules
.github/workflows		.github/workflows
fakeServicesDirectory		fakeServicesDirectory
src		src
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.npmignore		.npmignore
.prettierrc.json		.prettierrc.json
.releaserc		.releaserc
.releaserc.json		.releaserc.json
README.md		README.md
commitlint.config.cjs		commitlint.config.cjs
lefthook.yml		lefthook.yml
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

lad-tech/nsc-cli

Folders and files

Latest commit

History

Repository files navigation

Содержание

Введение

⚠️ Breaking Changes в версиях выше 1.0.0

Миграция на ESM модули

Что изменилось:

Преимущества новой версии:

Миграция существующих проектов

Установка

Требования

NSC-CRUD

Особенности NSC-CRUD

Использование NSC-CRUD

Структура Команды NSC-CRUD

Опции NSC-CRUD

Пример Использования NSC-CRUD

Определение Схемы NSC-CRUD

Пример Схемы NSC-CRUD

Компоненты Схемы NSC-CRUD

Валидация Схемы NSC-CRUD

Генерируемые Файлы NSC-CRUD

NSC-CLI

Особенности NSC-CLI

Основные возможности

Качество кода и надежность

Структура Команды NSC-CLI

Опции NSC-CLI

Примеры Использования NSC-CLI

Система логирования

Применение .nscignore в NSC-CLI

Определение Схемы NSC-CLI

Пример Схемы NSC-CLI

Компоненты Схемы NSC-CLI

Использование $ref в NSC-CLI

Генерируемые Файлы NSC-CLI

Структура package.json для ESM

Импорт JSON схемы

About

Resources

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases 46

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

Применение `.nscignore` в NSC-CLI

Использование `$ref` в NSC-CLI

Packages