wintercms / vscode-extension Goto Github PK

View Code? Open in Web Editor NEW

10.0 4.0 6.0 905 KB

Official Winter CMS VSCode extension

Home Page: https://marketplace.visualstudio.com/items?itemName=wintercms.winter-cms

License: MIT License

JavaScript 100.00%

vscode extension hacktoberfest

vscode-extension's Introduction

Winter VSCode Extension

The official Visual Studio Code extension for Winter CMS, providing syntax highlighting, code completion and useful assistive features for developers working on Winter projects.

This extension is currently in preview and is not feature-complete.

Features

Currently available

Syntax highlighting for CMS template files and Winter CMS Block templates.
Twig definition for Winter-provided Twig functions and filters.

Planned for v1.0.0

YAML schema validation and code completion for the following configurations:
- Form field definitions (fields.yaml)
- List column definitions (columns.yaml)
- Form behaviour configuration (config_form.yaml)
- List behaviour configuration (config_list.yaml)
- Relation behaviour configuration (config_releation.yaml)
- Reorder behaviour configuration (config_reorder.yaml)
- Import/export behaviour configuration (config_import_export.yaml)
Code completion for CMS templates:
- Main template definitions in INI section
- Component configuration in INI section
- Component variables in {% component %} tag

Screenshot

Requirements

The YAML validation will require the YAML plugin provided by Red Hat. This will be installed automatically with this extension.

Additional notes

To enable Emmet features in theme templates, add the following to the emmet.includeLanguages setting in your settings.json in VSCode.

"emmet.includeLanguages": {
    "wintercms": "html"
}

Compatibility with other extensions

If you are getting the error Symfony\Component\ErrorHandler\Error\FatalError: Uncaught Illuminate\Contracts\Container\BindingResolutionException: Target [Illuminate\Contracts\Auth\Access\Gate] is not instantiable. in your logs or Ray output while you have the Laravel Extra Intellisense extension installed, then you can set LaravelExtraIntellisense.disableAuth to true in your VSCode extension settings.

vscode-extension's People

Contributors

Stargazers

Watchers

Forkers

priest671 damsfx joaocosta-azores aic-bv webvpf

vscode-extension's Issues

Official VS Code extension for Winter

We plan to release an official VS Code extension for supercharging Winter CMS development in Visual Studio Code.

Some of the features that we intend to include in the initial release are as follows:

Full YAML schema and validation for configuration files (ie. form and list configurations, behaviour settings, etc.)
Auto-completion in YAML files
- Allow selection of models in modules and plugins when specifying models in YAML configuration files
- Auto-complete component configuration
Language support for Winter CMS templates

Alternative Input preset converter throws an error

See here: https://wintercms.com/docs/backend/forms#field-input-preset

Add support for Winter blocks

It would be great to have support for .block files from the plugin winter-blocks-plugin.

The file schema :

A Yaml section
An optional PHP section
a HTML/Twig section

I started the work here, but I don't have time to do more at the moment:
https://github.com/damsfx/vscode-extension/tree/add-blocks

Error on type property

type: x in fields.yaml is throwing an error
"Matches multiple schemas when only one must validate."

Note:
It is not throwing the error inside nestedform, but I think that is because its not working in nestedform?

Form 'type' field value validation doesn't include any widget types

When creating a form field with type richeditor for example I get an error:

Value must be "text" | "number" | ...

This seems to apply for any widget type - richeditor, relation, datepicker, datatable etc

Detecting all different types of .htm files

First of all, this is not a real issue but more like a conceptual discussion and comments. Although maybe something could be done/improved in the extension logic or at least maybe README could be updated with settings I will give below. Also I am aware that this is only Preview version of extension so probably you are also aware of this.

Anyways, I installed extension yesterday and played around it a little - Winter CMS page file (.htm) detection works as expected but problems start to arise when I open, for example, component, partial and controller .htm files - by default (at least in my VSCode setup) they are also detected as Winter CMS Template files but as they don't contain == delimiters and are not true Winter CMS files but more like standart html files then syntax highlighting gets messed around and doesn't work for html code in the files:

So my workaround at this problem was to update my VSCode workspace file association settings (.vscode/settings.json file):

{
    "files.associations": {
        "*.htm": "wintercms",
        "**/controllers/**/*.htm": "html",
        "**/components/**/*.htm": "wintercms-twig",
        "**/partials/**/*.htm": "html"
    }
}

And now the syntax highlighting looks like this for the same component file:

I didn't tested my setup in all scenarios and I know that it's not 100% safe because, for example, partials can also contain YAML section with description field but so far looks and works at least better than default auto-detection feature for component, partial and controller html files.

Problems

Highlighting does not work in theme partials without '=='
Example \themes\demo\partials\site\head.htm

Code commenting not working with keyboard shortcuts Ctrl + /. For lang Winter CMS Template.
Works only for the INI section.