Sencha Cmd 入门

Sencha Cmd 是一个跨平台命令行工具，它为您的应用程序的完整生命周期提供了许多自动化任务，从生成新项目到将应用程序部署到生产环境。

Sencha Cmd 简介

Sencha Cmd 提供了一系列强大的、节省时间的功能，这些功能协同工作，并与 Sencha Ext JS 和 Sencha Touch 框架结合使用。Sencha Cmd 提供以下功能

• 代码生成工具： 代码生成工具，用于生成整个应用程序，并使用新的 MVC 组件扩展这些应用程序。
• JS 编译器： 一个框架感知的 JavaScript 编译器，它了解 Sencha 框架的语义，并且可以从您的源代码生成最小占用空间的构建。编译器可以优化 Sencha 框架提供的许多高级语义，以减少应用程序的加载时间。
• Web 服务器： 提供一个轻量级 Web 服务器，用于从 localhost 提供文件。
• 包管理系统：分布式包管理系统，用于轻松集成由他人或来自 Sencha 包存储库创建的包（例如 Ext JS 主题）。
• 工作区管理： 协助跨多个应用程序共享框架、包和自定义代码。
• 构建脚本： 为应用程序和包生成的构建脚本，带有“before”和“after”扩展点，因此您可以自定义构建过程以适应您的特定需求。
• Cordova / PhoneGap 集成： 本地打包，用于将 Web 应用程序转换为一流的移动应用程序，该应用程序可以访问设备功能并可以在应用商店中分发。
• 图像捕获： 将 CSS3 功能（例如 border-radius 和 linear-gradient）转换为旧版浏览器的精灵图。
• 调整工具： 强大的代码选择工具，用于调整应用程序最终构建中包含的内容，确定跨页面的通用代码，并使用高级集合操作对共享代码进行分区，以获得完全符合您要求的构建。
• 灵活的配置系统： 允许在应用程序或工作区级别或跨机器上的所有工作区为命令选项指定默认值。
• 日志记录：强大的日志记录，可帮助您了解命令的内部工作原理并促进故障排除。
• 第三方软件： 对于 Ext JS 5 及更早版本，Sencha Cmd 包括 Compass 和 Sass 的兼容版本。
• 代码生成挂钩： 可以特定于一个页面或由工作区中的所有页面共享，例如，在生成新模型时检查编码约定或指南）。

兼容性

Sencha Cmd 支持 Sencha Ext JS 4.1.1a 或更高版本，版本 2.1 或更高版本。Sencha Cmd 的许多功能需要框架支持，这些支持仅在这些或更高版本级别上可用。一些低级命令可以用于旧版本的 Sencha 框架或通用 JavaScript。

如果您使用的是旧版本的 Ext JS，则可以使用 Sencha Cmd 的 build 命令通过 JSB 文件进行构建。换句话说，Sencha Cmd 可以替换 JSBuilder，以生成 JSB 文件中描述的文件的压缩构建。Sencha Cmd 不会像已弃用的 SDK Tools v2 那样更新您的 JSB 文件。

系统设置

Sencha Cmd 7 安装程序包含构建 Ext JS 7 应用程序所需的所有工具软件，因此只需为您的平台下载 Sencha Cmd 即可

• Sencha Cmd

注意：

Windows 32 位安装程序不再附带嵌入式 JRE。如果您使用的是 32 位版本的 Windows，则必须在您的系统上安装兼容版本的 Java（请参阅下文）。

依赖项

Java

• Sencha Command 6.6.0 及更高版本直到 7.7.0 需要 Oracle JRE (SE) 8-11 或 OpenJDK 8-11。

• Sencha Command 7.8.0 及更高版本 需要 Oracle JRE (SE) 8-21 或 OpenJDK 8-21。

  Node

• Sencha Command 需要 Node JS 8+ 版本和 npm 5+ 版本 来支持 Fashion node 模块等。

使用旧框架

如果您使用的是旧版本的 Ext JS 或 Sencha Touch，您将需要在安装程序中选中“Compass extension”选项

您还需要安装 Ruby 以编译使用 Sass 的主题和应用程序。Ruby 因操作系统而异

• Windows：从 rubyinstaller.org 下载 Ruby。获取软件的 ".exe" 文件版本并安装它。
• Mac OS：Ruby 已预装。您可以使用 Ruby -v 命令测试是否安装了 Ruby。
• Ubuntu：使用 sudo apt-get install ruby2.0.0 下载 Ruby。

如果您将使用 Cordova 或 PhoneGap，您可能对这些工具还有其他要求。请参阅 与 Cordova 或 PhoneGap 集成。

安装程序会将条目添加到您的 PATH 环境变量。

验证安装

