search

hayaku / hayaku

Fuzzy abbreviations, support for preprocessors (Sass, Less, Stylus) and a lot of other features in easily configurable set of tools for writing CSS faster
http://hayakubundle.com/
MIT License
971 stars 43 forks source link
abbreviations auto-complete css snippets sublime-package sublime-text-3

readme

Hayaku 1.5.4 Build Status

Hayaku is a bundle of useful scripts aiming for rapid front-end web development.

The main aim of Hayaku is to create the fastest way to write and maintain CSS code in an editor.

Table of Contents

  1. Install Hayaku for Sublime Text

  2. Features

  3. Settings and Preferences

  4. Using Hayaku with CSS Preprocessors

  5. License and copyrights

Install Hayaku for Sublime Text

Right now Hayaku is available only for Sublime Text (even for third version!), but when it would be complete, we would port it to some other editors.

Using Package Control:

  1. Run Package Control: Install Package command
  2. Search for Hayaku - tools for writing CSS faster (Hayaku should be enough) and wait for it to be installed
  3. Restart Sublime Text (required to make default settings for different syntaxes to work)

Or manually, using git:

Clone repository into Packages directory (can be found using Preferences: Browse Packages command in Sublime Text)

git clone git://github.com/hayaku/hayaku.git

And then restart Sublime Text.

Note on autocomplete

Important: Hayaku disables the autocomplete for CSS by default. This was made to remove the ambiguosity and confusion that could happen when you'll see one result in autocomplete and would get something different on pressing tab.

You can restore the autocomplete by redefining the auto_complete_selector setting in your User/Preferences.sublime-settings to either the default value:

{
    "auto_complete_selector": "source - comment, meta.tag - punctuation.definition.tag.begin"
}

Or to anything other you'd like.

However, for CSS scopes this would only enable the autocompletes by enter, the tab autocomplete would still run the Hayaku when possible.

Features

Smart CSS Abbreviations

Hayaku is not your average snippet engine. Most of the CSS snippets to date are static — you need to remember all the abbreviations if you want to use them.

Hayaku offers a better and faster way: you don't need to remember anything, you can just try to write the shortest abbreviation for a thing you want to write in CSS — and Hayaku would try to guess it when you press tab.

There are a lot of things Hayaku can do in abbeviations, here are some of them:

Fuzzy CSS property abbreviations

This is the first basic thing: Hayaku don't have any premade snippets for CSS, it have a dictionary with a lot of CSS properties, so when you write some abrakadabra, it tries to parse it and guess what you meant. For most properties those abbreviations could be rather short, but you're not sticked to them: you can write as much letters for a property as you wish.

So, writing w, wi or wid would give you width. And don't forget about the fuzzy part: wdt and wdth would work too.

Sometimes you would guess that some abbreviations must become other things, but in most cases all the variants have some logic beyound. b could be expanded to background or border, but expanded to bottom instead — it's becouse all the “sides” values are abbreviated to just one letter: left, right, top, so bottom goes by this path.

However, if you feel that some abbreviation just need to be not that is expands to, feel free to fill up an issue.

Smart CSS values abbreviations

Here comes the second basic thing of Hayaku, the awesome one. You can expand abbreviations for the property+value parts, but you don't need to use any delimiters in those abbreviations! That's right — you can just write something like por and get position: relative!

This works also fuzzy, so to get position: relative you could use any number of letters: pore, posrel, pstnrltv etc. Also, if you want, you can still use a delimiter — just add a colon between the property and value and get the same result. So, if you want to stick to Zen style, use it — pos:r would work as intended. And p:r would work too — while pr would expand to padding-right, adding delimiter could help by removing ambiguity — padding can't have any values containing r, so hayaku falls to position.

Numeric values in abbreviations

Hayaku understands a lot of ways of writing numeric abbreviations.

Color values in abbreviations

Actually, you can not only expand strings and numbers, you can expand even colors using abbreviations! You can use different ways to achieve that (as anything in Hayaku), so just look at those examples:

And, of course, this works everywhere you would expect colors to work, so brc0 would expand to border-right-color: #000;

RGBA values

There is also a way to expand rgba values for colors — you can either use rgba's alpha after the dot, either use hexadecimal alpha after the full color, if you'd like. This would look like this:

You can also write just the dot and get the placeholder on the alpha part of the rgba:

Importance modifier

A nice little feature: add ! after abbreviation and get !important at the end. Not that importance is something you would want to use everyday, but still.

dn! would give you display:none !important;, yeah.

Automatic vendor prefixes

If you need some vendor prefixes, Hayaku could provide them!

bra1.5 would expand to this:

-webkit-border-radius: 1.5em;
        border-radius: 1.5em;

