src/Tools/VSCode/README.md
author wenzelm
Fri, 01 Jul 2022 20:47:16 +0200
changeset 75646 a1421c88ae0a
parent 75259 fd44e4559adb
permissions -rw-r--r--
provide components for scala3 (still inactive);
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
     1
# Isabelle/VSCode development #
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
     2
75259
fd44e4559adb prefer yarn over npm;
wenzelm
parents: 75254
diff changeset
     3
## System requirements ##
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     4
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
     5
* install default node.js (e.g. via Ubuntu package)
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     6
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
     7
* update to recent stable version:
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     8
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
     9
    sudo npm cache clean -f
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    10
    sudo npm install -g n
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    11
    sudo n stable
66596
c5bd8267d832 simplified README: this is for development version;
wenzelm
parents: 65158
diff changeset
    12
75259
fd44e4559adb prefer yarn over npm;
wenzelm
parents: 75254
diff changeset
    13
* install add-on tools:
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    14
75259
fd44e4559adb prefer yarn over npm;
wenzelm
parents: 75254
diff changeset
    15
    sudo npm install -g yarn vsce
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    16
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    17
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    18
## Edit and debug ##
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    19
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    20
* Shell commands within $ISABELLE_HOME directory:
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    21
75254
0c9752726e9d clarified names;
wenzelm
parents: 75147
diff changeset
    22
    isabelle build_vscode_extension -U
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    23
    isabelle vscode src/Tools/VSCode/extension
64696
e991a4fab0dc publish extension on Visual Studio Marketplace;
wenzelm
parents: 64695
diff changeset
    24
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    25
* VSCode commands:
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    26
    Run / Start Debugging (F5)
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    27
    File / Open Folder: e.g. `src/HOL/Examples/` then open .thy files
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    28
64740
01af31db2720 proper packaging;
wenzelm
parents: 64733
diff changeset
    29
75140
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    30
## Build and install ##
4400eeb6c32d updated notes on Isabelle/VSCode development;
wenzelm
parents: 73539
diff changeset
    31
75254
0c9752726e9d clarified names;
wenzelm
parents: 75147
diff changeset
    32
    isabelle build_vscode_extension -I