Merge pull request #10 from michaelblyons/embed-inherited-shell

Add ST4 features

Author: michaelblyons

.github/workflows/syntax.yml

@@ -25,12 +25,15 @@ jobs:
       matrix:
         include:
           - build: 'latest'
+            packages: master
           - build: 'stable'
-          - build: 3211
+            packages: v4193  # revert to 'binary' when Bash rewrite drops in stable
+          - build: 4086
+            packages: v4193  # Bash rewrite
     steps:
       - uses: actions/checkout@v4
       - uses: SublimeText/syntax-test-action@v2
         with:
           build: ${{ matrix.build }}
+          default_packages: ${{ matrix.packages }}
           package_name: 'Crontab'
-          dummy_syntaxes: source.shell

Bash (for Crontab).sublime-syntax

@@ -0,0 +1,27 @@
+%YAML 1.2
+---
+name: Bash (for Crontab)
+scope: source.shell.bash.crontab
+version: 2
+hidden: true
+
+extends: Packages/ShellScript/Bash.sublime-syntax
+
+contexts:
+  prototype:
+    - meta_prepend: true
+    - include: crontab-char-escapes
+
+  parameter-expansions:
+    - meta_prepend: true
+    - include: crontab-char-escapes
+
+  string-prototype:
+    - meta_prepend: true
+    - include: crontab-char-escapes
+
+  crontab-char-escapes:
+    - match: '\\%'
+      scope: constant.character.escape.crontab
+    - match: '%'
+      scope: constant.character.newline.crontab

Crontab.sublime-settings

@@ -10,4 +10,13 @@
         "month": "region.bluish",
         "day-of-week": "region.yellowish",
     },
+
+    // Activate auto-complete for @-expressions
+    "auto_complete_triggers":
+    [
+        {
+            "characters": "@",
+            "selector": "source.crontab",
+        },
+    ],
 }

Crontab.sublime-syntax

@@ -2,6 +2,7 @@
 ---
 name: Crontab
 scope: source.crontab
+version: 2
 
 file_extensions:
   - tab
@@ -14,10 +15,6 @@ contexts:
     - include: variables
     - include: at-syntax
     - include: cron-syntax
-    # Don't `invalid.illegal` in-process completions
-    - match: '{{snippet_typing}}'
-    - match: ^\s*\w+
-      scope: invalid.illegal.crontab
 
 ###[ CRON EXPRESSIONS ]########################################################
 
@@ -43,7 +40,7 @@ contexts:
     - meta_content_scope:
         meta.string.cron-expression.crontab
         meta.sequence.cron.minute.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: illegal-punctuation
     - include: cron-common
     - match: \b{{minute}}(-){{minute}}\b
@@ -52,13 +49,14 @@ contexts:
         1: punctuation.separator.sequence.crontab
     - match: \b{{minute}}\b
       scope: constant.numeric.integer.decimal.crontab
+    - include: illegal-numbers
     - match: (?=[ \t])
       set: cron-hour-is-next
     - include: illegal-non-whitespace
 
   cron-hour-is-next:
     - meta_content_scope: meta.string.cron-expression.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: cron-initial-comma
     - match: (?=\S)
       set: cron-hour
@@ -67,7 +65,7 @@ contexts:
     - meta_content_scope:
         meta.string.cron-expression.crontab
         meta.sequence.cron.hour.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: illegal-punctuation
     - include: cron-common
     - match: \b{{hour}}(-){{hour}}\b
@@ -76,13 +74,14 @@ contexts:
         1: punctuation.separator.sequence.crontab
     - match: \b{{hour}}\b
       scope: constant.numeric.integer.decimal.crontab
+    - include: illegal-numbers
     - match: (?=[ \t])
       set: cron-day-of-month-is-next
     - include: illegal-non-whitespace
 
   cron-day-of-month-is-next:
     - meta_content_scope: meta.string.cron-expression.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: cron-initial-comma
     - match: (?=\S)
       set: cron-day-of-month
