Skip to content

Quick start

The following describes the steps to get started quickly

Create new diagnostics

  1. Create project directory bsl-language-server
  2. Clone the project repository to the created directory https://github.com/1c-syntax/bsl-language-server.git
  3. Set up the environment according to the instructions
  4. Execute commands to ignore changes in service files
  5. git update-index --assume-unchanged ./.idea/compiler.xml
  6. git update-index --assume-unchanged ./.idea/encodings.xml
  7. git update-index --assume-unchanged ./.idea/misc.xml
  8. Open the build.gradle.kts file from the project directory, agree to import the dependencies, wait for them to download
  9. Run (from context menu or ide console) command gradlew test, if passed then all settings are correct
  10. Make yourself familiar with diagnostics development example, structure and files purpose description, and other articles in the section for developers

Using the AST Debugger

To analyze the AST tree when creating diagnostics, you may need to get a visual representation of the tree. To do this, follow these steps

  • Create bsl-parser project directory
  • Clone the project repository into the created directory https://github.com/1c-syntax/bsl-parser.git
  • Set up the environment according to the instruction (if not previously performed)
  • Install ANTLR v4 grammar plugin

  • restart IDEA

  • Set up the plugin - File | Settings | Languages & Frameworks | ANTLR v4 default project settings ANTLR v4 grammar plugin

  • Set up Case transformation in the Preview window in Transform to uppercase when lexing
  • Open the build.gradle.kts file from the project directory, agree to import the dependencies, wait for them to download
  • After downloading:
  • To analyze bsl files (1C code)
    • Open src/main/antlr/BSLParser.g4
    • Place the cursor on the line with the rule file: (the first rule in the file) and select the context menu item Test Rule file
    • In the opened window, select a bsl-file or paste text from the clipboard
  • To analyze sdbl files (1C queries)
    • Open src/main/antlr/SDBLParser.g4
    • Place the cursor on the line with the rule queryPackage: (the first rule in the file) and select the context menu item Test Rule queryPackage
    • In the opened window, select a sdbl-file or paste text from the clipboard