Skip to content

Commit e2eaa98

Browse files
gnikitgnikit
committed
feat: added schema support
Adds automated schema generation based on the CLI. Attaches the schema as a release object in GitHub releases. Adds check on main CI for schema being up to date. Excludes schema from coverage report.
1 parent 8dedddc commit e2eaa98

File tree

6 files changed

+236
-0
lines changed

6 files changed

+236
-0
lines changed

‎.coveragerc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
omit =
33
fortls/__init__.py
44
fortls/version.py
5+
fortls/schema.py
56

67
[report]
78
exclude_lines =

‎.github/workflows/main.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ jobs:
3030
- name: Lint
3131
run: black --diff --check --verbose .
3232

33+
- name: Check schema is up to date
34+
run: |
35+
python3 -m fortls.schema
36+
git diff --exit-code ./fortls/fortls.schema.json
37+
3338
coverage:
3439
strategy:
3540
matrix:

‎.github/workflows/python-publish.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ jobs:
2323
with:
2424
python-version: "3.x"
2525

26+
- uses: softprops/action-gh-release@master
27+
if: startsWith(github.ref, 'refs/tags/v')
28+
with:
29+
files: ./fortls/fortls.schema.json
30+
2631
- name: Install dependencies
2732
run: |
2833
python -m pip install --upgrade pip

‎fortls/fortls.schema.json‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
{
2+
"title": "fortls schema",
3+
"description": "Schema for the fortls Fortran Language Server",
4+
"type": "object",
5+
"properties": {
6+
"config": {
7+
"title": "Config",
8+
"description": "Configuration options file (default file name: .fortlsrc, other default supported names: .fortls.json, .fortls)",
9+
"default": ".fortlsrc",
10+
"type": "string"
11+
},
12+
"nthreads": {
13+
"title": "Nthreads",
14+
"description": "Number of threads to use during workspace initialization (default: 4)",
15+
"default": 4,
16+
"type": "integer"
17+
},
18+
"notify_init": {
19+
"title": "Notify Init",
20+
"description": "Send notification message when workspace initialization is complete",
21+
"default": false,
22+
"type": "boolean"
23+
},
24+
"incremental_sync": {
25+
"title": "Incremental Sync",
26+
"description": "Use incremental document synchronization (beta)",
27+
"default": false,
28+
"type": "boolean"
29+
},
30+
"sort_keywords": {
31+
"title": "Sort Keywords",
32+
"description": "Display variable keywords information, function/subroutine definitions, etc. in a consistent (sorted) manner default: no sorting, display code as is)",
33+
"default": false,
34+
"type": "boolean"
35+
},
36+
"disable_autoupdate": {
37+
"title": "Disable Autoupdate",
38+
"description": "fortls automatically checks PyPi for newer version and installs them.Use this option to disable the autoupdate feature.",
39+
"default": false,
40+
"type": "boolean"
41+
},
42+
"preserve_keyword_order": {
43+
"title": "Preserve Keyword Order",
44+
"description": "DEPRECATED, this is now the default. To sort use sort_keywords",
45+
"default": false,
46+
"type": "boolean"
47+
},
48+
"debug_log": {
49+
"title": "Debug Log",
50+
"description": "Generate debug log in project root folder",
51+
"default": false,
52+
"type": "boolean"
53+
},
54+
"source_dirs": {
55+
"title": "Source Dirs",
56+
"description": "Folders containing source files (default: set())",
57+
"default": [],
58+
"type": "array",
59+
"items": {},
60+
"uniqueItems": true
61+
},
62+
"incl_suffixes": {
63+
"title": "Incl Suffixes",
64+
"description": "Consider additional file extensions to the default (default: F,F77,F90,F95,F03,F08,FOR,FPP (lower & upper casing))",
65+
"default": [],
66+
"type": "array",
67+
"items": {},
68+
"uniqueItems": true
69+
},
70+
"excl_suffixes": {
71+
"title": "Excl Suffixes",
72+
"description": "Source file extensions to be excluded (default: set())",
73+
"default": [],
74+
"type": "array",
75+
"items": {},
76+
"uniqueItems": true
77+
},
78+
"excl_paths": {
79+
"title": "Excl Paths",
80+
"description": "Folders to exclude from parsing",
81+
"default": [],
82+
"type": "array",
83+
"items": {},
84+
"uniqueItems": true
85+
},
86+
"autocomplete_no_prefix": {
87+
"title": "Autocomplete No Prefix",
88+
"description": "Do not filter autocomplete results by variable prefix",
89+
"default": false,
90+
"type": "boolean"
91+
},
92+
"autocomplete_no_snippets": {
93+
"title": "Autocomplete No Snippets",
94+
"description": "Do not use snippets with place holders in autocomplete results",
95+
"default": false,
96+
"type": "boolean"
97+
},
98+
"autocomplete_name_only": {
99+
"title": "Autocomplete Name Only",
100+
"description": "Complete only the name of procedures and not the parameters",
101+
"default": false,
102+
"type": "boolean"
103+
},
104+
"lowercase_intrinsics": {
105+
"title": "Lowercase Intrinsics",
106+
"description": "Use lowercase for intrinsics and keywords in autocomplete requests",
107+
"default": false,
108+
"type": "boolean"
109+
},
110+
"use_signature_help": {
111+
"title": "Use Signature Help",
112+
"description": "Use signature help instead of subroutine/function snippets. This effectively sets --autocomplete_no_snippets",
113+
"default": false,
114+
"type": "boolean"
115+
},
116+
"variable_hover": {
117+
"title": "Variable Hover",
118+
"description": "DEPRECATED: This option is always on. Show hover information for variables",
119+
"default": false,
120+
"type": "boolean"
121+
},
122+
"hover_signature": {
123+
"title": "Hover Signature",
124+
"description": "Show signature information in hover for arguments ",
125+
"default": false,
126+
"type": "boolean"
127+
},
128+
"hover_language": {
129+
"title": "Hover Language",
130+
"description": "Language used for responses to hover requests a VSCode language id (default: fortran90)",
131+
"default": "fortran90",
132+
"type": "string"
133+
},
134+
"max_line_length": {
135+
"title": "Max Line Length",
136+
"description": "Maximum line length (default: -1)",
137+
"default": -1,
138+
"type": "integer"
139+
},
140+
"max_comment_line_length": {
141+
"title": "Max Comment Line Length",
142+
"description": "Maximum comment line length (default: -1)",
143+
"default": -1,
144+
"type": "integer"
145+
},
146+
"disable_diagnostics": {
147+
"title": "Disable Diagnostics",
148+
"description": "Disable diagnostics",
149+
"default": false,
150+
"type": "boolean"
151+
},
152+
"pp_suffixes": {
153+
"title": "Pp Suffixes",
154+
"description": "File extensions to be parsed ONLY for preprocessor commands (default: all uppercase source file suffixes)",
155+
"default": [],
156+
"type": "array",
157+
"items": {},
158+
"uniqueItems": true
159+
},
160+
"include_dirs": {
161+
"title": "Include Dirs",
162+
"description": "Folders containing preprocessor files with extensions PP_SUFFIXES.",
163+
"default": [],
164+
"type": "array",
165+
"items": {},
166+
"uniqueItems": true
167+
},
168+
"pp_defs": {
169+
"title": "Pp Defs",
170+
"description": "A dictionary with additional preprocessor definitions. Preprocessor definitions are normally included via INCLUDE_DIRS",
171+
"default": {},
172+
"type": "object"
173+
},
174+
"symbol_skip_mem": {
175+
"title": "Symbol Skip Mem",
176+
"description": "Do not include type members in document symbol results",
177+
"default": false,
178+
"type": "boolean"
179+
},
180+
"enable_code_actions": {
181+
"title": "Enable Code Actions",
182+
"description": "Enable experimental code actions (default: false)",
183+
"default": false,
184+
"type": "boolean"
185+
}
186+
}
187+
}