要验证 Sencha Cmd 是否正常工作，请打开命令行，将目录更改为您的应用程序，然后键入 sencha 命令。

您应该看到类似于这样的输出

Sencha Cmd v7.8.0
...

显示的确切版本号应与您刚刚安装的版本匹配。

静默安装 Sencha Cmd

一些用户可能希望在没有安装程序的 GUI 的情况下安装 Sencha Cmd。如果您需要仅 CLI 的安装过程，只需从您的命令行工具运行以下命令即可

Mac OSX

SenchaCmd-7.x.y.z-osx.app/Contents/MacOS/JavaApplicationStub -q

Linux

SenchaCmd-7.x.y.z-linux(-i386|-amd64).sh -q

Windows

SenchaCmd-7.x.y.z-windows-(32|64)bit.exe -q

这将安装没有 GUI 安装程序的 Sencha Cmd。

更改安装路径

如果您需要更改安装路径，可以使用“dir”标志指定它。例如

sudo SenchaCmd-7.x.y.z-linux(-i386|-amd64).sh -q -dir "/opt"

注意： 您选择的安装路径可能需要权限更改。

升级 Sencha Cmd

sencha upgrade 功能使您可以升级 Sencha Cmd。

检查 Sencha Cmd 的新更新

sencha upgrade --check

如果没有 --check 选项，如果您尚未安装最新版本，则 sencha upgrade 命令将下载并安装最新版本

sencha upgrade

安装程序完成后，启动新的控制台或终端以获取对 PATH 环境变量的更改。

由于可以并行安装多个版本的 Sencha Cmd，因此您可以安全地尝试新版本，只需卸载它们（或调整 PATH 或符号链接）即可返回到以前的版本。但是，使用 sencha app upgrade 升级您的应用程序更像是一个源代码控制项，如果您降级到旧版本的 Sencha Cmd，您可能需要“回滚”。

静默升级 Sencha Cmd

一些用户可能希望在没有安装程序的 GUI 的情况下升级 Sencha Cmd。如果您需要仅 CLI 的升级过程，只需从您的命令行工具运行以下命令即可

sencha upgrade --unattended

这将升级没有 GUI 安装程序的 Sencha Cmd。

Beta 版本

如果您想检查 Beta 版本，请使用

sencha upgrade --check --beta

要安装最新的 Beta 版本

sencha upgrade --beta

注意： 最新的发行版可能位于“beta”或稳定通道中。也就是说，sencha upgrade --beta 可能会安装一个早于当前发行版的 Beta 版本，而 sencha upgrade 将安装当前发行版。

命令基础

Sencha Cmd 功能以类别（或模块）和命令排列

sencha [category] [command] [options...] [arguments...]

可以使用 help 命令获得帮助。

sencha help [module] [action]

例如，尝试这个

sencha help

显示当前版本和可用的顶级命令。例如

Sencha Cmd v6.0.0.202
...

Options
  * --beta, -be - Enable beta package repositories
  * --cwd, -cw - Sets the directory from which commands should execute
  * --debug, -d - Sets log level to higher verbosity
  * --info, -i - Sets log level to default
  * --nologo, -n - Suppress the initial Sencha Cmd version display
  * --plain, -pl - enables plain logging output (no highlighting)
  * --quiet, -q - Sets log level to warnings and errors only
  * --sdk-path, -sd - The location of the SDK to use for non-app commands
  * --strict, -st - Treats warnings as errors, exiting with error if any warnings are present
  * --time, -ti - Display the execution time after executing all commands

Categories
  * app - Perform various application build processes
  * compile - Compile sources to produce concatenated output and metadata
  * cordova - Quick init Support for Cordova
  * diag - Perform diagnostic operations on Sencha Cmd
  * fs - Utility commands to work with files
  * generate - Generates models, controllers, etc. or an entire application
  * manager - Commands for interacting with Sencha Web Application Manager.
  * manifest - Extract class metadata
  * package - Manages local and remote packages
  * phonegap - Quick init support for PhoneGap
  * repository - Manage local repository and remote repository connections
  * template - Commands for working with templates
  * theme - Commands for low-level operations on themes
  * web - Manages a simple HTTP file server

Commands
  * ant - Invoke Ant with helpful properties back to Sencha Cmd
  * audit - Search from the current folder for Ext JS frameworks and report their license
  * build - Builds a project from a legacy JSB3 file.
  * config - Load a properties file or sets a configuration property
  * help - Displays help for commands
  * js - Executes arbitrary JavaScript file(s)
  * upgrade - Upgrades Sencha Cmd
  * which - Displays the path to the current version of Sencha Cmd

注意： 确切的内容将取决于您安装的版本。

详细输出

