[ST4] A whole bunch of fixes and improvements. #216

deathaxe · 2021-09-09T16:57:25Z

This PR applies further fixes and improvements with regards to correct meta scopes, close-tag handling and aligns the overall syntax structure with ST's core HTML.sublime-syntax.

For details about the single changes, please refer to commit messages.

Improve readability.

This commit... 1. fixes duplicated meta.tag scopes in `<template>` tags 2. fixes missing meta.tag scope at the closing `>` in `<template>` tags 3. adds syntax tests for template tags

This commit fixes implementation of mustage template tags {{...}}. Before this commit they tried to pop the `main` context off stack and caused `template-tag-content` to never have been popped off stack properly. With this commit the syntax distinguishes between embedded template tags and those which interpolate strings. The latter one remove `string` scope for better highlighting java code in `{{ ... }}`. It also does no longer push a dedicated `mustage-content` context on stack as this is the same content as the whole document. It's not required.

All `v-foo` directive attributes have not been scoped `meta-attribute-with-value` which effects syntax highlighting when using certain color schemes. That's fixed by this commit. Note: It appears YAMLmacros sorts generated output randomly, so many changes of the generated sublime-syntax file can be ignored.

This commit refactors close-tag context handling in order to fix meta scopes of stray closing tags. Before this commit they received the default meta and entity scope from HTML.sublime-syntax. This may result in inconsistent highlighting once they are directly addressed by a color scheme. That's a fix which is planned for core HTML.sublime-syntax, too. The change of `script-tag` and `style-tag` also fixes duplicated meta.tag scopes for script/style tags for ST builds before 4114.

This commit just moves sections/contexts around. It doesn't change behavior. The goal is to end up with the same order as HTML.sublime-syntax which uses a top-down-order. 1. managing contexts 2. tag contexts 3. attribute contexts 4. other reusable contexts 5. prototypes

applies sublimehq/Packages#2430

All sublime-syntax version 2 files should use explicit `pop: 1` instead of `pop: true`. It looks more consistent in case `pop: 2` are used.

No need to duplicate the match directive if it already exists.

This commit fixes sublimehq/Packages#2910 for all ST builds before 4114.

rchl · 2021-09-09T20:54:01Z

Working well for me. Not noticing any differences on the surface.

ST's HTML.sublime-syntax may change in the future so that the change of this commit is required to maintain compatibility. It is planned to highlight certain self-closing tags illegal, if they are known not to support it. This change is backward compatible with older builds of ST4.

deathaxe · 2022-02-02T18:12:59Z

This PR ensures correct meta.scopes, cleans some things up and ensures compatibility with a possible future change to ST's core HTML syntax.

Vue Component.sublime-syntax

Addresses #216 (comment) This commit includes `JavaScript#expression-statement` context in attribute/directive values to highlight mappings correctly. The `pop: 1` is removed as the included context pops itself off stack.

Run YAML macros in python 3.8 in order to maintain dictionary key sort order.

FichteFoll · 2022-03-04T13:50:44Z

FWIW, the changes here revert #168. I now switched to use source.js - meta.attribute-with-value as a selector for linting, but not sure if this is what we'd want here. It's better than pre-#168, though.

deathaxe · 2022-03-04T14:50:41Z

Means, you'd suggest to use .embedded.vue instead of .embedded.html for all embedded languages?

FichteFoll · 2022-03-07T00:55:44Z

Not precisely, no. I don't have a clear picture on how embedded languages are scoped currently, but I suppose it does make sense to differentiate between different embedded languages by denoting the text/source scope with the language whose syntax is responsible for the embedding if we're going to include some identifier there. Thus, since the attribute syntax is most definitely vue-specific, that is a candidate for .embedded.vue over .embedded.html, whereas I don't think so about the <script> block, since that uses standard HTML syntax.

Regardless, for the mentioned purpose, the meta scope for HTML attributes is certainly enough.

This allows easily targeting the embed scopes inside attributes as something that is contributed and supported by the vue syntax only as opposed to a a `<script>` tag which uses HTML syntax.

FichteFoll · 2023-01-05T16:17:44Z

I have made further additions to this PR in my fork and filed a PR against this branch in https://github.com/deathaxe/sublime-vue/pull/1.