Right now there are no prefixes for values (like gradients etc.) but someday they'd be there.

Default values

If you'd write something that is only a property (as Hayaku would guess), Hayaku would insert a snippet with some default value already selected for you, so you could start writing your own value to replace it or to press tab again to keep it and move forward. So, writing w would actually expand to width: [100%] (braces mean that this value is selected by default).

Clipboard defaults

Aside from the normal defaults, Hayaku would try to use your clipboard for getting the value from it as the default value.

Right now it's available for colors and images urls:

Configure clipboard defaults

Hayaku offers a setting to set up the behavior of the Clipboard defaults: hayaku_CSS_clipboard_defaults. It is an array of the value types that Hayaku could accept as the defaults. So, to disable all the clipboard defaults you could use this setting:

{
    "hayaku_CSS_clipboard_defaults": [""]
}

Postexpands

“Postexpands” is a nice Hayaku's feature, that allows you to expand only the property at first and then use instant autocomplete for the values of numbers.

That must be said is that postexpand is a bit different from the usual abbreviation expands — it don't have any fuzzy search inside, so only the first letters matter. However, as you'd use it you would see that it is still a powerfull feature.

Simple property postexpands

The simplest postexpand feature is autocomplete for the string values of different properties.

If you'd expand some property like po to position: |;, then you could start writing any of it's values and get they expanded right after the cursor. So, writing a would give you position: a|bsolute;.

Postexpands for units

Another postexpand feature would allow you to firstly expand the property that can have numeric values, like width and then write only the digits and let Hayaku place the corresponding units automatically.

So, when you expand, for example, w to width: |;, you'd get different options:

Negative numbers could still be used and if you'd like any other unit, you could just write it down, the autocompleted units won't bother you.

Postexpands for colors

As you can use shortcuts to colors in abbreviations, you could also write the color values after expanding only the property. The basics are the same: color: |; + F would give you color: #F|FF;, and so on. You can use or don't use the hash symbol.

Another somewhat obscure (but helpful) feature is postexpand for rgba colors. This is triggered by writing the comma after decimal value. There is also a shortcut to the alpha value.

There are a lot of things we could improve there, so stay tuned.

Postexpand for importance

If you'd like to make some value important, you could just write the first symbols of !important keyword and Hayaku would autocomplete it for you.

Disabling postexpands

If you'd wish to disable postexpands at all for some reason, you could use this setting for this: "hayaku_CSS_disable_postexpand": true

Creating new CSS rule blocks

In Hayaku there is a simple but powerful feature: when you wrote a selector, you could just press CMD+Enter to get a block for writing CSS here.

Inline comments

Another little helper: write // in CSS to have it expanded to /* | */ (where the pipe is a caret placement).

If you'd wish to disable inline comments, you could use this setting: "hayaku_CSS_disable_inline_comment": true

This feature is in development, we plan on adding a lot of things to make commenting fun.

Value cycling

Another big feature Hayaku provides — a powerful implementation of cycling values. You can use it to increment or decrement any numeric values (both in CSS and anywhere else) and to cycle through all the possible values for any given CSS property.

Supported value types

Basics

Unlike other similar implementations, Hayaku's cycling is much more powerful and polished:

We are trying to make this feature as polished as we can, so feel free to report on any, even most minor bugs in cycling and propose improvements!

Key bindings

The default command comes in three variants:

If you'd like to use all your own keybindings or Hayaku's keybindings are come in conflict with other installed packages, you can disable the default keybindings using this setting in User/Preferences.sublime-settings:

"hayaku_use_default_cycling_keymaps": false

Otherwise, if you'd like a more precise control over any action, you can redefine a key binding for this action in your User/*.sublime-keymap like this:

{
    "keys": ["alt+up"],
    "command": "hayaku_cycling_through_values",
    "args": {"modifier": 1}
},

The modifier is both the direction (for the cycling) and the amount (for numeric), so to cycle backwards CSS values and to reduce the numbers by 3, you can say there "args": {"modifier": -3}.

Settings and Preferences

Hayaku have a lot of different configurable options, both for your code style and for different features you'd wish to use.

User dictionaries

Hayaku don't have a preset list of snippets. It have a dictionary with properties, their values and other information Hayaku uses to make writing CSS a spectacular experience.

If you don't see a property you use, or a value for some property, or you'd like to change the defaults for anything, you could extend and override the built-in dictionary with anything you'd like.

That's where the three specific settings are coming into play from the box: hayaku_user_dict, hayaku_syntax_dict and hayaku_project_dict.

Those settings work in the same way, applying the provided dictionaries in the given order after the built-in one.

