Skip to content

Latest commit

 

History

History
130 lines (100 loc) · 3.71 KB

README.md

File metadata and controls

130 lines (100 loc) · 3.71 KB
Raw

Riot-Tag

NOTE: This plugin should continue to work fine, however be aware it is no longer being maintained and will not receive any additional updates.

Riot.js tag syntax highlighting for Visual Studio Code

screencast

This is a conversion of my sublime-tag extension to do syntax highlighting for Riot js tag files. This extension supports HTML, Jade, Stylus and Coffeescript within script tags.

With this plugin you can use

<yourtag>
  <script type="test/coffee">
    # your coffee script here
  </script>
  <script>
    // your javascript here
  </script>
</yourtag>

This will then have correct syntax highlighting.

What's New

I've merged the highlighting for Jade + HTML so there is no need to choose which one you want to use, just type and it should work.

Jade Support

If you like white space sensitive languages, Jade can be a very succinct way to write your tags. The compile process converts all this to html before usage, so there are no overheads to your packages tags. Riot-tag(Jade) supports Jade syntax highlighting, along with embedded coffeescript, stylus and normal JS.

yourtag
  p hello world

  script(type="coffee").
    # your coffee script here
    
  style.
    /* your css here */
    
  style(type="text/stylus")
    // your stylus here

Stylus Support

You can use stylus within your riot tags, the syntax highlighting requires you to have the stylus syntax highlighting install too. To compile stylus you'll also need stylus included in your compile process (see browserify tip below).

Installation

Inside visual studio code

cmd+shift+p
type: ext install riot-tag

The package contains 2 syntax highlighters riot(html) and riot(jade). If VSCode picks the wrong one, you can specify the correct one in your settings file.

Using with Browserify

If you like the idea of using Jade, Coffeescript, Stylus etc with your riot tags, adding the below to your package.json file should get you most of the way. Just swap out the package names if you'd prefer not to use any of the compile steps. Non of this is neccesary for riot, but it took me a while to work this out when I started our with riot, once in place it can make a nice workflow.

{
  "scripts":{
    "watch": "./node_modules/.bin/watchify src/app.coffee -v -o build/site.js",
    "build": "./node_modules/.bin/browserify src/app.coffee -d -p [minifyify --uglify [--mangle 0] --map build/app.map.json --output build/app.map.json] -o build/app.js"
  },
  "browserify": {
    "debug": true,
    "transform": [
      [
        "riotify",{
          "expr": false,
          "type": "coffee",
          "template": "jade"
        }
      ]
    ]
  },
  "devDependencies": {
    "riot": "^2.3.15",
    "riotify": "^0.1.2",
    "stylus": "^0.52.4",
    "browserify": "^11.2.0",
    "jade": "^1.11.0",
    "watchify": "^3.4.0",
    "minifyify": "^7.1.0"
  }
}

Then use npm run watch during development and npm run build prior to deployment for minified code.

Giving Feedback

If you have any problems, feedback or just fancy staring this project see https://github.com/crisward/riot-tag

History

Version Description
0.1.8 I've merged the highlighting for Jade + HTML so there is no need to choose which one you want to use, just type and it should work.
0.1.6 Allows underscores in attribute names
0.1.5 Can now use style(type="stylus")
0.1.4 Fixed sourcename bug
0.1.1 Can now use script(type="coffee") or <script type="coffee">
0.0.8 Fixed Stylus Bug
0.0.7 Added stylus support for Jade
0.0.6 Allows multiple script tags in jade