Use vue suffix for embed_scope in attributes and mustache

This commit moves terminating patterns to the top so they match with max priority in case of overlapping patterns. This change is just to be future proof if core HTML syntax changes.

This commit follows a scope naming scheme introduced to Astro, Blade, Liquid, PHP and Slim recently, which uses 1. `meta.embedded.<template-name>` for those template code sections, which are used for control structures primarily. This scope has already been in use in PHP syntax to scope all `<?php ... ?>` code sections. 2. `meta.interpolation.<template-name>` for those template code sections, which primarily emit data to the output document. That's what Mustage tags `{{ expr }}` do primarily.

deathaxe · 2023-01-05T17:01:25Z

PR is merged with two further scoping changes, already applied to various other template syntaxes such as Astro, Blade, Liquid and Slim.

1. extend `meta.interpolation` to include leading and trailing punctuation to comply with ST's scope naming guidelines. 2. fix closing `]` scope. 3. adjust/add tests

skyronic · 2023-01-05T18:20:54Z

Hello @FichteFoll @deathaxe - thank you for your time and contribution. I'll just look over this in the next couple of days and merge it in if I don't find any issues.

Would you be able to provide a summary of changes/improvements for the changelog?

deathaxe · 2023-01-06T18:48:42Z

The following list should contain the most significant parts. Not sure if all details need to be mensioned in changelog though.

Changelog

adjust syntax code structure to basic HTML.sublime-syntax for better maintainability
- reorder contexts
- add some "section headers" aka separators for better code navigation
- re-use existing contexts such as tag-end-self-closing and tag-end
- minor code style tweaks (e.g.: pop: 1 or main key order)
Fix mustage template interpolation ...
- possibly popping main context off stack, breaking whole syntax.
- not being highlighted within attribute values and strings.
- scope them meta.interpolation instead of meta.template
  to comply with Astro, Blade, Liquid, PHP, Slim, ...
