miki-template 1.2.0

package/miki-template-extension/README.md

@@ -0,0 +1,82 @@
+# miki-template VS Code Extension
+
+Syntax highlighting, bracket matching, and snippets for [miki-template](https://github.com/alainmiki/miki-template) — a Django-style template engine for Node.js and Express.
+
+## Features
+
+- Syntax highlighting for `.miki` and `.miki-template` files
+- Snippets for all built-in tags and common patterns
+- Bracket auto-closing for `{% %}`, `{{ }}`, `{# #}`
+- Comment toggling with `{# #}`
+
+## Supported Tags
+
+`if / elif / else / endif`, `for / empty / endfor`, `with / endwith`, `cycle`, `comment / endcomment`, `verbatim / endverbatim`, `include`, `extends`, `block / endblock`, `partialdef / endpartialdef`, `partial`, `load`, `templatetag`, `trans`, `blocktrans`, `language / endlanguage`, `widthratio`, `debug`, `autoescape / endautoescape`, `filter / endfilter`, `plural`, `cache / endcache`, `markdown / endmarkdown`, `regroup`, `firstof`, `csrf_token`, `csp_nonce_attr`, `static`, `url`
+
+## Supported Filters
+
+`upper`, `lower`, `title`, `capfirst`, `slugify`, `wordcount`, `striptags`, `linebreaks`, `linebreaksbr`, `truncatewords`, `truncatechars`, `safe`, `escape`, `escapejs`, `length`, `length_is`, `join`, `slice`, `dictsort`, `dictsortreversed`, `first`, `last`, `default`, `default_if_none`, `firstof`, `date`, `time`, `strftime`, `timesince`, `timeuntil`, `add`, `divisibleby`, `floatformat`, `yesno`, `pluralize`, `filesizeformat`, `urlencode`, `escapeuri`, `stringformat`, `cut`, `addslashes`, `removetags`, `trans`, `regroup`, `intcomma`, `intword`, `apnumber`, `ordinal`, `naturalday`, `lorem`
+
+## Installation
+
+### From VS Code Marketplace
+
+```bash
+code --install-extension miki-template
+```
+
+Or search for **miki-template** in the Extensions view (`Ctrl+Shift+X`).
+
+### Manual installation
+
+1. Copy `syntaxes/` and `snippets/` into your project or user settings
+2. Associate `.miki` files with `miki-template`
+
+## File Associations
+
+Add to your workspace or user `settings.json`:
+
+```json
+{
+  "files.associations": {
+    "*.miki": "miki-template",
+    "*.miki-template": "miki-template"
+  }
+}
+```
+
+## Snippets
+
+Type any of the following prefixes and press `Tab`:
+
+| Prefix | Output |
+|--------|--------|
+| `if` | `{% if %}...{% endif %}` |
+| `ifelse` | `{% if %}...{% else %}...{% endif %}` |
+| `for` | `{% for %}` with `empty` |
+| `block` | `{% block %}` |
+| `extends` | `{% extends %}` |
+| `include` | `{% include %}` |
+| `with` | `{% with %}` |
+| `cycle` | `{% cycle %}` |
+| `trans` | `{% trans %}` |
+| `blocktrans` | `{% blocktrans %}` |
+| `language` | `{% language %}` |
+| `partialdef` | `{% partialdef %}` |
+| `partial` | `{% partial %}` |
+| `csrf` | `{% csrf_token %}` |
+| `csp` | `{% csp_nonce_attr %}` |
+| `static` | `{% static %}` |
+| `url` | `{% url %}` |
+| `widthratio` | `{% widthratio %}` |
+| `debug` | `{% debug %}` |
+| `load` | `{% load %}` |
+| `comment` | `{# #}` block comment |
+| `verbatim` | `{% verbatim %}` |
+| `regroup` | `{% for %}` with `regroup` filter |
+| `firstof` | `{% firstof %}` |
+| `filter` | `{% filter %}` block |
+
+## License
+
+MIT

package/miki-template-extension/icon.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128">
+  <rect width="128" height="128" rx="16" fill="#0c4a6e"/>
+  <path d="M24 28h56v8H24zM24 52h56v8H24zM24 76h40v8H24z" fill="#fff" opacity="0.9"/>
+  <path d="M24 100h24v8H24z" fill="#7dd3fc"/>
+  <text x="92" y="36" font-family="monospace" font-size="11" fill="#7dd3fc">%}</text>
+  <text x="92" y="60" font-family="monospace" font-size="11" fill="#7dd3fc">%}</text>
+  <text x="92" y="84" font-family="monospace" font-size="11" fill="#7dd3fc">%}</text>
+  <text x="40" y="108" font-family="monospace" font-size="11" fill="#0c4a6e">{%</text>
+</svg>

package/miki-template-extension/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "miki-template",
+  "displayName": "miki-template",
+  "description": "Django-style template language syntax highlighting and snippets for miki-template",
+  "version": "1.2.0",
+  "engines": {
+    "vscode": "^1.0.0"
+  },
+  "categories": [
+    "Programming Languages",
+    "Snippets"
+  ],
+  "contributes": {
+    "languages": [
+      {
+        "id": "miki-template",
+        "aliases": ["miki-template", "miki", "django-template"],
+        "extensions": [".miki", ".miki-template"],
+        "configuration": "./language-configuration.json"
+      }
+    ],
+    "grammars": [
+      {
+        "language": "miki-template",
+        "scopeName": "text.html.miki",
+        "path": "./syntaxes/miki-template.tmLanguage.json",
+        "tokenTypes": {
+          "text": "text.html.miki"
+        }
+      }
+    ],
+    "snippets": [
+      {
+        "language": "miki-template",
+        "path": "./snippets/miki-template.json"
+      }
+    ]
+  },
+  "publisher": "alainmiki",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alainmiki/miki-template.git"
+  },
+  "license": "MIT",
+  "icon": "icon.png"
+}