Sencha Cmd 5 中显著减少了调试输出的级别。您可以通过在命令中包含 -info 标志来重新启用详细输出。例如

 sencha -info app watch

此命令将提供有关初始化期间和文件系统更新时发生的后台进程的更多信息。

-info 标志可以与任何产生输出的 Sencha 命令一起使用。

当前目录

在许多情况下，Sencha Cmd 要求您设置特定的当前目录。或者它可能只需要知道有关相关 Sencha SDK 的详细信息。当从生成的应用程序文件夹或对于少数命令从提取的 SDK 文件夹运行时，Sencha Cmd 可以自动确定 SDK（或“框架”）。

重要提示 对于以下命令，Sencha Cmd 需要从生成的应用程序的根文件夹运行。如果未从应用程序的根文件夹运行，则命令将失败。

* `sencha generate ...` (for commands other than `app`, `package` and `workspace`)
* `sencha app ...`

对于包也是如此。当运行诸如 sencha package build 之类的命令时，当前目录必须是所需的包文件夹。

Sencha Cmd 文档

Sencha Cmd 的许多指南都经过组织，以帮助您建立理解，建议您遵循此顺序。跳跃前进可能会导致混淆，因为高级指南通常假设理解早期指南的内容。

在每个指南的开头都有指向该指南的任何先决条件的链接。此外，大多数指南都以一组链接结尾，供进一步阅读。

超出基础

还有许多其他与使用 Sencha Cmd 相关的细节可能很有帮助。help 命令是一个很好的参考，但是如果您想浏览所有重点，请查阅 高级 Sencha Cmd。

故障排除

以下是一些解决使用 Sencha Cmd 时遇到的常见问题的技巧。

Java 堆空间

如果在执行 Cmd 命令后收到“java heap space”错误，您可能需要增加 Java 的分配内存使用量。

Mac & Linux

将以下内容添加到 ~/.bash_profile

export _JAVA_OPTIONS="-Xms1024m -Xmx2048m"

Windows

您可以将变量添加为环境变量，也可以将以下内容添加到 startup.bat

set _JAVA_OPTIONS="-Xms1024m -Xmx2048m"

命令未找到

如果在 OSX/Linux 上运行 sencha 导致错误消息 sencha: command not found，或者在 Windows 上导致 'sencha' is not recognized as an internal or external command, operable program or batch file，请按照以下步骤操作

• 关闭终端/命令提示符窗口并打开一个新的窗口。
• 确保 Sencha Cmd 已正确安装
  • 安装目录存在。默认情况下，安装路径是
    • Windows: C:\Users\Me\bin\Sencha\Cmd\{version}
    • Mac OS X: ~/bin/Sencha/Cmd/{version}
    • Linux: ~/bin/Sencha/Cmd/{version}
  • Sencha Cmd 目录的路径已添加到您的 PATH 环境变量中。从终端，在 Windows 上运行 echo %PATH%，或在 Mac 或 Linux 上运行 echo $PATH。Sencha Cmd 目录应显示在输出的一部分中。如果不是这种情况，请手动将其添加到您的 PATH 中。

找不到 Ruby

如果您看到与无法识别或找到 "ruby" 相关的错误，这很可能是因为 Ruby 未安装或未添加到您的 PATH 环境变量中。请参阅之前的 系统设置 章节。

您不应该在使用 Ext JS 6 时看到此消息，因为 Ext JS 6 使用的是 Fashion 而不是 Compass，Fashion 不需要 Ruby。

当前目录错误

一个常见的错误是执行需要当前目录为已解压的 SDK 目录或应用程序目录的命令，但当前目录未设置为这些目录。 如果未满足此要求，Sencha Cmd 将显示错误并退出。

注意： 有效的应用程序目录是由 Sencha Cmd 生成的目录。

解析依赖项时出错

sencha app build 命令的工作原理是读取您的 index.html 和 app.json 文件，并扫描所需的类。如果您的应用程序未正确声明其所需的类，构建通常会完成，但不会包含您的应用程序所需的所有类。

为了确保您已指定所有必需的类，请始终启用调试器控制台（IE/Chrome 中的“开发者工具”，FireFox 中的 FireBug 以及 Safari 中的 Web Inspector）进行开发，并解决出现的所有警告和错误消息。

每当您看到类似这样的警告时

[Ext.Loader] Synchronously loading 'Ext.foo.Bar'; consider adding 'Ext.foo.Bar'
explicitly as a require of the corresponding class

您应该将 'Ext.foo.Bar' 添加到发起依赖关系的类的 requires 数组属性中。如果是应用程序范围的依赖项，请将其添加到 app.js 文件中 Ext.application(...) 语句内的 requires 数组属性中。