Skip to content

Commit

Permalink
prepare for 0.7.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jcberquist committed Mar 16, 2016
1 parent 28054a3 commit 6822c88
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 1 deletion.
3 changes: 2 additions & 1 deletion messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
"0.4.2": "messages/0.4.2.txt",
"0.5.0": "messages/0.5.0.txt",
"0.5.1": "messages/0.5.1.txt",
"0.6.0": "messages/0.6.0.txt"
"0.6.0": "messages/0.6.0.txt",
"0.7.0": "messages/0.7.0.txt"
}
26 changes: 26 additions & 0 deletions messages/0.7.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
CFML v0.7.0 Changelog:

- adds basic support for custom tags as used with a cfimport tag and a custom tag prefix

The completions are offered on a per project basis. To set them up add a "custom_tag_folders"
setting to your `.sublime-project` file. It should be an array of JSON objects where each object
has two required keys: "path" and "prefix". "path" should be a full file path to a folder
containing custom tags, and "prefix" should be the prefix you intend to import them with.

For example:

"custom_tag_folders": [
{"path": "/path/to/tag/folder", "prefix": "page"}
]

Once this is done, "page" will be offered as a custom tag prefix completion, and then after
entering `<page:` a list of tags in the custom tag folder will be offered. After a tag has been
entered, completions for every `attributes` scope variable found in that custom tag file will
be offered.

F1 used on an indexed custom tag will give some minimal documentation about that tag, and CTRL-ALT-Click
can be used to jump to the custom tag file.

The indexer searches for `thistag.executionmode is/eq/== "end"/'end'` (case insensitive) or
`<cfcase value="end"/'end'>` (case insensitive) in custom tag files in order to determine whether or not
to auto close the custom tag.
23 changes: 23 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Special thanks to [@foundeo](https://github.com/foundeo) and [cfdocs.org](http:/
- [A Note about Settings](#a-note-about-settings)
- [Default Key Bindings](#default-key-bindings)
- [CFC Indexing and Dot Paths](#cfc-indexing-and-dot-paths)
- [Custom Tags](#custom-tags)
- [Custom Coloring for CFML Tags](#custom-coloring-for-cfml-tags)
- [Controller/View Toggle](#controllerview-toggle)
- [CommandBox](#commandbox)
Expand Down Expand Up @@ -123,6 +124,28 @@ By default, implicit accessors are included in the completions.The `accessors` k

These two settings work together, such that when a base CFC as well as another CFC that extends it are both indexed, and a mapping is specified such that the dot path in the `extends` can be resolved, the documentation and completions for the child CFC will include properties and methods from the base CFC. In addition, the dot paths of all indexed CFCs will be offered as completions in the `extends` attribute, the `createObject` function (where the type is `component`), as well as when using `new` to instantiate a CFC.

### Custom Tags

Support is offered on a per project basis for custom tags as used with a `<cfimport>` tag and a custom tag prefix. Here is an example project file (other settings have been removed):

```
{
"custom_tag_folders":
[
{
"path": "C:/myprojects/projectname/customtags/page",
"prefix": "page"
}
]
}
```

Once this is done, `page` will be offered as a custom tag prefix completion, and then after entering `<page:` a list of tags in the custom tag folder will be offered. After a tag has been entered, completions for every `attributes` scope variable found in that custom tag file will be offered.

You can use the <kbd>F1</kbd> documentation command to get some minimal documentation about that custom tag, and <kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Left Click</kbd> can be used to jump to the custom tag file.

The indexer will search for `thistag.executionmode is/eq/== "end"/'end'` (case insensitive) or `<cfcase value="end"/'end'>` (case insensitive) in custom tag files in order to determine whether or not to auto close the custom tag.

### Custom Coloring for CFML Tags

Unless you are using a specialized color scheme, CFML and HTML tags will receive the same coloring. This can make it a bit harder to distinguish between the two types of tags when embedding CFML tags in HTML. This package has a command you can run from the command palette that will inject custom colors for CFML tags into your current color scheme (or remove them if they are already there). Press <kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd> to bring up the command palette (<kbd>CMD</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd> on a Mac) and run `CFML: Toggle Color Scheme Styles`. You can edit the styles that will be injected via the user settings for this package.
Expand Down

0 comments on commit 6822c88

Please sign in to comment.