You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@weex.apache.org by mi...@apache.org on 2017/08/21 04:25:40 UTC
[1/2] incubator-weex git commit: * [doc] add doc of idea plugin
Repository: incubator-weex
Updated Branches:
refs/heads/dev a52c861e1 -> f76aa0690
* [doc] add doc of idea plugin
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex/commit/6e36b074
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex/tree/6e36b074
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex/diff/6e36b074
Branch: refs/heads/dev
Commit: 6e36b0749f667c02107037ebde407d278ec6ac83
Parents: 9db8054
Author: misakuo <mi...@apache.org>
Authored: Mon Aug 21 12:22:04 2017 +0800
Committer: misakuo <mi...@apache.org>
Committed: Mon Aug 21 12:22:04 2017 +0800
----------------------------------------------------------------------
doc/source/cn/guide/tools/index.md | 1 +
doc/source/cn/guide/tools/plugin.md | 70 ++++++++++++++++++++++++
doc/source/guide/tools/index.md | 1 +
doc/source/guide/tools/plugin.md | 61 +++++++++++++++++++++
doc/themes/weex/layout/_partial/sidebar.ejs | 3 +
5 files changed, 136 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/6e36b074/doc/source/cn/guide/tools/index.md
----------------------------------------------------------------------
diff --git a/doc/source/cn/guide/tools/index.md b/doc/source/cn/guide/tools/index.md
index cd2c226..6dacd4c 100644
--- a/doc/source/cn/guide/tools/index.md
+++ b/doc/source/cn/guide/tools/index.md
@@ -8,3 +8,4 @@ version: 2.1
# 周边工具
- [weex-toolkit](./toolkit.html)
+- [Weex Language Support插件](./plugin.md)
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/6e36b074/doc/source/cn/guide/tools/plugin.md
----------------------------------------------------------------------
diff --git a/doc/source/cn/guide/tools/plugin.md b/doc/source/cn/guide/tools/plugin.md
new file mode 100644
index 0000000..467b890
--- /dev/null
+++ b/doc/source/cn/guide/tools/plugin.md
@@ -0,0 +1,70 @@
+# Weex语法支持插件
+
+[Weex Language Support](https://plugins.jetbrains.com/plugin/9189-weex-language-support) 插件是官方提供的一个工具，你可以使用它在IntelliJ IDEA，WebStorm等一系列IDE上对Weex DSL进行语法高亮，自动补全和错误检查等操作。
+
+### 支持的IDE
+你可以在任何操作系统上的下列IDE上安装和使用Weex Language Support插件：
+**IntelliJ IDEA Ultimate, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, Gogland, Rider**
+
+### 安装
+在IDE的插件仓库中搜索`Weex Language Support`来安装该插件，安装完毕后重启IDE即可激活插件相关功能
+
+
+### 配置
+打开`Preferences -> Other Settings -> Weex language support`可配置插件的相关功能
+
+- Target Weex Version: 配置插件以哪一个版本的语法规则来对DSL进行提示及检查，默认值`LATEST`表示总是应用最行新版本weex的语法规则
+- Vue Support: 配置插件是否支持Weex 2.0版本的DSL(.vue文件)，开启后重启生效（注意：如果IDE内有其他支持Vue语法的插件，则需要关闭相应的插件后Weex插件才能生效）
+- Custom Rules: 引入自定义的Weex DSL规则，如果你在native中定义了自己的Module或Component，可通过自定义规则引入插件中来提供相应的提示和补全支持，自定义规则的格式将在后文列出
+- Global Weex Components: 默认地，插件会解析当前工程及npm root路径下的`node_modules`目录，解析其中包含的Weex Components并对其提供补全支持。如果你的项目中引用了这两个路径以外的Components，可以在此处将其添加到搜索路径中，插件将会将其中的Components载入，并在编写DSL时为相应的标签提供补全支持
+
+### 自定义规则格式
+自定义规则包含在一个json文件中，json文件的根节点为数组类型，数组中的每一个元素对应DSL中的一个标签。
+我们以`<loading>`标签的规则来举例：
+```js
+{
+ "tag": "loading", //标签名，不可为空
+ "attrs": [ //标签属性列表，可为空
+ {
+ "name": "display", //属性名，不可为空
+ "valuePattern": null, //属性值的正则表达式，用于检测值是否合法，可为空
+ "valueEnum": [ //属性值枚举，可为空
+ "show",
+ "hide"
+ ],
+ "valueType": "var", //属性值类型，必须是var或function，决定该从数据列表还是函数列表中查找属性值补全的候选值，不可为空
+ "since": 0, //该属性何时被添加到sdk中，例如0.11，默认为0
+ "weexOnly": false //该属性是否仅在1.0语法中可用，默认为false
+ }
+ ],
+ "events": [ //事件列表。可为空
+ {
+ "name": "loading", //事件名称，不可为空
+ "since": 0 //该事件何时被添加到sdk中
+ }
+ ],
+ "parents": [ //该标签允许被作为哪些标签的子元素，空表示可以作为任意元素的子元素
+ "list",
+ "scroller"
+ ],
+ "childes": [ //该标签允许哪些元素作为自己的子元素，空表示任意元素都可作为子元素
+ "text",
+ "image",
+ "loading-indicator"
+ ],
+ "document": "/references/components/loading.html" //文档地址，配置该属性之后可在编辑界面中对应的标签上直接打开文档
+ }
+```
+
+### 使用
+插件的绝大部分功能被集成到编辑器上下文中，会随用户输入在需要补全，提示或Lint时被触发，无需特殊干预。下列功能需要用户手动触发：
+#### 文档搜索
+打开IDE右侧工具栏的`Weex Documents`即可对文档进行搜索，搜索结果与官网保持同步，勾选 `EN` 可切换搜索结果为英文内容
+
+
+#### 打开标签对应的文档
+将光标定位到标签上，并通过`Show Intention Actions`操作（OSX上默认键为 option + enter，可通过Keymap查看）打开Intenion菜单，选择`Open Document`可打开标签对应的文档
+
+
+### 参与插件建设
+请将Issues及Pull Requests提交到[weex-language-support](https://github.com/misakuo/weex-language-support)项目中
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/6e36b074/doc/source/guide/tools/index.md
----------------------------------------------------------------------
diff --git a/doc/source/guide/tools/index.md b/doc/source/guide/tools/index.md
index 83ce4dc..74f8373 100644
--- a/doc/source/guide/tools/index.md
+++ b/doc/source/guide/tools/index.md
@@ -8,3 +8,4 @@ version: 2.1
# Tools
- [weex-toolkit](./toolkit.html)
+- [IDEA / WebStorm Plugin](./plugin.md)
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/6e36b074/doc/source/guide/tools/plugin.md
----------------------------------------------------------------------
diff --git a/doc/source/guide/tools/plugin.md b/doc/source/guide/tools/plugin.md
new file mode 100644
index 0000000..8ca1731
--- /dev/null
+++ b/doc/source/guide/tools/plugin.md
@@ -0,0 +1,61 @@
+# Weex Language Support Plugin
+
+[Weex Language Support](https://plugins.jetbrains.com/plugin/9189-weex-language-support) is a official tools to code highlight, automatic completion，lint and other functions in IDEA, WebStorm or the others IDEs.
+
+### Supported IDEs
+You can install and use this plugin on the following IDEs on any operating system:
+**IntelliJ IDEA Ultimate, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, Gogland, Rider**
+
+### Install
+Just searching the `Weex Language Support` in plugin repo to install, next you need restart IDE to enable it.
+
+
+### Configurations
+Open `Preferences -> Other Settings -> Weex language support` to configuration plugin
+
+- Target Weex Version: Config the version of Weex that your current project in use, default is `LATEST`, it means always using the latest version
+- Vue Support: Config whether to support Vue, you need to restart IDE after turning on or off the set to take effect
+- Custom Rules: Import the custom Weex DSL rules, The format of the custom rules will be listed later
+- Global Weex Components: Sets the location of the module that is applied in the project, in particular, the `node_modules` directory in current project and npm root will be automatically included, you do not need to add them here
+
+
+### Format of Custom DSL Rules
+Custom rules are included in a json file, the root node of the json file is an array, each element in the array corresponds to a label in the DSL.
+Let's take the example of the `loading>` tag:
+```js
+{
+ "tag": "loading", //tag name, not null
+ "attrs": [ //attributes of tag, can be null
+ {
+ "name": "display", //attribute name, not null
+ "valuePattern": null, //pattern expression to check the attribute value, can be null
+ "valueEnum": [ //attribute value enumeration, can be null
+ "show",
+ "hide"
+ ],
+ "valueType": "var", //type of attribute value, must be var or function
+ "since": 0, //which version the attribute is added to sdk, such as 0.11
+ "weexOnly": false //whether the attribute is available only in 1.0 syntax, default is false
+ }
+ ],
+ "events": [ //events list, can be null
+ {
+ "name": "loading", //event name, not null
+ "since": 0 //which version the event is added to sdk
+ }
+ ],
+ "parents": [ //The tag is allowed to be a child of which tags, null means no restrictions
+ "list",
+ "scroller"
+ ],
+ "childes": [ //which tags are allowed as their own child tags, null means no restrictions
+ "text",
+ "image",
+ "loading-indicator"
+ ],
+ "document": "/references/components/loading.html" //document link
+ }
+```
+
+### Contribution
+Please commiting Issues and Pull Requests into the [weex-language-support](https://github.com/misakuo/weex-language-support) project
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-weex/blob/6e36b074/doc/themes/weex/layout/_partial/sidebar.ejs
----------------------------------------------------------------------
diff --git a/doc/themes/weex/layout/_partial/sidebar.ejs b/doc/themes/weex/layout/_partial/sidebar.ejs
index 3074b4a..9a9e2cf 100644
--- a/doc/themes/weex/layout/_partial/sidebar.ejs
+++ b/doc/themes/weex/layout/_partial/sidebar.ejs
@@ -41,6 +41,9 @@
<li>
<a href="https://market.dotwe.org" target="_blank">Market</a>
</li>
+ <li>
+ <a href="<%= url_for_lang('guide/tools/plugin.html') %>">Weex WebStorm Plugin</a>
+ </li>
</ul>
</li>
<li>
[2/2] incubator-weex git commit: Merge remote-tracking branch
'upstream/pr623' into apache-dev
Posted by mi...@apache.org.
Merge remote-tracking branch 'upstream/pr623' into apache-dev
Project: http://git-wip-us.apache.org/repos/asf/incubator-weex/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-weex/commit/f76aa069
Tree: http://git-wip-us.apache.org/repos/asf/incubator-weex/tree/f76aa069
Diff: http://git-wip-us.apache.org/repos/asf/incubator-weex/diff/f76aa069
Branch: refs/heads/dev
Commit: f76aa0690cfb7624a84445151e0370fd9de2308e
Parents: a52c861 6e36b07
Author: misakuo <mi...@apache.org>
Authored: Mon Aug 21 12:25:58 2017 +0800
Committer: misakuo <mi...@apache.org>
Committed: Mon Aug 21 12:25:58 2017 +0800
----------------------------------------------------------------------
doc/source/cn/guide/tools/index.md | 1 +
doc/source/cn/guide/tools/plugin.md | 70 ++++++++++++++++++++++++
doc/source/guide/tools/index.md | 1 +
doc/source/guide/tools/plugin.md | 61 +++++++++++++++++++++
doc/themes/weex/layout/_partial/sidebar.ejs | 3 +
5 files changed, 136 insertions(+)
----------------------------------------------------------------------