samwise README

Skyfence mapping development assistant for VS Code.

To get updates:

• git pull
• cd client
• npm run deploy
• Restart your VSCode

To get "YAML Language Server" updates from original repo master branch:

• git pull -s subtree server master

To simplify server devolopment:

1. In file ./client/extension.ts change code context.asAbsolutePath(path.join('node_modules', 'yaml-language-server', 'out', 'server', 'src', 'server.js') to context.asAbsolutePath(path.join('..', 'server', 'out', 'server', 'src', 'server.js'));.
2. Run npm run compile from ./client directory to apply previous change.
3. Run npm run compile from ./server.
4. Press Run Extension button.

• For each change in server - repeat steps 3 and 4.

Features

• Generate Activity Id
• Toggle Full XML Overrides
• Go to implementation && Peek implementation for transaction IDs
• Find All References && Peek References for transaction IDs
• Compile YML to a new file or merge into existing XML
• Find All References && Peek References for variables in activity fields
• Generate Not Word Regex

Yaml Features

1. YAML validation:
   • Detects whether the entire file is valid yaml
   • Detects errors such as:
     • Node is not found
     • Node has an invalid key node type
     • Node has an invalid type
     • Node is not a valid child node
2. Document Outlining (Ctrl + Shift + O):
   • Provides the document outlining of all completed nodes in the file
3. Auto completion (Ctrl + Space):
   • Auto completes on all commands
   • Scalar nodes autocomplete to schema's defaults if they exist
4. Hover support:
   • Hovering over a node shows description if provided by schema
5. Formatter:
   • Allows for formatting the current file

Extension Settings

Language Server Settings

The following settings are supported:

• yaml.format.enable: Enable/disable default YAML formatter (requires restart)
• yaml.format.singleQuote: Use single quotes instead of double quotes
• yaml.format.bracketSpacing: Print spaces between brackets in objects
• yaml.format.proseWrap: Always: wrap prose if it exeeds the print width, Never: never wrap the prose, Preserve: wrap prose as-is
• yaml.format.printWidth: Specify the line length that the printer will wrap on
• yaml.validate: Enable/disable validation feature
• yaml.hover: Enable/disable hover
• yaml.completion: Enable/disable autocompletion
• yaml.schemas: Helps you associate schemas with files in a glob pattern
• yaml.schemaStore.enable: When set to true the YAML language server will pull in all available schemas from JSON Schema Store
• yaml.customTags: Array of custom tags that the parser will validate against. It has two ways to be used. Either an item in the array is a custom tag such as "!Ref" and it will automatically map !Ref to scalar or you can specify the type of the object !Ref should be e.g. "!Ref sequence". The type of object can be either scalar (for strings and booleans), sequence (for arrays), mapping (for objects).
• [yaml]: VSCode-YAML adds default configuration for all yaml files. More specifically it converts tabs to spaces to ensure valid yaml, sets the tab size, and allows live typing autocompletion. These settings can be modified via the corresponding settings inside the [yaml] section in the settings:
  • editor.insertSpaces
  • editor.tabSize
  • editor.quickSuggestions