Add attribute name interpolation support (e.g.: <p v-#[ name expr ])
Fix vue directive attributes not being scoped meta.attribute-with-value
Fix stray </style> or </script> tags' meta scopes.
They are now correctly scoped meta.tag.[style|script].
opt-in to python 3.8 plugin_host (used for YAMLMacros)
add more syntax tests to ensure not to break syntax by future changes.

FichteFoll · 2023-01-06T19:01:52Z

Add attribute name interpolation support (e.g.: <p v-#[ name expr ])

To reiterate on that, there are actually two additions here.

Add attribute name interpolation support (e.g.: <p :[ name expr ]="value expr">)
Add support for slot shorthand syntax (e.g.: <p #default="props">)

deathaxe · 2023-02-01T20:08:33Z

Merging this PR may become important for end users due to sublimehq/sublime_text#5852

skyronic · 2023-02-01T20:13:47Z

Thank you! I did some testing and everything seems to work good. I'm going to merge this, and will make a release after a bit more testing.

Addresses #216 (comment) This commit includes `JavaScript#expression-statement` context in attribute/directive values to highlight mappings correctly. The `pop: 1` is removed as the included context pops itself off stack.

skyronic · 2023-02-02T00:59:26Z

Thanks again for the great work folks, the PR has now been released as part of 4.1.0. I tested it with a wide variety of vue files in different open source projects and everything seemed to work great.

Please let me know if there are any issues with upgrading!

deathaxe added 11 commits September 9, 2021 17:41

Add section separators

2cd5fce

Improve readability.

Reorganize and group contexts in sections

30c74d9

Fix meta scopes of template tags

bfb0a83

This commit... 1. fixes duplicated meta.tag scopes in `<template>` tags 2. fixes missing meta.tag scope at the closing `>` in `<template>` tags 3. adds syntax tests for template tags

Reorganize syntax header

0e4f459

applies sublimehq/Packages#2430

Replace remaining pop: true by pop: 1

cf103cc

All sublime-syntax version 2 files should use explicit `pop: 1` instead of `pop: true`. It looks more consistent in case `pop: 2` are used.

Reuse tag-end context

0af7f8b

No need to duplicate the match directive if it already exists.

Exclude prototypes from attribute value starts

5b0e5de

This commit fixes sublimehq/Packages#2910 for all ST builds before 4114.

deathaxe mentioned this pull request Sep 9, 2021

[HTML] Fix scopes of stray script and style tags sublimehq/Packages#3032

Merged

FichteFoll reviewed Feb 22, 2022

View reviewed changes

Vue Component.sublime-syntax Outdated Show resolved Hide resolved

deathaxe added 2 commits February 22, 2022 20:51

Fix JS expression interpolation in directives

78f5c47

Addresses #216 (comment) This commit includes `JavaScript#expression-statement` context in attribute/directive values to highlight mappings correctly. The `pop: 1` is removed as the included context pops itself off stack.

Opt-in to python 3.8 plugin host

c05ea53

Run YAML macros in python 3.8 in order to maintain dictionary key sort order.

FichteFoll added 3 commits October 15, 2022 12:03

Use vue suffix for embed_scope in attributes and mustache

34d3b01

This allows easily targeting the embed scopes inside attributes as something that is contributed and supported by the vue syntax only as opposed to a a `<script>` tag which uses HTML syntax.

Add line break at EOL

e576c31

Add highlighting for #attr="name-list" slot syntax

a5b2f14

FichteFoll and others added 4 commits January 5, 2023 17:19

Add support for "dynamic arguments"

b010989

Merge pull request #1 from FichteForks/pr/embed-enhancements

bb01737

Use vue suffix for embed_scope in attributes and mustache

Tweak script/style pattern order

63fb8bf

This commit moves terminating patterns to the top so they match with max priority in case of overlapping patterns. This change is just to be future proof if core HTML syntax changes.

Fix attribute name interpolation

30380d0

1. extend `meta.interpolation` to include leading and trailing punctuation to comply with ST's scope naming guidelines. 2. fix closing `]` scope. 3. adjust/add tests

FichteFoll approved these changes Jan 5, 2023

View reviewed changes

deathaxe mentioned this pull request Feb 1, 2023

A syntax definition may trigger text manipulation sublimehq/sublime_text#5852

Closed

skyronic merged commit ec6e5e7 into vuejs:st4 Feb 1, 2023

This was referenced Feb 1, 2023

Better v-on '@' shorthand match #206

Closed

Incomplete scope inside @click and other directives #180

Open

Typescript not working in new branch. #182

Open

Add scopes for directives #174

Open

having Function as object value breaks highlighting #172

Closed

deathaxe deleted the st4 branch February 2, 2023 18:51

deathaxe restored the st4 branch February 2, 2023 18:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ST4] A whole bunch of fixes and improvements. #216

[ST4] A whole bunch of fixes and improvements. #216

deathaxe commented Sep 9, 2021

rchl commented Sep 9, 2021

deathaxe commented Feb 2, 2022

FichteFoll commented Mar 4, 2022

deathaxe commented Mar 4, 2022

FichteFoll commented Mar 7, 2022

FichteFoll commented Jan 5, 2023

deathaxe commented Jan 5, 2023

skyronic commented Jan 5, 2023

deathaxe commented Jan 6, 2023 •

edited

FichteFoll commented Jan 6, 2023 •

edited

deathaxe commented Feb 1, 2023

skyronic commented Feb 1, 2023

skyronic commented Feb 2, 2023

[ST4] A whole bunch of fixes and improvements. #216

[ST4] A whole bunch of fixes and improvements. #216

Conversation

deathaxe commented Sep 9, 2021

rchl commented Sep 9, 2021

deathaxe commented Feb 2, 2022

FichteFoll commented Mar 4, 2022

deathaxe commented Mar 4, 2022

FichteFoll commented Mar 7, 2022

FichteFoll commented Jan 5, 2023

deathaxe commented Jan 5, 2023

skyronic commented Jan 5, 2023

deathaxe commented Jan 6, 2023 • edited

Changelog

FichteFoll commented Jan 6, 2023 • edited

deathaxe commented Feb 1, 2023

skyronic commented Feb 1, 2023

skyronic commented Feb 2, 2023

deathaxe commented Jan 6, 2023 •

edited

FichteFoll commented Jan 6, 2023 •

edited