package/miki-template-extension/snippets/miki-template.json

@@ -0,0 +1,177 @@
+{
+  "miki-template": {
+    "if": {
+      "prefix": "if",
+      "body": [
+        "{% if ${1:condition} %}",
+        "  ${2:content}",
+        "{% endif %}"
+      ],
+      "description": "If block"
+    },
+    "ifelse": {
+      "prefix": "ifelse",
+      "body": [
+        "{% if ${1:condition} %}",
+        "  ${2:content}",
+        "{% else %}",
+        "  ${3:fallback}",
+        "{% endif %}"
+      ],
+      "description": "If/else block"
+    },
+    "for": {
+      "prefix": "for",
+      "body": [
+        "{% for ${1:item} in ${2:items} %}",
+        "  ${3:{{ ${1} }}}",
+        "{% empty %}",
+        "  ${4:No items}",
+        "{% endfor %}"
+      ],
+      "description": "For loop"
+    },
+    "block": {
+      "prefix": "block",
+      "body": [
+        "{% block ${1:name} %}",
+        "  ${2:content}",
+        "{% endblock %}"
+      ],
+      "description": "Block definition"
+    },
+    "extends": {
+      "prefix": "extends",
+      "body": "{% extends \"${1:base.html}\" %}",
+      "description": "Extends parent template"
+    },
+    "include": {
+      "prefix": "include",
+      "body": "{% include \"${1:header.html}\" %}",
+      "description": "Include template"
+    },
+    "with": {
+      "prefix": "with",
+      "body": [
+        "{% with ${1:var} as ${2:alias} %}",
+        "  ${3:{{ ${2} }}}",
+        "{% endwith %}"
+      ],
+      "description": "With block"
+    },
+    "cycle": {
+      "prefix": "cycle",
+      "body": "{% cycle '${1:odd}' '${2:even}' %}",
+      "description": "Cycle tag"
+    },
+    "trans": {
+      "prefix": "trans",
+      "body": "{% trans \"${1:Hello, World!}\" %}",
+      "description": "Translate string"
+    },
+    "blocktrans": {
+      "prefix": "blocktrans",
+      "body": [
+        "{% blocktrans with ${1:name}=${2:user.name} %}",
+        "  ${3:Hello {{ ${1} }}}",
+        "{% endblocktrans %}"
+      ],
+      "description": "Translate block"
+    },
+    "language": {
+      "prefix": "language",
+      "body": [
+        "{% language \"${1:fr}\" %}",
+        "  ${2}",
+        "{% endlanguage %}"
+      ],
+      "description": "Switch language"
+    },
+    "partialdef": {
+      "prefix": "partialdef",
+      "body": [
+        "{% partialdef ${1:name} %}",
+        "  ${2}",
+        "{% endpartialdef %}"
+      ],
+      "description": "Define partial"
+    },
+    "partial": {
+      "prefix": "partial",
+      "body": "{% partial ${1:name} %}",
+      "description": "Render partial"
+    },
+    "csrf": {
+      "prefix": "csrf",
+      "body": "{% csrf_token %}",
+      "description": "CSRF token input"
+    },
+    "csp": {
+      "prefix": "csp",
+      "body": "<script {% csp_nonce_attr %}></script>",
+      "description": "CSP nonce attribute"
+    },
+    "static": {
+      "prefix": "static",
+      "body": "{% static \"${1:css/app.css}\" %}",
+      "description": "Static file URL"
+    },
+    "url": {
+      "prefix": "url",
+      "body": "{% url \"${1:route_name}\" ${2:args} %}",
+      "description": "URL for named route"
+    },
+    "widthratio": {
+      "prefix": "widthratio",
+      "body": "{% widthratio ${1:value} ${2:max} ${3:max_width} %}",
+      "description": "Proportional width"
+    },
+    "debug": {
+      "prefix": "debug",
+      "body": "{% debug %}",
+      "description": "Dump template context"
+    },
+    "load": {
+      "prefix": "load",
+      "body": "{% load ${1:i18n} %}",
+      "description": "Load tag library"
+    },
+    "comment": {
+      "prefix": "comment",
+      "body": [
+        "{#",
+        "  ${1:comment}",
+        "#}"
+      ],
+      "description": "Comment block"
+    },
+    "verbatim": {
+      "prefix": "verbatim",
+      "body": [
+        "{% verbatim %}",
+        "  ${1}",
+        "{% endverbatim %}"
+      ],
+      "description": "Verbatim block"
+    },
+    "regroup": {
+      "prefix": "regroup",
+      "body": "{% for ${1:group} in ${2:items}|regroup:\"${3:category}\" %}{{ ${1}.grouper }}{% endfor %}",
+      "description": "Regroup by attribute"
+    },
+    "firstof": {
+      "prefix": "firstof",
+      "body": "{% firstof ${1:var1} ${2:var2} \"${3:fallback}\" %}",
+      "description": "First truthy value"
+    },
+    "filter_block": {
+      "prefix": "filter",
+      "body": [
+        "{% filter ${1:lower} %}",
+        "  ${2}",
+        "{% endfilter %}"
+      ],
+      "description": "Filter block"
+    }
+  }
+}

