SyteLine/CSI Development Pack README

Working with SyteLine/CSI Development Pack

• This is an extension package for the development of SyteLine/CSI 10 and later versions.
• This package collects all the extensions which are useful for the development of SyteLine.
  • Git
    • GitLab MR Review
  • C#.net (SDK project fully support)
    • Compile
    • Debug
    • Unit Test
  • VB.net (partial support)
  • MS-SQL
    • Execution Plan
    • Execute Command
  • XML
  • Json
  • Remote Explorer
    • Remote Tunnel
    • Remote SSH
  • Veracode Greenlight
  • Amazon Q
  • Folder Comparison
  • Beautiful Editor Layout

Source Code

• Please download or clone the SyteLine Git repository from a certified location.

Setting VS Code for Development

To use the tasks, and launch configurations provided by this extension, follow these steps:

1. Tasks:

   • Open your tasks.json file (.vscode/tasks.json).

   • Add the following tasks, this would enable run tasks in vs code:

     {
       "inputs": [
         {
           "id": "test-class",
           "type": "promptString",
           "description": "Enter the Class Name for Unit Test Code Coverage"
         },
         {
           "id": "base-branch",
           "type": "promptString",
           "description": "Enter the Base Branch Name",
           "default": "origin/L3-Mar25"
         },
         {
           "id": "current-branch",
           "type": "promptString",
           "description": "Enter the Current Branch Name",
           "default": "origin/L3-Apr25"
         }
       ],
       "tasks": [
         {
           "label": "Detect Signature Changes",
           "command": "dotnet",
           "type": "process",
           "args": [
             "run",
             "--project",
             "C:/Development/CSI/Development Tools/SignatureChangeDetector/SignatureChangeDetector",
             "basebranch=\"${input:base-branch}\"",
             "currentbranch=\"${input:current-branch}\"",
             "CSIGitPath=\"C:\\Development\\CSI\"",
             "BackwardDays=0",
             "InterfaceOnly"
           ],
           "options": {
             "cwd": "C:/Development/CSI/"
           },
           "problemMatcher": []
         },
         {
           "label": "Run sUnit Test with Code Coverage",
           "command": "powershell",
           "type": "process",
           "args": [
             "-ExecutionPolicy",
             "ByPass",
             "-File",
             "C:\\Development\\csi\\Development Tools\\CodeCoverage\\Find-ClassAndTest.ps1",
             "${input:test-class}"
           ],
           "options": {
             "cwd": "C:\\Development\\csi\\Development Tools\\CodeCoverage\\"
           },
           "problemMatcher": []
         },
         {
           "label": "Refresh Environment",
           "command": "C:\\Development\\Personal\\refresh_syteline.bat",
           "type": "process",
           "options": {
             "cwd": "C:\\Development\\CSI\\"
           },
           "presentation": {
             "panel": "dedicated"
           },
           "problemMatcher": []
         },
         {
           "label": "Build CSI ExtensionClasses Solution",
           "type": "process",
           "command": "C:/Program Files/Microsoft Visual Studio/2022/Professional/Msbuild/Current/Bin/MSBuild.exe",
           "args": [
             "C:/Development/CSI/ObjectStudio/SyteLineDev/ExtensionClasses/ExtensionClasses.sln",
             "-t:restore,build",
             "-clp:NoSummary",
             "-m:12"
           ],
           "group": "build",
           "presentation": {
             "echo": false,
             "focus": false,
             "panel": "dedicated"
           },
           "problemMatcher": "$msCompile"
         }
       ]
     }
     

   • In VS code, you can press ctrl + shift + p to bring out the short-cut command bar.

   • Entering Tasks, and select Run Taks.

   • You will see the all predefined Tasks.

     • Signature Change Detector
     • Run Test Coverage
     • Build CSI ExtensionClasses Solution

2. Launch Configurations:

   • Open your launch.json file (.vscode/launch.json).
   • Add the following launch configuration, this would enable debugging SyteLine extension classes in vs code:

   {
     "version": "0.2.0",
     "configurations": [
       {
         "name": "Extension",
         "type": "extensionHost",
         "request": "launch",
         "args": ["--extensionDevelopmentPath=${workspaceFolder}"]
       },
       {
         "name": "Debug IDORuntimeService",
         "type": "clr",
         "request": "attach",
         "processName": "IDORuntimeService.exe"
       },
       {
         "name": "Debug dotnet",
         "type": "coreclr",
         "request": "attach"
       }
     ]
   }
   

   • You can see on the Run and Debug tab.
   • Click the green triangle, a debug bar will show on the top of VS code if it can find the running DORuntimeService.exe.
   • You can add breakpoint to your code in VS code and it will break/stop the process while you run the specified code.

3. Additional Settings:

   • Open your settings.json file (File > Preferences > Settings).
   • Add the following settings, this would enable code-runner to build project:

   {
     "code-runner.executorMapByFileExtension": {
       ".csproj": "MSBuild.exe /nr:false -t:restore,build -clp:Summary -v:m -m:12",
       ".vbproj": "MSBuild.exe /nr:false -t:restore,build -clp:Summary -v:m -m:12",
       ".sln": "MSBuild.exe /nr:false -t:restore,build -clp:Summary -v:m -m:12"
     }
   }
   

Default Tasks

Enjoy!