saret/ChocolateyPackages
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Files
e9e46a9ff077a0cd191ca548a53bd9c222f37269
ChocolateyPackages/EthanBrown.SublimeText2.WebPackages/tools/PackageCache/Hayaku - tools for writing CSS faster/README.md
Iristyle 1e6f643a1b feat(SublimeText2.WebPackages): cache packages
2013-04-04 08:54:25 -04:00

405 lines
18 KiB
Markdown
Raw Blame History

# Hayaku <sup>[1.3.3](https://github.com/hayaku/hayaku/blob/master/CHANGELOG.md)</sup>
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](#install-hayaku-for-sublime-text)
2. [Features](#features)
- [Smart CSS Abbreviations](#smart-css-abbreviations)
- [Fuzzy CSS property abbreviations](#fuzzy-css-property-abbreviations)
- [Smart CSS values abbreviations](#smart-css-values-abbreviations)
- [Numeric values in abbreviations](#numeric-values-in-abbreviations)
- [Color values in abbreviations](#color-values-in-abbreviations) with [RGBA values](#rgba-values)
- [Importance modifier](#importance-modifier)
- [Default values](#Default-values)
- [Clipboard defaults](#clipoard-defaults)
- [Postexpands](#postexpands)
- [Simple property postexpands](#simple-property-postexpands)
- [Postexpands for units](#postexpands-for-units)
- [Postexpands for colors](#postexpands-for-colors)
- [Postexpand for importance](#postexpand-for-importance)
- [Creating new CSS rule blocks](#creating-new-css-rule-blocks)
- [Inline comments](#inline-comments)
<br/><br/>
3. [Settings and Preferences](#settings-and-preferences)
- [Autoguessing the code style](#autoguessing-the-code-style)
- [Single code style](#single-code-style)
- [Automatic new line after expand](#automatic-new-line-after-expand)
- [Quotes and URLs](#quotes-and-urls)
- [Units for unitless values](#units-for-unitless-values)
- [Prefixes options](#prefixes-options)
- [The aligning for the prefixes](#the-aligning-for-the-prefixes)
- [Using only specific prefixes](#using-only-specific-prefixes)
- [Options for colors](#options-for-colors)
- [Colors' case](#colors-case)
- [Shorthand colors](#shorthand-colors)
<br/><br/>
4. [Using Hayaku with CSS Preprocessors](#using-hayaku-with-css-preprocessors)
5. [License and copyrights](#license-and-copyrights)
# Install Hayaku for [Sublime Text](http://www.sublimetext.com/2)
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](http://wbond.net/sublime_packages/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)
``` sh
git clone git://github.com/hayaku/hayaku.git
```
And then restart Sublime Text.
# 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: **l**eft, **r**eft, **t**op, so **b**ottom 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](https://github.com/hayaku/hayaku/issues/new).
### 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.
- You can just write a number after abbreviation to treat it as a value: `w10` would expand to `width: 10px` (see? automatic pixels!).
- Negative numbers supported too: `ml-10` would expand to `margin-left: -10px`.
- If you'd write a dot somewhere in abbreviation, Hayaku would guess what you need `em`s, so `w10.5` would expand to `width: 10.5em`.
- There are some abbreviations for some units, like `percents` for `%`, or `.` for em, so `100p` would expand to `100%` and `10.` to `10em`.
- All other units are supported, `h2pt` would expand to `height:2pt` and so on. Fuzzy guess is there too: if you'd want `vh` you could write just `w10h` and get `width: 10vh`.
### 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:
- `c0` → `color: #000`
- `cF` → `color: #FFF` (use uppercase to tell Hayaku it's a color)
- `cFA` → `color: #FAFAFA`
- `c#fa` → `color: #FAFAFA` (no need in uppercase if you use `#`)
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:
- `c0.5` → `color: rgba(0,0,0,.5)`
- `cF.2` → `color: rgba(255,255,255,.2)`
- `cABCD` → `color: rgba(170,187,204,0.87)`
- `cABC80` → `color: rgba(170,187,204,0.5)`
You can also write just the dot and get the placeholder on the `alpha` part of the `rgba`:
- `cF00.` → `color: rgba(255,0,0,.[5])`
### 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:
``` CSS
-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:
- If you'd have color in hexadecimal, rgb(a) or hsl(a) in your clipboard, Hayaku would use it as a default shown value. That would work even is the value is hashless, so if you've copied `808080` from anywhere, then on expanding `c` you would get `color: #[808080]`.
- If you'd have an image url in your clipboard (even relative, Hayaku would look at extension), you'd have it added as default values along inside an `url()`. Also, see [quotes and URLs](#quotes-and-urls) settings on how to adjust the quoting of the inserted url if you want.
#### 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:
``` JSON
{
"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:
- write any iteger like `10` and you'd get `width: 10|px;`
- write any float like `1.5` and you'd get `width: 1.5|em;`
- write an integer and them `e`, so you'd get `width: 10e|m;`
- if the value have any string values, you can also use them: writing `a` would give you `width: a|uto;`
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.
- `color: 255,|` would transform to `color: rgba(255,|255,255,1);`
- `color: 255,.|` would transform to `color: rgba(255,255,255,.|5);`
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.*
# 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.
## Autoguessing the code style
The easiest way to set the basic settings for your codestyle, is to use `hayaku_CSS_syntax_autoguess` option:
``` JSON
{
"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:
- You should use the newline symbol `\n` or multiple array items, because JSON don't support multiline well.
- For your convenience you can use any leading of trailing spaces. Trailing spaces would be stripped at all, leading spaces would be stripped as if there weren't spaces at the start of the selector.
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:
``` JSON
{
"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:
``` JSON
{
"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:
``` JSON
{
"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:
``` JSON
{
"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:
``` JSON
{
"hayaku_CSS_prefixes_disable": true
}
```
### The aligning for the prefixes
By default Hayaku aligns expanded prefixed properties in this nice way:
``` CSS
.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
``` JSON
{
"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 settigns for this:
``` JSON
{
"hayaku_CSS_prefixes_only": ["webkit","moz","o"],
"hayaku_CSS_prefixes_no_unprefixed": true
}
```
- `hayaku_CSS_prefixes_only` is an array of the prefixes you'd want to use **only**. In the upper example I excuded `ms` prefix, so if you'd use meta to emulate all IE versions to IE7 for example, then you could remove `ms` prefix, so your CSS would be a bit cleaner.
- when `hayaku_CSS_prefixes_no_unprefixed` is set to `True`, such prefixed clusters won't contain the official unprefixed variant.
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:
``` JSON
{
"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:
``` JSON
{
"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 feature 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](http://twitter.com/#!/hayakubundle)!
# License and copyrights
This software is released under the terms of the [MIT license](https://github.com/hayaku/hayaku/blob/master/LICENSE).
Reference in New Issue View Git Blame Copy Permalink