@@ -91,7 +90,7 @@ contexts:
     - meta_content_scope:
         meta.string.cron-expression.crontab
         meta.sequence.cron.day-of-month.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: illegal-punctuation
     - include: cron-common
     - match: \b{{day_of_month}}(-){{day_of_month}}\b
@@ -102,6 +101,7 @@ contexts:
       captures:
         1: constant.numeric.integer.decimal.crontab
         2: invalid.deprecated.non-standard.crontab
+    - include: illegal-numbers
     - match: \?
       scope: invalid.deprecated.non-standard.crontab
     - match: (?=[ \t])
@@ -110,7 +110,7 @@ contexts:
 
   cron-month-is-next:
     - meta_content_scope: meta.string.cron-expression.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: cron-initial-comma
     - match: (?=\S)
       set: cron-month
@@ -119,7 +119,7 @@ contexts:
     - meta_content_scope:
         meta.string.cron-expression.crontab
         meta.sequence.cron.month.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: illegal-punctuation
     - include: cron-common
     - match: \b{{month}}(-){{month}}\b
@@ -128,6 +128,7 @@ contexts:
         1: punctuation.separator.sequence.crontab
     - match: \b{{month}}\b
       scope: constant.numeric.integer.decimal.crontab
+    - include: illegal-numbers
     - match: \b({{words_month}})(-)({{words_month}})\b
       scope: constant.other.range.crontab
       captures:
@@ -138,11 +139,10 @@ contexts:
       scope: support.constant.month-name.crontab
     - match: (?=[ \t])
       set: cron-day-of-week-is-next
-    - include: illegal-non-alpha
 
   cron-day-of-week-is-next:
     - meta_content_scope: meta.string.cron-expression.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: cron-initial-comma
     - match: (?=\S)
       set: cron-day-of-week
@@ -151,7 +151,7 @@ contexts:
     - meta_content_scope:
         meta.string.cron-expression.crontab
         meta.sequence.cron.day-of-week.crontab
-    - include: pop-nl
+    - include: pop-eol
     - include: illegal-punctuation
     - include: cron-common
     - match: \b{{day_of_week}}(-){{day_of_week}}\b
@@ -162,6 +162,7 @@ contexts:
       captures:
         1: constant.numeric.integer.decimal.crontab
         2: invalid.deprecated.non-standard.crontab
+    - include: illegal-numbers
     - match: \b({{words_day_of_week}})(-)({{words_day_of_week}})\b
       scope: constant.other.range.crontab
       captures:
@@ -174,22 +175,31 @@ contexts:
       scope: invalid.deprecated.non-standard.crontab
     - match: (?=[ \t])
       set: command-is-next
-    - include: illegal-non-alpha
 
   command-is-next:
-    - include: pop-nl
+    - include: pop-eol
     - match: \s+
-      embed: scope:source.shell
-      escape: (?=\n|$)
+      embed: scope:source.shell.bash.crontab
+      escape: (?=$|(?<!\\)%)
+    - match: (?=%)
+      set: command-stdin
+
+  command-stdin:
+    - meta_content_scope: meta.string.stdin.crontab string.unquoted.crontab
+    - include: pop-eol
+    - match: \\%
+      scope: constant.character.escape.crontab
+    - match: '%'
+      scope: constant.character.newline.crontab
 
   at-syntax:
     # Keyword, then script embed
     - match: ^\s*((@){{keywords}})[ \t]+
       captures:
         1: constant.language.schedule.crontab
         2: punctuation.definition.variable.crontab
-      embed: scope:source.shell
-      escape: $
+      embed: scope:source.shell.bash.crontab
+      escape: (?=$)
     # Don't unhighlight keywords just because EOL
     - match: ^\s*((@){{keywords}})\b
       captures:
@@ -201,19 +211,7 @@ contexts:
         1: punctuation.definition.variable.crontab
         2: meta.completion.at.crontab
 