‎fortls/schema.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
from __future__ import annotations
2+
3+
import pathlib
4+
5+
from pydantic import Field, create_model
6+
7+
from fortls.interface import cli
8+
9+
10+
def create_schema(root: pathlib.Path | None = None):
11+
if not root:
12+
root = pathlib.Path(__file__).parent
13+
14+
parser = cli("fortls")
15+
only_vals = {}
16+
for arg in parser._actions:
17+
if (
18+
arg.dest == "help"
19+
or arg.dest == "version"
20+
or arg.help == "==SUPPRESS=="
21+
or (arg.dest.startswith("debug") and arg.dest != "debug_log")
22+
):
23+
continue
24+
val = arg.default
25+
desc: str = arg.help.replace("%(default)s", str(val)) # type: ignore
26+
only_vals[arg.dest] = Field(val, description=desc) # type: ignore
27+
28+
m = create_model("fortls schema", **only_vals)
29+
m.__doc__ = "Schema for the fortls Fortran Language Server"
30+
31+
with open(str(root / "fortls.schema.json"), "w") as f:
32+
f.write(m.schema_json(indent=2))
33+
print(f"Created schema file: {root / 'fortls.schema.json'}")
34+
35+
36+
if __name__ == "__main__":
37+
create_schema()

‎setup.cfg‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ dev =
6161
black
6262
isort
6363
pre-commit
64+
pydantic
6465
docs =
6566
sphinx >= 4.0.0
6667
sphinx-argparse

0 commit comments

Comments
 (0)