Чтение: диагностика и справка
Инструменты чтения: состояние проектов, замечания проверок, описания проверок, справка по инструментам и свойствам, Синтакс-помощник платформы.
Эти инструменты возвращают состояние проектов рабочей области и замечания проверок, а также справочные сведения: описания проверок, схемы инструментов, свойства, которые принимают инструменты записи, и Синтакс-помощник платформы.
| Инструмент | Что возвращает |
|---|---|
edt_projects · edt_project_errors |
Проекты рабочей области и замечания Eclipse и проверок EDT. modelReady показывает готовность BM-модели и производных данных; complete=false обозначает неполный снимок, который нельзя считать результатом успешной проверки. Фильтры: fqn, modulePath, severity; countOnly возвращает счетчики, а диагностику готовности – только при неполном результате или с details=true; brief – по строке на замечание. modulePath включает маркеры EDT, сопоставленные с файлами; несопоставленные маркеры отмечаются счетчиком и подсказкой. Фильтр формы исключает соседние формы. stale обозначает маркер старше исходника, unsynchronized – изменение на диске, еще не прочитанное средой. leftover отмечает маркер старше своего файла, который EDT не обновил при повторной проверке файла: EDT оставляет маркер проверки запроса, когда в схеме компоновки этой проблемы уже нет. Такой маркер не делает снимок неполным и не требует исправления; leftoverCount считает их. refresh=true перечитывает область и запускает сборку; waitSeconds задает ожидание валидации (1-600, по умолчанию 120). При таймауте возвращаются текущие маркеры с refreshed.settled=false. Проверка сгенерированного кода должна включать WARNING: часть неопределенных методов EDT относит к предупреждениям. |
edt_support_status |
Проверка разрешения EDT на прямое редактирование объекта (projectName, objectFqn). Возвращает EDITABLE, READ_ONLY или UNKNOWN; недоступная служба не означает разрешение на запись. Проверка не блокирует объект. |
edt_compare_configurations · edt_comparison_details |
Сравнивают открытые проекты конфигурации или их ревизии Git средствами EDT. Поддерживают общего предка, счетчики, список измененных объектов и детализацию до методов BSL. |
edt_check_info |
Возвращает описание проверки, примеры неправильного и правильного кода и ссылки на стандарты разработки 1С на русском или английском языке. Инструмент дополняет edt_project_errors, который указывает сработавшую проверку. Поиск выполняется по идентификатору или заголовку проверки. Короткий код вида SU68 разрешается в проверку, если в projectName назван проект, сообщивший о проблеме. |
edt_tool_help |
Без tool перечисляет инструменты действующего набора с краткими описаниями. С именем инструмента возвращает описание, схему и доступность. brief=true возвращает сигнатуру с именами и типами аргументов. Звездочка отмечает обязательный аргумент. |
edt_property_reference |
Перечисляет доступные для записи свойства общего модуля, внешнего объекта, расширения, реквизита, управляемой формы, элемента формы или команды формы. Показывает тип, допустимые значения, текущее значение и инструмент записи. Для формы без item и command возвращает свойства самой формы, а также items и commands; параметр command описывает команду формы. Перечень строит код проверки записи, поэтому свойства, которого у объекта нет, в перечне нет. |
edt_platform_help |
Выполняет поиск по имени или возвращает текст страницы Синтакс-помощника платформы 1С:Предприятие из поставки EDT. Справка на русском и английском языках содержит объекты, методы, свойства, события и сигнатуры методов. |
Диагностика проекта и среды
edt_projects возвращает состояние модели в поле diagnostics каждого проекта, для которого
доступны эти сведения. В pendingReasons перечислены условия ожидания, например блокировка
модели или вычисление производных данных. В derivedData видны этап обработки и сведения EDT
об активных сегментах. backgroundJobs относится ко всей рабочей области.
edt_project_errors возвращает diagnostics.pendingReasons, фоновые работы, состояние
валидации и наблюдаемое число замечаний. Проверка объекта может завершиться, пока фоновые
работы еще выполняются. Чтобы прочитать текущее состояние, вызовите инструмент снова без
refresh и baseline. Полноту результата определяет complete. После обновления учитывайте
также refreshed.settled.
Время наблюдения указано в миллисекундах от начала эпохи Unix. firstObservedAt отмечает
первое наблюдение в сохраненной истории, а unchangedSince – первое наблюдение текущего
значения. При первом чтении lastChangeKnown=false. После обнаружения другого значения
lastChangeObservedAt указывает время, когда мост заметил разницу. История ограничена текущим
процессом. Для недоступных показателей EDT возвращаются available=false и unavailableReason.
GET /status возвращает resources работающего моста. В jvm указаны использование,
выделенная память и доступный предел для кучи и памяти вне кучи, а также число и длительность
сборок мусора по каждому сборщику JVM. На Linux раздел container показывает использование
и пределы памяти, события, давление памяти, квоту и счетчики ЦП текущей группы cgroup v2,
если они доступны для чтения. Снимок собирается чтением JVM и cgroup. Для недоступных
показателей указана причина. processStartedAt хранит время запуска текущего процесса.
previousExitCause имеет значение unknown.
Под тяжелыми вызовами /status ждет состояние модели, задания рабочей области, resources и
число инструментов не дольше полутора секунд. Если они не успели, ответ их не содержит, в нем
busy=true, а открытые проекты перечислены с modelReady=null.
Проверка одного объекта
При точном fqn или modulePath вызов edt_project_errors с refresh=true явно запрашивает
применимые проверки одного BM-объекта и его модулей BSL, включая модуль управляемой формы.
Неразрешенный или противоречивый адрес не расширяет этот запрос до всего проекта. Изменения модели
формы через мост также ставят в очередь перепроверку ее модуля и перепроверяются при следующем
общем refresh=true, чтобы проверки BSL вроде SU243 отражали актуальный Form.form.
validationRequested и validationCompleted отражают запрос и завершение проверки. Одни счетчики
или непроверенная часть ограниченной выборки не подтверждают свежесть маркеров.
Снимки замечаний
Для сравнения замечаний вызовите edt_project_errors с baseline="save", а после правки – с
baseline="compare" и полученным baselineId. Обе операции обновляют область и ждут завершения
валидации, даже если refresh не передан. В обоих вызовах должны совпадать проект и фильтры
области. Сравнение возвращает только новые замечания, счетчики исправленных и resolvedProblems;
limit, brief и countOnly управляют представлением ответа. Сдвиг строки не превращает
прежнее замечание в новое; одинаковые замечания учитываются как отдельные вхождения. Неполные
и усеченные исходные результаты отклоняются. Снимки живут только в текущем процессе моста;
перезапуск EDT делает их недоступными. В памяти хранятся не более 16 снимков и 200000 маркеров
суммарно, не более 100000 маркеров на снимок. При сохранении возвращаются id вытесненных снимков.
Сравнение конфигураций
Передайте в edt_compare_configurations стороны main и other. Для каждой
укажите projectName открытого проекта конфигурации и при необходимости
revision – ссылку на локальную ревизию Git этого проекта. Без revision
используется живая модель. Для трехстороннего сравнения добавьте ancestor
с теми же полями. При обновлении конфигурации укажите доработанный проект
как main, новую ревизию поставщика как other, прежнюю как ancestor.
EDT выполняет сравнение в режиме чтения. Для больших проектов передайте
async=true и опрашивайте edt_job_status. Результат содержит итоговые
счетчики и страницу объектов. Чтобы получить следующую страницу, передайте
comparisonId и значение nextOffset в параметре offset. Для просмотра
деталей передайте index объекта в edt_comparison_details как objectIndex.
Чтобы раскрыть строку с hasDetails=true, добавьте ее index в nodeIndices.
Детали модулей включают изменения методов BSL, если EDT разобрала структуру модуля.
Сводка считает объекты метаданных с различиями в EDT. В нее входят изменения
порядка, отмеченные EDT, и изменения настроек поставки и поддержки. На каждый
объект приходится одна строка, даже если изменилось несколько свойств, модулей
или методов. Отчет /CompareCfg сравнивает конфигурации платформы и может
давать другие счетчики.
Сервер хранит до четырех результатов сравнения в течение 30 минут. После истечения срока выполните сравнение повторно.