-###[ MISCELLANEOUS ]###########################################################
-
-  comments:
-    - match: ^\s*(?=#)
-      push: comment
-
-  comment:
-    - match: '#'
-      scope: punctuation.definition.comment.crontab
-      push:
-        - meta_scope: comment.line.number-sign.crontab
-        - include: pop-nl
-    - include: pop-nl
+###[ ENVIRONMENT VARIABLES ]###################################################
 
   variables:
     - match: ^([a-zA-Z0-9_]+)\s*(=)
@@ -223,33 +221,53 @@ contexts:
       push: variable-value
 
   variable-value:
-    - include: pop-nl
+    - include: pop-eol
     - match: '"'
       scope: punctuation.definition.string.begin.crontab
-      set:
-        - meta_scope: string.quoted.double.crontab
-        - match: '"'
-          scope: punctuation.definition.string.end.crontab
-          pop: true
+      set: string-body-double
     - match: "'"
       scope: punctuation.definition.string.begin.crontab
-      set:
-        - meta_scope: string.quoted.single.crontab
-        - match: "'"
-          scope: punctuation.definition.string.end.crontab
-          pop: true
+      set: string-body-single
     - match: \S
+      push: string-body-unquoted
+
+  string-body-double:
+    - meta_scope: meta.string.crontab string.quoted.double.crontab
+    - match: '"'
+      scope: punctuation.definition.string.end.crontab
+      pop: 1
+
+  string-body-single:
+    - meta_scope: meta.string.crontab string.quoted.single.crontab
+    - match: "'"
+      scope: punctuation.definition.string.end.crontab
+      pop: 1
+
+  string-body-unquoted:
+    - meta_scope: meta.string.crontab string.unquoted.crontab
+    - match: (?=\s*$)
+      pop: 1
+
+###[ MISCELLANEOUS ]###########################################################
+
+  comments:
+    - match: ^\s*(?=#)
+      push: comment
+
+  comment:
+    - match: '#'
+      scope: punctuation.definition.comment.crontab
       push:
-        - meta_scope: string.unquoted.crontab
-        - match: (?=\s*$)
-          pop: true
+        - meta_scope: comment.line.number-sign.crontab
+        - include: pop-eol
+    - include: pop-eol
 
   illegal-punctuation:
     - match: \*{2,}|[/,?-]{2,}|,(?=[ \t])
       scope: invalid.illegal.crontab
 
-  illegal-non-alpha:
-    - match: (?i:[^a-z\s]+)
+  illegal-numbers:
+    - match: \d+
       scope: invalid.illegal.crontab
 
   illegal-non-whitespace:
@@ -258,9 +276,9 @@ contexts:
 
 ###[ PROTOTYPE ]###############################################################
 
-  pop-nl:
+  pop-eol:
     - match: $\n?
-      pop: true
+      pop: 1
 
 ###############################################################################
 

Lint Crontab.sublime-build

@@ -0,0 +1,4 @@
+{
+    "selector": "source.crontab",
+    "cmd": ["crontab", "-T", "$file"],
+}

README.md

@@ -1,4 +1,4 @@
-# Crontab for Sublime Text 3
+# Crontab for Sublime Text
 
 [![GitHub license](https://img.shields.io/github/license/michaelblyons/SublimeSyntax-Crontab.svg)](https://github.com/michaelblyons/SublimeSyntax-Crontab/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/michaelblyons/SublimeSyntax-Crontab.svg)](https://GitHub.com/michaelblyons/SublimeSyntax-Crontab/releases/)
@@ -12,7 +12,7 @@
 - Color-coded underline for `cron` expressions.
 - Completions for `cron` expressions and enums like month names.
 - Hover on a `cron` expression for an explanation.
-- Shell syntax highlighting for cron commands
+- Shell syntax highlighting for `cron` commands
 - Comment and uncommenting lines using <kbd>Ctrl</kbd>+<kbd>/</kbd> or <kbd>Cmd</kbd>+<kbd>/</kbd>.
 
 ## Installation
@@ -23,11 +23,11 @@
 
 ## Todos
 
-- [ ] Alert on unescaped usage of `%` in crontab line.
 - [ ] Provide a template file of things to do when creating a crontab file.
 - [ ] Additional "system" crontab syntax with user/group support.
 - [x] Options to change or disable rainbow underlines. (#4)
 - [x] Continuous integration
+- [ ] Autocomplete works after `,` and `-`
 
 ## Credits/Acknowledgements