Why is there three settings — to let you make overrides in ST-way. Sublime Text have different scopes for preferences: User's, Syntax Specific and Project, when you declare any settings in the Preferences, all those settings are merged together. Although, each one specific setting is completely overriden by the setting with the same name in the next scope, so there is no simple way to merge things using one name. That's why Hayaku provides you with three settings: you can use hayaku_user_dict in your User/Preferences.sublime-settings, then add some other things using hayaku_syntax_dict in your Syntax Specific settings, like in user/Stylus.sublime-settings, and, finally, make overrides for your specific project in your *.sublime-project files.

The syntax of all three settings is the same, although don't forget, that for .sublime-project you need to place the settings into the "settings": {} key.

Syntax of user dictionaries

Hayaku uses json for defining dictionaries, you can see the build-in one as an example.

The dictionary is an array, consisting of property objects having this structure:

{
    "name": "position",
    "values": [ "static", "relative", "absolute", "fixed" ]
}

Where the name is the property's name and the values is the array of possible values.

This is the simplest example, however there could be more complex entries like this one:

{
    "name": "width, height, min-width, min-height",
    "values": [ "auto", "<dimension>" ],
    "default": "100%",
    "always_positive": true
}

There are four things to mention:

  1. You can specify more than one property in name, just divide them by comma and optional spaces.

  2. There are some special entities that can go into values, like <dimension>, this means that if there is a “property” entry with this name, it would be expanded to it. Think of it as of links.

  3. There is a possible default key that contains the value that would be inserted in the result if there were no values given.

  4. There is a always_positive key that tells Hayaku that this property accepts only positive numbers, so the Cycling feature won't reduce it below zero.

There are other possible values, you can read the build-in dictionary and see which ones (in future we would explain all of them in the docs, of course).

User dictionary overrides

Except for the things mentioned above, there are some things you can use that are absent in the built-in dictinary.

The first one is an ability to remove values from the dictionary, just use remove_values key with the array of the values you'd like to remove from the given property.

For example, this User dictionary would remove static from position:

{
    "hayaku_user_dict": [
        {
            "name": "position",
            "remove_values": ["static"]
        }
    ]
}

The second thing is that you can control where the new values would go. By default they would be placed before all the built-in ones, but if you'll need to change this, you could define where all the non-defined values of built-in dictionary should go. This is done using "..." token in values array. An example:

{
    "hayaku_user_dict": [
        {
            "name": "position",
            "values": ["static", "..." ,"sticky"]
        }
    ]
}

Such dictionary would make the static value to go first, then all other built-in values would be placed and the sticky value would be the last one.

User aliases

In some cases you would want some abbreviation to point to a different property, for example you would want z to point at z-index and not to zoom. For this purpose there are settings similar to the dictionary ones: hayaku_user_aliases, hayaku_syntax_aliases and hayaku_project_aliases:

{
    "hayaku_user_aliases": {
        "z": "z-index"
    }
}

would do the work for you.

You can alias both only properties (and it would work for complex abbreviations, so z9 would be z-index: 9 with an above abbreviation), and for property-value parts, so you can create an abbreviation like this:

{
    "hayaku_user_aliases": {
        "fv": "font: 11px/1.5 Verdana, sans-serif"
    }
}

And then tabbing after fv would give you the desired output.

However, you can also use a user dictionary for this:

{
    "hayaku_user_dict": {
        "CSS": [
            {
                "name": "font",
                "values": [
                    "11px/1.5 Verdana, sans-serif"
                ]
            }
        ]
    }
}

And then you could write fver, fonve, f:v or any other abbreviations that Hayaku would expand to the desired output.

Using both dictionary and alias

The difference between creating an alias and defining a new value in a User Dict is that alias works like a static snippet (with an addition to possible values), but a new value in a Dict would be treated along other values and properties, Hayaku would still use its alrorithm and would select font-variant for fv instead of the font: 11px/1.5 Verdana, sans-serif.

However, one of the nice things in aliases is that they're aliases not to some static strings, but to Hayaku abbreviations. This way you can add this to your User settings:

{
    "hayaku_user_aliases": {
        "fv": "font:verdana"
    },
    "hayaku_user_dict": {
        "CSS": [
            {
                "name": "font",
                "values": [
                    "11px/1.5 Verdana, sans-serif"
                ]
            }
        ]
    }
}

And then you would have both abbreviations like fove to work, and fv would be aliased to the abbreviation that also would work like intended! This is also means reuse, so if you'd like to change that one value, you'll need to change it only in one place.

Extra scopes for dictionaries and aliases

In a case you would need more than three scopes, you can add more using a hayaku_extra_scopes option that accepts an array of extra scopes.

For example, "hayaku_extra_scopes": ['ololo'], would allow you to define extra hayaku_ololo_dict and hayaku_ololo_aliases which would be merged after the user, syntax and project in the given order.

Autoguessing the code style

