bslfmt 0.20.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bslfmt-0.20.1/LICENSE +202 -0
- bslfmt-0.20.1/NOTICE +40 -0
- bslfmt-0.20.1/PKG-INFO +180 -0
- bslfmt-0.20.1/README.md +152 -0
- bslfmt-0.20.1/pyproject.toml +40 -0
- bslfmt-0.20.1/setup.cfg +4 -0
- bslfmt-0.20.1/src/bslfmt/__init__.py +6 -0
- bslfmt-0.20.1/src/bslfmt/__main__.py +295 -0
- bslfmt-0.20.1/src/bslfmt/formatter.py +1194 -0
- bslfmt-0.20.1/src/bslfmt/lexer.py +345 -0
- bslfmt-0.20.1/src/bslfmt.egg-info/PKG-INFO +180 -0
- bslfmt-0.20.1/src/bslfmt.egg-info/SOURCES.txt +16 -0
- bslfmt-0.20.1/src/bslfmt.egg-info/dependency_links.txt +1 -0
- bslfmt-0.20.1/src/bslfmt.egg-info/entry_points.txt +2 -0
- bslfmt-0.20.1/src/bslfmt.egg-info/top_level.txt +1 -0
- bslfmt-0.20.1/tests/test_cli.py +186 -0
- bslfmt-0.20.1/tests/test_formatter.py +1379 -0
- bslfmt-0.20.1/tests/test_lexer.py +255 -0
bslfmt-0.20.1/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Andrey Azeev
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
bslfmt-0.20.1/NOTICE
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
bslfmt — детерминированный форматтер структурных отступов BSL
|
|
2
|
+
Copyright 2026 Andrey Azeev
|
|
3
|
+
|
|
4
|
+
Этот продукт распространяется по лицензии Apache License 2.0.
|
|
5
|
+
Полный текст — в файле LICENSE.
|
|
6
|
+
|
|
7
|
+
--------------------------------------------------------------------------------
|
|
8
|
+
Отношение к фирме «1С»
|
|
9
|
+
--------------------------------------------------------------------------------
|
|
10
|
+
|
|
11
|
+
Проект разработан независимо и НЕ аффилирован с ООО «1С», не одобрен и не
|
|
12
|
+
поддерживается ею.
|
|
13
|
+
|
|
14
|
+
«1С», «1С:Предприятие» и связанные с ними обозначения являются товарными
|
|
15
|
+
знаками ООО «1С». Лицензия Apache License 2.0 (раздел 6) прав на эти товарные
|
|
16
|
+
знаки не предоставляет: они упоминаются здесь исключительно для указания на
|
|
17
|
+
совместимость и по назначению.
|
|
18
|
+
|
|
19
|
+
--------------------------------------------------------------------------------
|
|
20
|
+
Что НЕ входит в этот репозиторий
|
|
21
|
+
--------------------------------------------------------------------------------
|
|
22
|
+
|
|
23
|
+
Репозиторий не содержит и не распространяет:
|
|
24
|
+
|
|
25
|
+
* справку платформы «1С:Предприятие» (`*.hbk`) — ни в исходном виде, ни
|
|
26
|
+
разобранной. Это контент ООО «1С»;
|
|
27
|
+
* модули, выгрузки и файлы конкретных конфигураций (`.bsl`, `.cf`, `.cfe`,
|
|
28
|
+
`.dt`, `.epf`).
|
|
29
|
+
|
|
30
|
+
Тесты и фикстуры содержат только синтетические примеры кода.
|
|
31
|
+
|
|
32
|
+
Лицензия Apache License 2.0 распространяется на код этого репозитория и не
|
|
33
|
+
затрагивает прав на код, который пользователь форматирует с его помощью.
|
|
34
|
+
|
|
35
|
+
--------------------------------------------------------------------------------
|
|
36
|
+
Сторонние зависимости
|
|
37
|
+
--------------------------------------------------------------------------------
|
|
38
|
+
|
|
39
|
+
Зависимостей времени выполнения нет. Для сборки используется setuptools
|
|
40
|
+
(MIT License); он устанавливается отдельно и в репозиторий не входит.
|
bslfmt-0.20.1/PKG-INFO
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: bslfmt
|
|
3
|
+
Version: 0.20.1
|
|
4
|
+
Summary: Детерминированный форматтер кода 1С (BSL): отступы и пробелы по стандартам 1С
|
|
5
|
+
Author: AzeevAN
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/AzeevAN/bslfmt
|
|
8
|
+
Project-URL: Repository, https://github.com/AzeevAN/bslfmt
|
|
9
|
+
Project-URL: Changelog, https://github.com/AzeevAN/bslfmt/blob/main/CHANGELOG.md
|
|
10
|
+
Project-URL: Issues, https://github.com/AzeevAN/bslfmt/issues
|
|
11
|
+
Keywords: 1c,1c-enterprise,bsl,formatter,1с,форматтер
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Natural Language :: Russian
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Software Development :: Code Generators
|
|
23
|
+
Requires-Python: >=3.10
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
License-File: LICENSE
|
|
26
|
+
License-File: NOTICE
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# bslfmt
|
|
30
|
+
|
|
31
|
+
Детерминированный форматтер структурных отступов BSL. Проект работает как
|
|
32
|
+
Python-библиотека и CLI; интеграция с MCP 1C будет отдельным потребителем пакета.
|
|
33
|
+
|
|
34
|
+
## Границы
|
|
35
|
+
|
|
36
|
+
Форматтер приводит отступы и форматирование поддерживаемых операторов. Он
|
|
37
|
+
сохраняет значимые токены и порядок кода, строк, комментариев и директив. Он не
|
|
38
|
+
проверяет синтаксис BSL и не компилирует модули. Если структурное форматирование
|
|
39
|
+
небезопасно, команда завершает работу с диагностикой, не перезаписывая источник.
|
|
40
|
+
|
|
41
|
+
## Стиль форматирования
|
|
42
|
+
|
|
43
|
+
Стиль один, настроек нет. Он следует стандартам 1С «Тексты модулей» (std456) и
|
|
44
|
+
«Перенос выражений» (std444) и практике типовых конфигураций.
|
|
45
|
+
|
|
46
|
+
- **Отступы** — табуляцией, по вложенности блоков: процедуры и функции,
|
|
47
|
+
`Если`/`ИначеЕсли`/`Иначе`, циклы, `Попытка`/`Исключение`. Английские и
|
|
48
|
+
смешанные ключевые слова распознаются.
|
|
49
|
+
- **С колонки 0** — `Процедура`/`Функция` и их концы, аннотации
|
|
50
|
+
(`&НаСервере`…), директивы препроцессора (`#Область`, `#Если`…, в том числе
|
|
51
|
+
внутри процедур), переменные и код модуля вне процедур.
|
|
52
|
+
- **Строки продолжения** выражений и параметров — не меньше чем +1 отступ к
|
|
53
|
+
инструкции; более глубокий отступ (выравнивание по скобке или первому
|
|
54
|
+
операнду) сохраняется. На уровне инструкции остаются строка, начинающаяся
|
|
55
|
+
с `)`, и текст запроса сразу после `=`. Строки `И`/`Или` многострочного
|
|
56
|
+
условия — не меньше чем +1 к `Если`.
|
|
57
|
+
- **Многострочные строки**: строки `|` сдвигаются вместе со строкой, где
|
|
58
|
+
начался литерал; пробелы перед `|` не входят в значение строки.
|
|
59
|
+
- **Комментарии** `//` встают на отступ следующей строки кода. Комментарий в
|
|
60
|
+
колонке 0 (маркеры доработок `//!`, `//++`, закомментированный код)
|
|
61
|
+
остаётся в колонке 0. Текст комментариев не меняется.
|
|
62
|
+
- **Пробелы**: вокруг бинарных операторов (`=`, `<>`, `+`, `%`…), после
|
|
63
|
+
запятой; без пробелов перед `,` `;` `)` и после `(`. Лишние пробелы внутри
|
|
64
|
+
строки схлопываются, хвостовые удаляются; выравнивание табами внутри строки
|
|
65
|
+
заменяется одним пробелом.
|
|
66
|
+
- **Пустые строки**: не больше одной подряд. Строки из одних пробелов и табов
|
|
67
|
+
(так их заполняет конфигуратор) не очищаются.
|
|
68
|
+
- **Методы расширений** с `&ИзменениеИКонтроль` форматируются как обычный
|
|
69
|
+
код: платформа не сверяет пробелы и табы в контролируемых строках.
|
|
70
|
+
- **Не трогаются**: строки и даты, текст комментариев, области
|
|
71
|
+
`#Вставка`/`#Удаление`, регистр букв, порядок и перенос кода (длинные
|
|
72
|
+
строки не переносятся).
|
|
73
|
+
|
|
74
|
+
## Установка
|
|
75
|
+
|
|
76
|
+
Нужен Python 3.10+ или [uv](https://docs.astral.sh/uv/) — он сам скачает
|
|
77
|
+
Python. Пакет без зависимостей, одинаков для Windows, macOS и Linux.
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
uv tool install bslfmt # команда bslfmt в терминале (рекомендуется)
|
|
81
|
+
pipx install bslfmt # то же через pipx
|
|
82
|
+
uvx bslfmt Модуль.bsl # разовый запуск без установки
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Установить `uv`: Windows — `winget install astral-sh.uv` (или
|
|
86
|
+
`powershell -c "irm https://astral.sh/uv/install.ps1 | iex"`); macOS —
|
|
87
|
+
`brew install uv`; macOS и Linux — `curl -LsSf https://astral.sh/uv/install.sh | sh`.
|
|
88
|
+
Обновление: `uv tool upgrade bslfmt` (или `pipx upgrade bslfmt`).
|
|
89
|
+
|
|
90
|
+
### Для агентов и хуков
|
|
91
|
+
|
|
92
|
+
Форматировать файл на месте — одна команда, модуль через контекст агента не
|
|
93
|
+
передаётся:
|
|
94
|
+
|
|
95
|
+
```sh
|
|
96
|
+
uvx bslfmt -i Модуль.bsl # отформатировать файл (uv сам поставит пакет)
|
|
97
|
+
uvx bslfmt --check Модуль.bsl # код выхода 1 — файл нужно отформатировать
|
|
98
|
+
uvx bslfmt -i -sbc Модуль.bsl # и удалить комментарии внутри методов
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Если пакет установлен (`uv tool install bslfmt`), то же без `uvx`. Вывод —
|
|
102
|
+
UTF-8; сводка на файл: `ФАЙЛ: изменён (строк: N)` или `ФАЙЛ: без изменений`.
|
|
103
|
+
|
|
104
|
+
## Установка для разработки
|
|
105
|
+
|
|
106
|
+
```sh
|
|
107
|
+
python -m venv .venv
|
|
108
|
+
. .venv/bin/activate
|
|
109
|
+
python -m pip install -e .
|
|
110
|
+
python -m unittest discover -s tests -v
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Команда `bslfmt` появляется в активном окружении.
|
|
114
|
+
|
|
115
|
+
CI (GitHub Actions) прогоняет тесты на Windows, macOS и Linux и проверяет
|
|
116
|
+
установленную команду: `python tests/cli_smoke.py` после `pip install .`.
|
|
117
|
+
|
|
118
|
+
## CLI
|
|
119
|
+
|
|
120
|
+
```sh
|
|
121
|
+
bslfmt Модуль.bsl # результат на экран, файл не меняется
|
|
122
|
+
bslfmt -i Модуль.bsl Форма.bsl # отформатировать файлы на месте
|
|
123
|
+
bslfmt --check Модуль.bsl Форма.bsl # только проверить (для CI и хуков)
|
|
124
|
+
bslfmt --check --diff Модуль.bsl # проверить и показать различия
|
|
125
|
+
bslfmt Модуль.bsl --output Новый.bsl # записать результат в новый файл
|
|
126
|
+
bslfmt - < Модуль.bsl # стандартный ввод
|
|
127
|
+
bslfmt -i -sbc Модуль.bsl # и удалить комментарии внутри методов
|
|
128
|
+
bslfmt --help # справка по всем режимам
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
`-i` переписывает только файлы, которым нужна правка: запись атомарная
|
|
132
|
+
(временный файл рядом и замена), при отказе форматирования файл не меняется.
|
|
133
|
+
Сводка на каждый файл: `ФАЙЛ: изменён (строк: N)` или `ФАЙЛ: без изменений`.
|
|
134
|
+
Файл только для чтения не переписывается (ошибка, код 2). `--` завершает
|
|
135
|
+
флаги: `bslfmt --check -- -файл.bsl`.
|
|
136
|
+
`-sbc`, `--strip-body-comments` (с любым режимом) удаляет строки-комментарии внутри
|
|
137
|
+
процедур и функций — закомментированный код, маркеры доработок, пояснения.
|
|
138
|
+
Комментарии в конце строки кода, над методами, внутри строк (текстов
|
|
139
|
+
запросов) и областей `#Вставка`/`#Удаление` остаются. Без ключа комментарии
|
|
140
|
+
не удаляются.
|
|
141
|
+
`--check` ничего не записывает и перечисляет файлы, которые нужно
|
|
142
|
+
отформатировать. Несколько файлов — только с `-i`, `--check` или `--diff`;
|
|
143
|
+
каждый обрабатывается отдельно. `--output` создаёт новый файл и отказывается
|
|
144
|
+
перезаписывать существующий.
|
|
145
|
+
|
|
146
|
+
Ввод и вывод (текст, различия, сводка, ошибки) — UTF-8 на любой ОС; переводы
|
|
147
|
+
строк и BOM сохраняются как в исходнике.
|
|
148
|
+
|
|
149
|
+
Коды выхода (худший по всем файлам): `0` — успех (при `--check` — всё
|
|
150
|
+
отформатировано); `1` — `--check` нашёл файлы для форматирования; `2` —
|
|
151
|
+
ошибка аргументов, чтения или записи, неверная кодировка или отказ
|
|
152
|
+
форматирования (сообщение в stderr с именем файла и номером строки, если он
|
|
153
|
+
известен); `3` — внутренняя ошибка форматтера.
|
|
154
|
+
|
|
155
|
+
## Python API
|
|
156
|
+
|
|
157
|
+
```python
|
|
158
|
+
from bslfmt import format_code
|
|
159
|
+
|
|
160
|
+
formatted = format_code(source)
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Для недоверенного ввода есть лимиты: `max_chars` — длина исходника
|
|
164
|
+
(по умолчанию 20 000 000 символов), `max_depth` — вложенность блоков
|
|
165
|
+
(по умолчанию 100). При превышении — `FormatError`; `None` отключает лимит.
|
|
166
|
+
|
|
167
|
+
```python
|
|
168
|
+
formatted = format_code(source, max_chars=1_000_000, max_depth=50)
|
|
169
|
+
cleaned = format_code(source, strip_body_comments=True)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Сервису, который принимает код извне, стоит также запускать форматирование в
|
|
173
|
+
отдельном процессе с ограничением памяти и времени.
|
|
174
|
+
|
|
175
|
+
Поддерживаемые функции и ограничения уточняются по синтетическим тестам в
|
|
176
|
+
`tests/`; локальные корпуса и конфигурации в репозиторий не входят.
|
|
177
|
+
|
|
178
|
+
## Лицензия
|
|
179
|
+
|
|
180
|
+
Apache License 2.0 — см. `LICENSE` и `NOTICE`. Проект не аффилирован с ООО «1С».
|
bslfmt-0.20.1/README.md
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# bslfmt
|
|
2
|
+
|
|
3
|
+
Детерминированный форматтер структурных отступов BSL. Проект работает как
|
|
4
|
+
Python-библиотека и CLI; интеграция с MCP 1C будет отдельным потребителем пакета.
|
|
5
|
+
|
|
6
|
+
## Границы
|
|
7
|
+
|
|
8
|
+
Форматтер приводит отступы и форматирование поддерживаемых операторов. Он
|
|
9
|
+
сохраняет значимые токены и порядок кода, строк, комментариев и директив. Он не
|
|
10
|
+
проверяет синтаксис BSL и не компилирует модули. Если структурное форматирование
|
|
11
|
+
небезопасно, команда завершает работу с диагностикой, не перезаписывая источник.
|
|
12
|
+
|
|
13
|
+
## Стиль форматирования
|
|
14
|
+
|
|
15
|
+
Стиль один, настроек нет. Он следует стандартам 1С «Тексты модулей» (std456) и
|
|
16
|
+
«Перенос выражений» (std444) и практике типовых конфигураций.
|
|
17
|
+
|
|
18
|
+
- **Отступы** — табуляцией, по вложенности блоков: процедуры и функции,
|
|
19
|
+
`Если`/`ИначеЕсли`/`Иначе`, циклы, `Попытка`/`Исключение`. Английские и
|
|
20
|
+
смешанные ключевые слова распознаются.
|
|
21
|
+
- **С колонки 0** — `Процедура`/`Функция` и их концы, аннотации
|
|
22
|
+
(`&НаСервере`…), директивы препроцессора (`#Область`, `#Если`…, в том числе
|
|
23
|
+
внутри процедур), переменные и код модуля вне процедур.
|
|
24
|
+
- **Строки продолжения** выражений и параметров — не меньше чем +1 отступ к
|
|
25
|
+
инструкции; более глубокий отступ (выравнивание по скобке или первому
|
|
26
|
+
операнду) сохраняется. На уровне инструкции остаются строка, начинающаяся
|
|
27
|
+
с `)`, и текст запроса сразу после `=`. Строки `И`/`Или` многострочного
|
|
28
|
+
условия — не меньше чем +1 к `Если`.
|
|
29
|
+
- **Многострочные строки**: строки `|` сдвигаются вместе со строкой, где
|
|
30
|
+
начался литерал; пробелы перед `|` не входят в значение строки.
|
|
31
|
+
- **Комментарии** `//` встают на отступ следующей строки кода. Комментарий в
|
|
32
|
+
колонке 0 (маркеры доработок `//!`, `//++`, закомментированный код)
|
|
33
|
+
остаётся в колонке 0. Текст комментариев не меняется.
|
|
34
|
+
- **Пробелы**: вокруг бинарных операторов (`=`, `<>`, `+`, `%`…), после
|
|
35
|
+
запятой; без пробелов перед `,` `;` `)` и после `(`. Лишние пробелы внутри
|
|
36
|
+
строки схлопываются, хвостовые удаляются; выравнивание табами внутри строки
|
|
37
|
+
заменяется одним пробелом.
|
|
38
|
+
- **Пустые строки**: не больше одной подряд. Строки из одних пробелов и табов
|
|
39
|
+
(так их заполняет конфигуратор) не очищаются.
|
|
40
|
+
- **Методы расширений** с `&ИзменениеИКонтроль` форматируются как обычный
|
|
41
|
+
код: платформа не сверяет пробелы и табы в контролируемых строках.
|
|
42
|
+
- **Не трогаются**: строки и даты, текст комментариев, области
|
|
43
|
+
`#Вставка`/`#Удаление`, регистр букв, порядок и перенос кода (длинные
|
|
44
|
+
строки не переносятся).
|
|
45
|
+
|
|
46
|
+
## Установка
|
|
47
|
+
|
|
48
|
+
Нужен Python 3.10+ или [uv](https://docs.astral.sh/uv/) — он сам скачает
|
|
49
|
+
Python. Пакет без зависимостей, одинаков для Windows, macOS и Linux.
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
uv tool install bslfmt # команда bslfmt в терминале (рекомендуется)
|
|
53
|
+
pipx install bslfmt # то же через pipx
|
|
54
|
+
uvx bslfmt Модуль.bsl # разовый запуск без установки
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Установить `uv`: Windows — `winget install astral-sh.uv` (или
|
|
58
|
+
`powershell -c "irm https://astral.sh/uv/install.ps1 | iex"`); macOS —
|
|
59
|
+
`brew install uv`; macOS и Linux — `curl -LsSf https://astral.sh/uv/install.sh | sh`.
|
|
60
|
+
Обновление: `uv tool upgrade bslfmt` (или `pipx upgrade bslfmt`).
|
|
61
|
+
|
|
62
|
+
### Для агентов и хуков
|
|
63
|
+
|
|
64
|
+
Форматировать файл на месте — одна команда, модуль через контекст агента не
|
|
65
|
+
передаётся:
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
uvx bslfmt -i Модуль.bsl # отформатировать файл (uv сам поставит пакет)
|
|
69
|
+
uvx bslfmt --check Модуль.bsl # код выхода 1 — файл нужно отформатировать
|
|
70
|
+
uvx bslfmt -i -sbc Модуль.bsl # и удалить комментарии внутри методов
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Если пакет установлен (`uv tool install bslfmt`), то же без `uvx`. Вывод —
|
|
74
|
+
UTF-8; сводка на файл: `ФАЙЛ: изменён (строк: N)` или `ФАЙЛ: без изменений`.
|
|
75
|
+
|
|
76
|
+
## Установка для разработки
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
python -m venv .venv
|
|
80
|
+
. .venv/bin/activate
|
|
81
|
+
python -m pip install -e .
|
|
82
|
+
python -m unittest discover -s tests -v
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Команда `bslfmt` появляется в активном окружении.
|
|
86
|
+
|
|
87
|
+
CI (GitHub Actions) прогоняет тесты на Windows, macOS и Linux и проверяет
|
|
88
|
+
установленную команду: `python tests/cli_smoke.py` после `pip install .`.
|
|
89
|
+
|
|
90
|
+
## CLI
|
|
91
|
+
|
|
92
|
+
```sh
|
|
93
|
+
bslfmt Модуль.bsl # результат на экран, файл не меняется
|
|
94
|
+
bslfmt -i Модуль.bsl Форма.bsl # отформатировать файлы на месте
|
|
95
|
+
bslfmt --check Модуль.bsl Форма.bsl # только проверить (для CI и хуков)
|
|
96
|
+
bslfmt --check --diff Модуль.bsl # проверить и показать различия
|
|
97
|
+
bslfmt Модуль.bsl --output Новый.bsl # записать результат в новый файл
|
|
98
|
+
bslfmt - < Модуль.bsl # стандартный ввод
|
|
99
|
+
bslfmt -i -sbc Модуль.bsl # и удалить комментарии внутри методов
|
|
100
|
+
bslfmt --help # справка по всем режимам
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
`-i` переписывает только файлы, которым нужна правка: запись атомарная
|
|
104
|
+
(временный файл рядом и замена), при отказе форматирования файл не меняется.
|
|
105
|
+
Сводка на каждый файл: `ФАЙЛ: изменён (строк: N)` или `ФАЙЛ: без изменений`.
|
|
106
|
+
Файл только для чтения не переписывается (ошибка, код 2). `--` завершает
|
|
107
|
+
флаги: `bslfmt --check -- -файл.bsl`.
|
|
108
|
+
`-sbc`, `--strip-body-comments` (с любым режимом) удаляет строки-комментарии внутри
|
|
109
|
+
процедур и функций — закомментированный код, маркеры доработок, пояснения.
|
|
110
|
+
Комментарии в конце строки кода, над методами, внутри строк (текстов
|
|
111
|
+
запросов) и областей `#Вставка`/`#Удаление` остаются. Без ключа комментарии
|
|
112
|
+
не удаляются.
|
|
113
|
+
`--check` ничего не записывает и перечисляет файлы, которые нужно
|
|
114
|
+
отформатировать. Несколько файлов — только с `-i`, `--check` или `--diff`;
|
|
115
|
+
каждый обрабатывается отдельно. `--output` создаёт новый файл и отказывается
|
|
116
|
+
перезаписывать существующий.
|
|
117
|
+
|
|
118
|
+
Ввод и вывод (текст, различия, сводка, ошибки) — UTF-8 на любой ОС; переводы
|
|
119
|
+
строк и BOM сохраняются как в исходнике.
|
|
120
|
+
|
|
121
|
+
Коды выхода (худший по всем файлам): `0` — успех (при `--check` — всё
|
|
122
|
+
отформатировано); `1` — `--check` нашёл файлы для форматирования; `2` —
|
|
123
|
+
ошибка аргументов, чтения или записи, неверная кодировка или отказ
|
|
124
|
+
форматирования (сообщение в stderr с именем файла и номером строки, если он
|
|
125
|
+
известен); `3` — внутренняя ошибка форматтера.
|
|
126
|
+
|
|
127
|
+
## Python API
|
|
128
|
+
|
|
129
|
+
```python
|
|
130
|
+
from bslfmt import format_code
|
|
131
|
+
|
|
132
|
+
formatted = format_code(source)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Для недоверенного ввода есть лимиты: `max_chars` — длина исходника
|
|
136
|
+
(по умолчанию 20 000 000 символов), `max_depth` — вложенность блоков
|
|
137
|
+
(по умолчанию 100). При превышении — `FormatError`; `None` отключает лимит.
|
|
138
|
+
|
|
139
|
+
```python
|
|
140
|
+
formatted = format_code(source, max_chars=1_000_000, max_depth=50)
|
|
141
|
+
cleaned = format_code(source, strip_body_comments=True)
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Сервису, который принимает код извне, стоит также запускать форматирование в
|
|
145
|
+
отдельном процессе с ограничением памяти и времени.
|
|
146
|
+
|
|
147
|
+
Поддерживаемые функции и ограничения уточняются по синтетическим тестам в
|
|
148
|
+
`tests/`; локальные корпуса и конфигурации в репозиторий не входят.
|
|
149
|
+
|
|
150
|
+
## Лицензия
|
|
151
|
+
|
|
152
|
+
Apache License 2.0 — см. `LICENSE` и `NOTICE`. Проект не аффилирован с ООО «1С».
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "bslfmt"
|
|
7
|
+
version = "0.20.1"
|
|
8
|
+
description = "Детерминированный форматтер кода 1С (BSL): отступы и пробелы по стандартам 1С"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
12
|
+
requires-python = ">=3.10"
|
|
13
|
+
authors = [{ name = "AzeevAN" }]
|
|
14
|
+
keywords = ["1c", "1c-enterprise", "bsl", "formatter", "1с", "форматтер"]
|
|
15
|
+
dependencies = []
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Environment :: Console",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Natural Language :: Russian",
|
|
22
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
23
|
+
"Programming Language :: Python :: 3.10",
|
|
24
|
+
"Programming Language :: Python :: 3.11",
|
|
25
|
+
"Programming Language :: Python :: 3.12",
|
|
26
|
+
"Programming Language :: Python :: 3.13",
|
|
27
|
+
"Topic :: Software Development :: Code Generators",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
[project.urls]
|
|
31
|
+
Homepage = "https://github.com/AzeevAN/bslfmt"
|
|
32
|
+
Repository = "https://github.com/AzeevAN/bslfmt"
|
|
33
|
+
Changelog = "https://github.com/AzeevAN/bslfmt/blob/main/CHANGELOG.md"
|
|
34
|
+
Issues = "https://github.com/AzeevAN/bslfmt/issues"
|
|
35
|
+
|
|
36
|
+
[project.scripts]
|
|
37
|
+
bslfmt = "bslfmt.__main__:main"
|
|
38
|
+
|
|
39
|
+
[tool.setuptools.packages.find]
|
|
40
|
+
where = ["src"]
|
bslfmt-0.20.1/setup.cfg
ADDED