Skip to content

LHC VdM Scan files editor

License

Notifications You must be signed in to change notification settings

CERN/lhc-vdm-editor

Repository files navigation

lhc-vdm-editor

A code and file editor for VdM scans.

GitHub test status

lhc-vdm-editor screenshot

Features

  • A VdM code editor, including:
    • Syntax highlighting
    • Syntax checking
    • Autocompletion
    • Auto generation of line numbers
    • VdM file headers and hints for VdM commands
  • A file browser tracking files on a GitLab repository.
  • Graphs containing simulations of expected beam position and luminosity.
  • Generation of common VdM scans.

Local Development

  • Create the file /secrets.json with the format {"token": <TOKEN>}.
  • Install all the dev dependencies: npm install.
  • Run a http server: npm run-script test-server.

For testing:

In the browser

  • Open 127.0.0.1:8080/SpecRunner.html
  • To test specific files, you can use the spec parameter e.g. 127.0.0.1:8080/SpecRunner.html?spec=CodeEditor

In a headless chrome instance, with coverage reports

  • Run node console_test.js

For viewing the editor locally:

  • Open 127.0.0.1:8080/index.html

Linting

This package is linted using tslint: npm run-script lint