The easiest way to set the basic settings for your codestyle, is to use hayaku_CSS_syntax_autoguess option:

{
    "hayaku_CSS_syntax_autoguess": [
        "    selector {              ",
        "        property: value;    ",
        "        }                   "
    ]
}

There you can use any whitespaces between the predefined keywords and they would be used by Hayaku. A few notes regarding this setting:

Maybe someday there'd be a real autoguessing, that would read your open stylesheet and find what better suits it, but not today.

Single code style

If you don't want to use autoguessing, then you could define single options one by one. This would also be helpful if you'd want to redefine only some of the code styling settings in other project or syntax.

Here is a JSON with all the available single code styling options:

{
    "hayaku_CSS_whitespace_after_colon":        " ",
    "hayaku_CSS_whitespace_block_start_before": " ",
    "hayaku_CSS_whitespace_block_start_after":  "\n\t",
    "hayaku_CSS_whitespace_block_end_before":   "\n\t",
    "hayaku_CSS_whitespace_block_end_after":    ""
}

The names speak for themselves there.

The important thing is that the single code style settings always override the autoguessed one.

Automatic new line after expand

That's somewhat experimental feature, that is disabled by default. To enable it use this setting:

{
    "hayaku_CSS_newline_after_expand": true
}

With this setting you could save a bit more time, cause Hayaku would add a new line after you expand your abbreviations. The only downside is that you'll need to delete a line when you finish with the selector or when you're inserting something between existing lines.

Quotes and URLs

By default Hayaku uses double quotes for different CSS stuff (like content: ""). You can change this by setting this:

{
    "hayaku_CSS_syntax_quote_symbol": "'"
}

Also, by default the image urls wouldn't have quotes in CSS-like syntaxes and would have them in Sass or Stylus, you can override this automatic behaviour by setting hayaku_CSS_syntax_url_quotes setting to true or false.

Units for unitless values

By default Hayaku won't add em or px after values for properties like line-height. If you're not using unit less values for those properties, you could enable them like this:

{
    "hayaku_CSS_units_for_unitless_numbers": true
}

Prefixes options

If you don't want to use any prefixes at all (as if you're using some mixins for it in Stylus, or use prefix-free), you can disable them with that option:

{
    "hayaku_CSS_prefixes_disable": true
}

The aligning for the prefixes

By default Hayaku aligns expanded prefixed properties in this nice way:

.foo {
    -webkit-transform: rotate(45deg);
       -moz-transform: rotate(45deg);
        -ms-transform: rotate(45deg);
         -o-transform: rotate(45deg);
            transform: rotate(45deg);
    }

This way it's easier to spot changes to a single prefixed property and to use multiline edit on them.

However, if you'd want to expand such properties left aligned, set

{
    "hayaku_CSS_prefixes_align": false
}

Using only specific prefixes

This is not something that you would use often, but if you'd need, you could use only prefixes for browsers you want. There are two settings for this:

{
    "hayaku_CSS_prefixes_only": ["webkit","moz","o"],
    "hayaku_CSS_prefixes_no_unprefixed": true
}

Right now there is no easy way to adjust prefixes per property, but it would be there in a near feature, so stay tuned!

Options for colors

Note that those settings would work for every pre-set and expanded colors, like the default color values, but they won't work for postexpands due to their mechanics.

Colors' case

You can tell Hayaku if you prefer lowercase or uppercase for color values, so it would change the case while expanding abbreviations like c#f, cF etc.

The default value is uppercase, so c#f would become color: #FFF. If you'd like to change that to lowercase, you can set it this way:

{
    "hayaku_CSS_colors_case": "lowercase"
}

And if you'd like it to leave the color as is, you could use value initial.

Shorthand colors

By default Hayaku shortens the colous, so if there could be #FFFFFF expanded, Hayaku would make it #FFF.

However, if you wish, you can redefine this behavior using this setting:

{
    "hayaku_CSS_colors_length": "long"
}

That would make cF to be expanded into color: #FFFFFF.

Using Hayaku with CSS Preprocessors

“Hey! I don't need to write CSS faster — I use Preprocessors!” you could say. But, well, you would still need to write all those extra symbols, so abbreviations would fit preprocessors well. And as Hayaku is highly customizable, you could use it with any preprocessor: Sass, Less, Stylus etc.

Right now only basic things are available, but in the future you could expand different mixins and functions too, so just wait for it.

And this is just the start, there would be a lot of other nice features, so still tuned and follow the official bundle's twitter!

Acknowledgments

The initial idea of Hayaku for CSS came from the merged ideas of Vadim Makeev (Zen CSS) and Vitaly Harisov (CSS Snippets). Big thanks to them!

License and copyrights

This software is released under the terms of the MIT license.