From 6d81494f80bf015ca2a5d669446d0f153fc4db7a Mon Sep 17 00:00:00 2001 From: Dmitry Mironov Date: Thu, 23 May 2019 14:53:35 +0600 Subject: [PATCH 01/11] Translate index.md via GitLocalize --- docs/en/index.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/en/index.md b/docs/en/index.md index c665800fc57..d1163d067e2 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -9,6 +9,8 @@ [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) implementation for 1C (BSL) - 1C:Enterprise 8 and [OneScript](http://oscript.io) languages. +[English version](en/index.md) + - Capabilities - Run from command line - Run in analyzer mode @@ -51,8 +53,8 @@ By default diagnostics texts are displayed in Russian. To switch the diagnostics ## Run in analyzer mode -To run in analyzer mode use parameter `--analyze` or `-a`. To set source code folder for analysis use parameter -`--srcDir` or `-s` followed by the path (relative or absolute) to the source code folder. +To run in analyzer mode use parameter `--analyze` (short `-a`). To set source code folder for analysis use parameter +`--srcDir` (short `-s`) followed by the path (relative or absolute) to the source code folder. To generate an analysis report you need to specify one or more reporters. To specify reporter use parameter `--reporter` or `-r`, followed by reporter key. You may specify several reporters. The list of reporters see in section **Reporters**. @@ -123,6 +125,7 @@ Used for code analysis to meet coding standards and search for possible errors. ### Implemented diagnostics - [CanonicalSpellingKeywords - Canonical Keywords Spelling ](diagnostics/CanonicalSpellingKeywords.md) +- [DeprecatedMessage - Ограничение на использование устаревшего метода "Сообщить"](diagnostics/DeprecatedMessage.md) - [EmptyCodeBlock - Empty Code Block](diagnostics/EmptyCodeBlock.md) - [EmptyStatement - Empty Statement](diagnostics/EmptyStatement.md) - [FunctionShouldHaveReturn - Function Should Have Return](diagnostics/FunctionShouldHaveReturn.md) @@ -131,9 +134,11 @@ Used for code analysis to meet coding standards and search for possible errors. - [IfElseIfEndsWithElse - If...ElseIf Ends With Else](diagnostics/IfElseIfEndsWithElse.md) - [LineLength - Line Length](diagnostics/LineLength.md) - [MethodSize - Method Size](diagnostics/MethodSize.md) +- [NestedConstructorsInStructureDeclaration - Ограничение на использование конструкторов с параметрами при объявлении структуры](diagnostics/NestedConstructorsInStructureDeclaration.md) - [NestedTernaryOperator - Nested Ternary Operator](diagnostics/NestedTernaryOperator.md) - [NumberOfOptionalParams - Number Of Optional Parameters in Method](diagnostics/NumberOfOptionalParams.md) - [NumberOfParams - Number Of Parameters in Method](diagnostics/NumberOfParams.md) +- [NumberOfValuesInStructureConstructor - Ограничение на количество значений свойств, передаваемых в конструктор структуры](diagnostics/NumberOfValuesInStructureConstructor.md) - [OneStatementPerLine - One Statement Per Line](diagnostics/OneStatementPerLine.md) - [OrderOfParams - Order Of Parameters in Method](diagnostics/OrderOfParams.md) - [ProcedureReturnsValue - Procedure should not return Value](diagnostics/ProcedureReturnsValue.md) @@ -141,4 +146,6 @@ Used for code analysis to meet coding standards and search for possible errors. - [SelfAssign - Variable is Assigned to itself](diagnostics/SelfAssign.md) - [UnknownPreprocessorSymbol - Unknown Preprocessor Symbol](diagnostics/UnknownPreprocessorSymbol.md) - [UsingCancelParameter - Using Cancel Parameter](diagnostics/UsingCancelParameter.md) +- [UsingFindElementByString - Использование методов «НайтиПоНаименованию» и «НайтиПоКоду»](diagnostics/UsingFindElementByString.md) +- [UsingServiceTag - Использование служебных тегов](diagnostics/UsingServiceTag.md) - [YoLetterUsageDiagnostic - Yo Letter Usage in code](diagnostics/YoLetterUsage.md) From b7edd17470c53b5e00b1fbc3504f31a417c759e9 Mon Sep 17 00:00:00 2001 From: Denis Date: Thu, 23 May 2019 14:53:36 +0600 Subject: [PATCH 02/11] Translate index.md via GitLocalize --- docs/en/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en/index.md b/docs/en/index.md index d1163d067e2..31fb51d79c3 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -67,7 +67,7 @@ java -jar bsl-language-server.jar --analyze --srcDir ./src/cf --reporter json > When run analysis for large code base it is recommended to set parameter {code0}-Xmx{/code0} to set maximum limit of memory being allocated to java process. The size of allocated memory depends on the size of code base for analysis. ```sh -java -Xmx4g -jar bsl-language-server.jar ...остальные параметры +java -Xmx4g -jar bsl-language-server.jar ... other parameters ``` @@ -92,7 +92,7 @@ Configuration file example, setting: ```json { - "diagnosticLanguage": "ru", + "diagnosticLanguage": "en", "diagnostics": { "LineLength": { "maxLineLength": 140 @@ -125,7 +125,7 @@ Used for code analysis to meet coding standards and search for possible errors. ### Implemented diagnostics - [CanonicalSpellingKeywords - Canonical Keywords Spelling ](diagnostics/CanonicalSpellingKeywords.md) -- [DeprecatedMessage - Ограничение на использование устаревшего метода "Сообщить"](diagnostics/DeprecatedMessage.md) +- [DeprecatedMessage - Restriction on using of the obsolete method "Message"](diagnostics/DeprecatedMessage.md) - [EmptyCodeBlock - Empty Code Block](diagnostics/EmptyCodeBlock.md) - [EmptyStatement - Empty Statement](diagnostics/EmptyStatement.md) - [FunctionShouldHaveReturn - Function Should Have Return](diagnostics/FunctionShouldHaveReturn.md) @@ -138,7 +138,7 @@ Used for code analysis to meet coding standards and search for possible errors. - [NestedTernaryOperator - Nested Ternary Operator](diagnostics/NestedTernaryOperator.md) - [NumberOfOptionalParams - Number Of Optional Parameters in Method](diagnostics/NumberOfOptionalParams.md) - [NumberOfParams - Number Of Parameters in Method](diagnostics/NumberOfParams.md) -- [NumberOfValuesInStructureConstructor - Ограничение на количество значений свойств, передаваемых в конструктор структуры](diagnostics/NumberOfValuesInStructureConstructor.md) +- [NumberOfValuesInStructureConstructor - Restriction on the number of property values ​​passed to the structure constructor](diagnostics/NumberOfValuesInStructureConstructor.md) - [OneStatementPerLine - One Statement Per Line](diagnostics/OneStatementPerLine.md) - [OrderOfParams - Order Of Parameters in Method](diagnostics/OrderOfParams.md) - [ProcedureReturnsValue - Procedure should not return Value](diagnostics/ProcedureReturnsValue.md) @@ -146,6 +146,6 @@ Used for code analysis to meet coding standards and search for possible errors. - [SelfAssign - Variable is Assigned to itself](diagnostics/SelfAssign.md) - [UnknownPreprocessorSymbol - Unknown Preprocessor Symbol](diagnostics/UnknownPreprocessorSymbol.md) - [UsingCancelParameter - Using Cancel Parameter](diagnostics/UsingCancelParameter.md) -- [UsingFindElementByString - Использование методов «НайтиПоНаименованию» и «НайтиПоКоду»](diagnostics/UsingFindElementByString.md) -- [UsingServiceTag - Использование служебных тегов](diagnostics/UsingServiceTag.md) +- [UsingFindElementByString - Using the methods "FindByDescription" and "FindByCode"](diagnostics/UsingFindElementByString.md) +- [UsingServiceTag - Using service tags](diagnostics/UsingServiceTag.md) - [YoLetterUsageDiagnostic - Yo Letter Usage in code](diagnostics/YoLetterUsage.md) From 456e29ae29496d51024e0781c02a84ca2e724da1 Mon Sep 17 00:00:00 2001 From: Nikita Gryzlov Date: Thu, 23 May 2019 14:53:39 +0600 Subject: [PATCH 03/11] Translate index.md via GitLocalize --- docs/en/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/index.md b/docs/en/index.md index 31fb51d79c3..cf6a5e6904f 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -134,7 +134,7 @@ Used for code analysis to meet coding standards and search for possible errors. - [IfElseIfEndsWithElse - If...ElseIf Ends With Else](diagnostics/IfElseIfEndsWithElse.md) - [LineLength - Line Length](diagnostics/LineLength.md) - [MethodSize - Method Size](diagnostics/MethodSize.md) -- [NestedConstructorsInStructureDeclaration - Ограничение на использование конструкторов с параметрами при объявлении структуры](diagnostics/NestedConstructorsInStructureDeclaration.md) +- [NestedConstructorsInStructureDeclaration - Nested constructors with parameters in structure declaration](diagnostics/NestedConstructorsInStructureDeclaration.md) - [NestedTernaryOperator - Nested Ternary Operator](diagnostics/NestedTernaryOperator.md) - [NumberOfOptionalParams - Number Of Optional Parameters in Method](diagnostics/NumberOfOptionalParams.md) - [NumberOfParams - Number Of Parameters in Method](diagnostics/NumberOfParams.md) From e572354eaf6ad95d7a95a2d9a5a6e768add2a9b8 Mon Sep 17 00:00:00 2001 From: Nikita Gryzlov Date: Thu, 23 May 2019 14:53:46 +0600 Subject: [PATCH 04/11] Translate DeprecatedMessage.md via GitLocalize --- docs/en/diagnostics/DeprecatedMessage.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/en/diagnostics/DeprecatedMessage.md diff --git a/docs/en/diagnostics/DeprecatedMessage.md b/docs/en/diagnostics/DeprecatedMessage.md new file mode 100644 index 00000000000..445122335f0 --- /dev/null +++ b/docs/en/diagnostics/DeprecatedMessage.md @@ -0,0 +1,7 @@ +# Restriction on using of the obsolete method "Message" + +Для вывода сообщений пользователю во всех случаях следует использовать объект СообщениеПользователю, даже когда сообщение не «привязывается» к некоторому элементу управления формы. Метод Сообщить применять не следует. + +*When used the Standard Subsystems Library it is recommended use procedure MessageUser from common module CommonPurposeClientServer, which use object UserMessage.* + +Источник: [Стандарт: Ограничение на использование метода Сообщить](https://its.1c.ru/db/v8std#content:418:hdoc) From 282595b8d975bcbf1118188308074c25ef22f4d4 Mon Sep 17 00:00:00 2001 From: Dmitry Mironov Date: Thu, 23 May 2019 14:53:48 +0600 Subject: [PATCH 05/11] Translate DeprecatedMessage.md via GitLocalize --- docs/en/diagnostics/DeprecatedMessage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/diagnostics/DeprecatedMessage.md b/docs/en/diagnostics/DeprecatedMessage.md index 445122335f0..7b8d2458eda 100644 --- a/docs/en/diagnostics/DeprecatedMessage.md +++ b/docs/en/diagnostics/DeprecatedMessage.md @@ -1,7 +1,7 @@ # Restriction on using of the obsolete method "Message" -Для вывода сообщений пользователю во всех случаях следует использовать объект СообщениеПользователю, даже когда сообщение не «привязывается» к некоторому элементу управления формы. Метод Сообщить применять не следует. +To display messages to the user in all cases, you should use the MessageUser object, even when the message is not “bound” to some form control. The Message method should not be used. *When used the Standard Subsystems Library it is recommended use procedure MessageUser from common module CommonPurposeClientServer, which use object UserMessage.* -Источник: [Стандарт: Ограничение на использование метода Сообщить](https://its.1c.ru/db/v8std#content:418:hdoc) +Refference: [Standard: Limit use of the obsolete method Message](https://its.1c.ru/db/v8std#content:418:hdoc) From eb5be0324ed8fcc7dde69350c2887e0147e80f55 Mon Sep 17 00:00:00 2001 From: machine-translation Date: Thu, 23 May 2019 14:53:50 +0600 Subject: [PATCH 06/11] Translate NumberOfValuesInStructureConstructor.md via GitLocalize --- .../NumberOfValuesInStructureConstructor.md | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md index e69de29bb2d..d39e345e468 100644 --- a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md +++ b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md @@ -0,0 +1,52 @@ +# Limit on the number of property values passed to the structure constructor + +При создании объекта типа Структура не рекомендуется передавать в конструктор более 3-х значений свойств. +Вместо этого рекомендуется использовать метод Вставить или присваивать значения свойствам явным образом + +#### Example + +Неправильно: + +```bsl +ПараметрыФормыКомпоновки = Новый Структура( + "НеПомещатьНастройкиВСхемуКомпоновкиДанных, + |НеРедактироватьСхемуКомпоновкиДанных, + |НеНастраиватьУсловноеОформление, + |НеНастраиватьВыбор, + |НеНастраиватьПорядок, + |АдресСхемыКомпоновкиДанных, + |АдресНастроекКомпоновкиДанных, + |УникальныйИдентификатор, + |Заголовок", + Истина, + Истина, + Истина, + Истина, + Истина, + ТекущиеДанные.АдресСхемыКомпоновкиДанных, + ?(АдресНастроекСхемыКомпоновкиДанных <> Неопределено, + АдресНастроекСхемыКомпоновкиДанных, + ТекущиеДанные.АдресНастроекСхемыКомпоновкиДанных), + УникальныйИдентификатор, + ЗаголовокФормыНастройкиСхемыКомпоновкиДанных)); +``` + +Правильно: + +```bsl +ПараметрыФормыКомпоновки = Новый Структура; + +ПараметрыФормыКомпоновки.Вставить("НеПомещатьНастройкиВСхемуКомпоновкиДанных", Истина); +ПараметрыФормыКомпоновки.Вставить("НеРедактироватьСхемуКомпоновкиДанных", Истина); +ПараметрыФормыКомпоновки.Вставить("НеРедактироватьСхемуКомпоновкиДанных", Истина); +ПараметрыФормыКомпоновки.Вставить("НеНастраиватьВыбор", Истина); +ПараметрыФормыКомпоновки.Вставить("НеНастраиватьПорядок", Истина); +ПараметрыФормыКомпоновки.Вставить("АдресСхемыКомпоновкиДанных", ТекущиеДанные.АдресСхемыКомпоновкиДанных); +ПараметрыФормыКомпоновки.Вставить("АдресНастроекКомпоновкиДанных", ?(АдресНастроекСхемыКомпоновкиДанных <> Неопределено, + АдресНастроекСхемыКомпоновкиДанных, + ТекущиеДанные.АдресНастроекСхемыКомпоновкиДанных)); +ПараметрыФормыКомпоновки.Вставить("УникальныйИдентификатор ", УникальныйИдентификатор); +ПараметрыФормыКомпоновки.Вставить("Заголовок", ЗаголовокФормыНастройкиСхемыКомпоновкиДанных); +``` + +Источник: [Стандарт: Использование объектов типа Структура](https://its.1c.ru/db/v8std#content:693:hdoc) From 7abe291db06d6c79f52e3f402ffd0dce31223309 Mon Sep 17 00:00:00 2001 From: Dmitry Mironov Date: Thu, 23 May 2019 14:53:51 +0600 Subject: [PATCH 07/11] Translate NumberOfValuesInStructureConstructor.md via GitLocalize --- .../en/diagnostics/NumberOfValuesInStructureConstructor.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md index d39e345e468..7aa2a37dd0e 100644 --- a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md +++ b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md @@ -1,11 +1,10 @@ # Limit on the number of property values passed to the structure constructor -При создании объекта типа Структура не рекомендуется передавать в конструктор более 3-х значений свойств. -Вместо этого рекомендуется использовать метод Вставить или присваивать значения свойствам явным образом +When creating an object of type Structure it is not recommended to pass more than 3 property values to the constructor. Instead, it is recommended to use the Insert method or assign values to properties explicitly. #### Example -Неправильно: +Incorrect: ```bsl ПараметрыФормыКомпоновки = Новый Структура( @@ -31,7 +30,7 @@ ЗаголовокФормыНастройкиСхемыКомпоновкиДанных)); ``` -Правильно: +Correct: ```bsl ПараметрыФормыКомпоновки = Новый Структура; From 277d923d01ed14043064162c8b8384622b7f06f5 Mon Sep 17 00:00:00 2001 From: Nikita Gryzlov Date: Thu, 23 May 2019 14:53:53 +0600 Subject: [PATCH 08/11] Translate NumberOfValuesInStructureConstructor.md via GitLocalize --- docs/en/diagnostics/NumberOfValuesInStructureConstructor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md index 7aa2a37dd0e..0f3d869ad75 100644 --- a/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md +++ b/docs/en/diagnostics/NumberOfValuesInStructureConstructor.md @@ -48,4 +48,4 @@ Correct: ПараметрыФормыКомпоновки.Вставить("Заголовок", ЗаголовокФормыНастройкиСхемыКомпоновкиДанных); ``` -Источник: [Стандарт: Использование объектов типа Структура](https://its.1c.ru/db/v8std#content:693:hdoc) +Reference: [Стандарт: Использование объектов типа Структура](https://its.1c.ru/db/v8std#content:693:hdoc) From c718f74787bbc8be12afd11d445d49bad6839e96 Mon Sep 17 00:00:00 2001 From: Dmitry Mironov Date: Thu, 23 May 2019 14:53:55 +0600 Subject: [PATCH 09/11] Translate UsingFindElementByString.md via GitLocalize --- .../diagnostics/UsingFindElementByString.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/en/diagnostics/UsingFindElementByString.md diff --git a/docs/en/diagnostics/UsingFindElementByString.md b/docs/en/diagnostics/UsingFindElementByString.md new file mode 100644 index 00000000000..0046cb9fa1f --- /dev/null +++ b/docs/en/diagnostics/UsingFindElementByString.md @@ -0,0 +1,29 @@ +# Using FindByName and FindByCode + +- **Scope:** BSL (BSL only) +- **Type:** CODE_SMELL +- **Criticality:** MAJOR + +The diagnostic finds use of methods FindByName and FindByCode with hardcoded values. + +Example: + +```bsl +Должность = Справочники.Должности.НайтиПоНаименованию("Ведущий бухгалтер"); +``` + +or + +```bsl +Должность = Справочники.Должности.НайтиПоКоду("00-0000001"); +``` + +Acceptable use: + +```bsl +Справочники.Валюты.НайтиПоКоду(ТекущиеДанные.КодВалютыЦифровой); +``` + +```bsl +Справочники.КлассификаторБанков.НайтиПоКоду(СведенияОБанке.БИК); +``` From b5dc91f5683e840d473bffc80120e48a6d01b63e Mon Sep 17 00:00:00 2001 From: Dmitry Mironov Date: Thu, 23 May 2019 14:53:57 +0600 Subject: [PATCH 10/11] Translate UsingServiceTag.md via GitLocalize --- docs/en/diagnostics/UsingServiceTag.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/en/diagnostics/UsingServiceTag.md diff --git a/docs/en/diagnostics/UsingServiceTag.md b/docs/en/diagnostics/UsingServiceTag.md new file mode 100644 index 00000000000..3563bd7699a --- /dev/null +++ b/docs/en/diagnostics/UsingServiceTag.md @@ -0,0 +1,12 @@ +# Using service tags + +The diagnostic finds use of service tags in comments. Tags list: + +- TODO +- FIXME + +Tags list can be extended via options. + +## Parameters + +- `serviceTags` - `String` - keyword for search. Bu default : "todo|fixme". From 5833c6974b8ff380ba60e1d790e1087027870c56 Mon Sep 17 00:00:00 2001 From: Nikita Gryzlov Date: Thu, 23 May 2019 14:58:01 +0600 Subject: [PATCH 11/11] Translate CanonicalSpellingKeywords.md via GitLocalize --- docs/en/diagnostics/CanonicalSpellingKeywords.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/diagnostics/CanonicalSpellingKeywords.md b/docs/en/diagnostics/CanonicalSpellingKeywords.md index 52711cb43eb..8c3ba6f3299 100644 --- a/docs/en/diagnostics/CanonicalSpellingKeywords.md +++ b/docs/en/diagnostics/CanonicalSpellingKeywords.md @@ -78,4 +78,4 @@ RU | EN НаКлиентеНаСервереБезКонтекста | AtClientAtServerNoContext НаКлиентеНаСервере | AtClientAtServer -Источник: [Standart: Modules texts(RU)](https://its.1c.ru/db/v8std#content:456:hdoc) +Reference: [Standart: Modules texts (RU)](https://its.1c.ru/db/v8std#content:456:hdoc)