package/miki-template-extension/syntaxes/language-configuration.json

@@ -0,0 +1,26 @@
+{
+  "comments": {
+    "lineComment": "{#",
+    "blockComment": ["{#", "#}"]
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"", "notIn": ["string"] },
+    { "open": "'", "close": "'", "notIn": ["string", "comment"] }
+  ],
+  "surroundingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "wordPattern": "[a-zA-Z_][a-zA-Z0-9_.]*"
+}

package/miki-template-extension/syntaxes/miki-template.tmLanguage.json

@@ -0,0 +1,146 @@
+{
+  "scopeName": "text.html.miki",
+  "name": "miki-template",
+  "patterns": [
+    {
+      "include": "#comment"
+    },
+    {
+      "include": "#tag"
+    },
+    {
+      "include": "#variable"
+    },
+    {
+      "include": "#string"
+    }
+  ],
+  "repository": {
+    "comment": {
+      "name": "comment.block.miki",
+      "begin": "\\{#",
+      "end": "#\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.comment.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.comment.end.miki" }
+      }
+    },
+    "tag": {
+      "name": "meta.tag.miki",
+      "begin": "\\{%",
+      "end": "%\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.tag.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.tag.end.miki" }
+      },
+      "patterns": [
+        {
+          "name": "entity.name.tag.miki",
+          "match": "(?i)\\b(if|elif|else|endif|for|empty|endfor|with|endwith|cycle|comment|endcomment|verbatim|endverbatim|include|extends|block|endblock|partialdef|endpartialdef|partial|load|templatetag|trans|blocktrans|language|endlanguage|plural|widthratio|debug|endif|endfor|endwith|endblock|endcomment|endverbatim|endpartialdef|endblocktrans|endlanguage|endcache|endmarkdown)\\b"
+        },
+        {
+          "name": "string.quoted.double.miki",
+          "match": "\"[^\"]*\""
+        },
+        {
+          "name": "string.quoted.single.miki",
+          "match": "'[^']*'"
+        },
+        {
+          "name": "constant.numeric.miki",
+          "match": "\\b\\d+\\b"
+        },
+        {
+          "name": "keyword.operator.miki",
+          "match": "(?i)\\b(and|or|not|in|not in)\\b"
+        },
+        {
+          "name": "punctuation.separator.miki",
+          "match": "="
+        }
+      ]
+    },
+    "variable": {
+      "name": "variable.other.miki",
+      "begin": "\\{\\{",
+      "end": "\\}\\}",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.variable.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.variable.end.miki" }
+      },
+      "patterns": [
+        {
+          "name": "variable.other.miki",
+          "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
+        },
+        {
+          "include": "#filter"
+        },
+        {
+          "name": "string.quoted.double.miki",
+          "match": "\"[^\"]*\""
+        },
+        {
+          "name": "string.quoted.single.miki",
+          "match": "'[^']*'"
+        }
+      ]
+    },
+    "filter": {
+      "name": "meta.filter.miki",
+      "begin": "\\|",
+      "end": "(?=\\}|$)",
+      "beginCaptures": {
+        "0": { "name": "punctuation.separator.filter.miki" }
+      },
+      "patterns": [
+        {
+          "name": "support.function.miki",
+          "match": "[a-zA-Z_][a-zA-Z0-9_]*"
+        },
+        {
+          "begin": ":",
+          "beginCaptures": {
+            "0": { "name": "punctuation.separator.filter.argument.miki" }
+          },
+          "end": "(?=\\||\\}\\})",
+          "patterns": [
+            {
+              "name": "string.quoted.double.miki",
+              "match": "\"[^\"]*\""
+            },
+            {
+              "name": "string.quoted.single.miki",
+              "match": "'[^']*'"
+            },
+            {
+              "name": "constant.numeric.miki",
+              "match": "\\b\\d+\\b"
+            },
+            {
+              "name": "variable.other.miki",
+              "match": "[a-zA-Z_][a-zA-Z0-9_.]*"
+            }
+          ]
+        }
+      ]
+    },
+    "string": {
+      "name": "string.quoted.double.miki",
+      "begin": "\"",
+      "end": "\"",
+      "beginCaptures": {
+        "0": { "name": "punctuation.definition.string.begin.miki" }
+      },
+      "endCaptures": {
+        "0": { "name": "punctuation.definition.string.end.miki" }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "miki-template",
+  "version": "1.2.0",
+  "description": "Django-Style template engine for Node.js and Express",
+  "main": "src/index.js",
+  "exports": {
+    ".": {
+      "import": "./src/esm.mjs",
+      "require": "./src/index.js",
+      "default": "./src/index.js"
+    }
+  },
+  "scripts": {
+    "test": "node -e \"const fs=require('fs');const path=require('path');const files=fs.readdirSync('tests').filter(f=>f.endsWith('.test.js')||f.endsWith('.test.mjs')).map(f=>path.join('tests',f));require('child_process').execSync('node --test '+files.join(' '),{stdio:'inherit'})\"",
+    "bench": "node benchmarks/run.js"
+  },
+  "keywords": [
+    "django",
+    "template",
+    "engine",
+    "express",
+    "nodejs",
+    "esm"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "he": "^1.2.0",
+    "date-fns": "^3.6.0"
+  }
+}