Author Topic: Ruleset Validator for VSCode  (Read 332 times)

Offline SupSuper

  • Lazy Developer
  • Administrator
  • Commander
  • *****
  • Posts: 2104
    • View Profile
Ruleset Validator for VSCode
« on: August 30, 2018, 02:54:16 am »
I made an extension for Visual Studio Code that checks your rulesets for syntax errors so you can catch them as you type instead of having to wait for OpenXcom to crash/spew nonsense/do nothing when you make a typo. It looks like this:



I figured it was more useful to extend a familiar text editor than trying to make an entirely separate tool. If this is worth developing further let me know.

Installation Instructions
1. Install Visual Studio Code if you don't already have it.
2. Install the OpenXcom Ruleset Tools extension and follow the instructions.
3. Just open any .rul file and edit away.

What's Visual Studio Code? Isn't that some kind of IDE?
Despite the name, VSCode (for short) is just a fancy text editor in the vein of Notepad++/Sublime/Atom/etc. It can extended to be very powerful, but you don't need to be a programmer to use it.
I know we've always recommended Notepad++ for YAML, but it's become kinda lackluster over the years.

Why not <insert your favorite editor>?
VSCode is free, cross-platform, and honestly it was the easiest to extend. It already had a powerful YAML extension available so I just had to build on that. If you'd rather port it to <insert your favorite editor> the source is here: https://github.com/OpenXcom/vscode-ruleset
« Last Edit: September 02, 2018, 01:35:34 am by SupSuper »

Offline FeruEnzeru

  • Captain
  • ***
  • Posts: 334
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #1 on: August 30, 2018, 03:30:12 am »
Nice idea, SupSuper. :)

I do not know Visual Studio Code since i always use Notepad++ for rulesets and other things 3 years ago, but i'll get VSCode and the Ruleset Validator extension for it maybe tomorrow after some things (like HxD).

I would probably give that a try if like since i've read your thread and the gif on there.
I hope this requires Windows 10 because i always use W10 instead of Windows 7 and 8.

It would be cool and awesome for OpenXCOMmers to try this out. :D



Thank you for posting this on the forums. ;)

Offline The Reaver of Darkness

  • Commander
  • *****
  • Posts: 1113
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #2 on: August 30, 2018, 02:32:30 pm »
Very cool! I just use Notepad++ though. It doesn't do all that, but it does some of it at least.

I wonder if one could use this to scan for new rules they didn't know about?
« Last Edit: August 31, 2018, 09:11:11 pm by The Reaver of Darkness »

Offline davide

  • Colonel
  • ****
  • Posts: 562
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #3 on: August 30, 2018, 03:11:31 pm »
+100

Offline Finnik

  • Squaddie
  • *
  • Posts: 16
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #4 on: December 02, 2018, 04:13:12 pm »
Its totally great! im using it full time for modding. one question - is there any way to add custom commands? as it counts all OXCE syntax as an errors.

Offline Yankes

  • Commander
  • *****
  • Posts: 1991
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #5 on: December 02, 2018, 08:20:01 pm »
Yes it should allow as SupSuper careate it anybody can alter it to fit it goals.

btw SupSuper maybe add this file to `docs` folder in oxc repo? This could be source of truth for ruleset available for users.
When someone add new ruleset he need update this file, some thing like this I did for oxce documentation.

Offline SupSuper

  • Lazy Developer
  • Administrator
  • Commander
  • *****
  • Posts: 2104
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #6 on: December 05, 2018, 08:51:07 pm »
Yes it should allow as SupSuper careate it anybody can alter it to fit it goals.

btw SupSuper maybe add this file to `docs` folder in oxc repo? This could be source of truth for ruleset available for users.
When someone add new ruleset he need update this file, some thing like this I did for oxce documentation.
Arguably you could count this as the "source of truth": https://github.com/OpenXcom/vscode-ruleset/tree/master/schemas
Though it's already out-of-date :( I'm trying to figure out a way of having versioning and OXC/OXCE without making a mess of things.

Offline Yankes

  • Commander
  • *****
  • Posts: 1991
    • View Profile
Re: Ruleset Validator for VSCode
« Reply #7 on: December 05, 2018, 10:49:44 pm »
To reduce my work needed for describing every possible script function and its parameters I made hack, hole metadata need to parse string can be dump in semi human readable format. Something similar could be done for ruleset.

This probably would need some metaprograming or warper that will at once describe format and load data.

e.g.
Code: [Select]
void generateSchema()
{
  _schema = Schema<T>();
  _schema.field(&T::_id, "id of something");
  _schema.field(&T::_type, "type");
  _schema.field(&T::_weapon, "default weapon");
}
void load(Yaml::node& n)
{
   _schema.load(this, n);
}
Yaml::node save() //if we expand this do saves too
{
   return _schema.save(this);
}
std::string dump()
{
  return _schema.dump();
}

And then source of truth will be `oxc.exe --dump=filename.json`

[ps]

`dump()`  probably should dump YAML too, because it will be more compossible.
« Last Edit: December 06, 2018, 12:50:01 am by Yankes »