{@img ../command/sencha-command-128.png}
This guide covers single-page Ext JS applications that do not use the generated scaffold
described in Using Sencha Cmd with Ext JS. While the convenient
commands like sencha app build won't understand these applications and so cannot be
used, you can use the lower-level commands provided by Sencha Cmd to produce builds and
perform all of the same tasks.
The majority of the build process is handled by the Sencha Cmd compiler and the
package manager. These building blocks are connected and streamlined in a generated app,
so that is typically the much simpler and recommended approach. If you need more control
over the process, however, you can use these pieces directly in your own build process.
Even though this guide shows how to use Sencha Cmd at a lower level to support different
organizational preferences, certain guidelines are still important. Please see:
Compiler-Friendly Code Guidelines
We will consider a PHP application with the following folder structure.
index.php # The application's markup file.
build/ # The folder where build output is placed.
ext/ # The framework distribution.
src/ # The framework source tree.
js/ # Folder containing the application's JavaScript code.
app.js # Contains the Ext Application
The "index.php" file would look similar to this:
<html>
<head>
<script src="ext/ext-dev.js" type="text/javascript"></script>
<script src="js/app.js" type="text/javascript"></script>
</head>
<body>
<?php ... ?>
</body>
</html>
This structure is similar to but not the same as the structure generated by Sencha Cmd.
In order for Sencha Cmd to support as many server-side technologies as possible, the
compiler has to be guided to the parts of the markup file that are intended for its
consumption. Outside of the generated build process, the simplest way to do this is by
adding special directives inside comments to your page. For example:
<html>
<head>
<!-- <x-compile> -->
<!-- <x-bootstrap> -->
<script src="ext/ext-dev.js" type="text/javascript"></script>
<!-- </x-bootstrap> -->
<script src="js/app.js" type="text/javascript"></script>
<!-- </x-compile> -->
</head>
<body>
<?php ... ?>
</body>
</html>
The open and close tags of the x-compile directive enclose the part of the markup file
where the compiler will operate. The only thing that should be contained in this block
are script tags. The compiler will process all of these scripts for dependencies.
The exception to this is the "ext-dev.js" file. This file is considered to be a
"bootstrap" file for the framework and should not be processed in the same way. The
compiler ignores the files in the x-bootstrap block, and they are removed from the
final page, as we will see later.
The first job of the compiler is to examine and parse the JavaScript source code and
analyze its dependencies. These dependencies are expressed in code using Ext.define and
the requires (or uses) directives. Also, base classes and mixins are considered to be
dependencies in the same way as requires.
The application requires its own code (in the "js" folder) as well as some of the
framework (in the "ext" folder). The goal is to create a single JavaScript file that
contains all of the code needed from both folders and exclude any code that is not used.
Since most build processes create the production build in a separate folder, let's use the
"build" folder to hold the outputs and thereby avoid overwriting any source code.
Lets start with this command:
sencha compile -classpath=ext/src,js page -yui -in index.php -out build/index.php
This command performs the following steps:
-classpath switch provides the compiler with all of the folders containing source"ext/src" and "js" folders.page command then includes all of the script tags in "index.php"x-compile block."ext/src", "js", and "index.php", the compiler analyzes"index.php"."index.php" file is written to "build/index.php"."index.php" are concatenated, compressed using"build/all-classes.js".The compiled version of "index.php" should look approximately like this:
<html>
<head>
<script src="all-classes.js" type="text/javascript"></script>
</head>
<body>
<?php ... ?>
</body>
</html>
The entire x-compile section is replaced by the single script tag that includes the"all-classes.js" file. The rest of the page remains unchanged.
This is just one step of a complete build process. The others are typically simpler
(for example, copying files) and are not considered here.
Due to the nature of dependency analysis, your application may contain code you know will
never be used. By understanding the compiler below the level of the sencha compile page
command, you can see how to go about further tuning this process. Beyond these techniques
you can also use the compiler without the page command and operate purely on JavaScript
source files. For more information on this lowest-level of the compiler, see the
Sencha Compiler Reference
If you were to remove the -yui switch from the compile command show above, you can
examine "all-classes.js" and inspect the code that was identified as being needed by your
application. If you see classes that you would like to remove, you can do that with
advanced features of the compiler.
At its core, the compiler uses the concept of "sets" and set operations to manage what is
included in the concatenated output file. It first builds the set of all files as it reads
the code from the -classpath. The page command then determines the subset of files used
by "index.php".
To illustrate, let's assume that somehow the Tree package (Ext.tree) is being pulled in
to "all-classes.js" and we are certain that that's incorrect. The following command
removes this namespace:
sencha compile -classpath=ext/src,js \
page -name=page -in index.php -out build/index.php and \
restore page and \
exclude -namespace Ext.tree and \
concat -yui build/all-classes.js
The first change is to provide a name for the set of files produced by the page command.
By naming the set we disable the automatic generation of "all-classes.js" so we can adjust
its contents before generating it explicitly.
This also illustrates the use of command chaining and category state discussed in more
detail in Advanced Sencha Cmd. To summarize these two concepts:
and separates commands in the same category (compile in this case).compile is preserved across these commands.Lets break down the individual steps in the above command as it deviates from the original.
The compile command does the same as before and reads the code in the -classpath.
sencha compile -classpath=ext/src,js \
The page command determines what is needed by "index.php" and generates the modified
version in "build/index.php". The page command also saves the set of files in a set
named page (and does not generate "all-classes.js").
page -name=page -in index.php -out build/index.php and \
The restore command restores the named set (page) as the current set. Most of the
subcommands of the compiler operate on the current set. Without this command, the
current set would be all files.
restore page and \
The exclude command removes all files in the Ext.tree namespace from the current set.
exclude -namespace Ext.tree and \
The concat command concatenates and compresses all files in the current set and writes
the result to "build/all-classes.js".
concat -yui build/all-classes.js
There are many more commands and options provided to manipulate the current set. Basically,
if you can imagine a way to arrive at the desired set of files using a sequence of set
operations, the compiler can combine just those files for you. For more on this topic,
see the Sencha Compiler Reference.
The "bootstrap" file included in the example application ("ext-dev.js") contains two very
important things:
This second part is what allows requires statements to use wildcards as in:
Ext.define(..., {
requires: [
'Ext.grid.*'
]
});
To use similar syntax in your application, you need to provide the required metadata for
the dynamic loader. The following command generates such a file:
sencha compile -classpath=js \
meta -alias -out build/bootstrap.js and \
meta -alt -append -out build/bootstrap.js
This file should be added to the x-bootstrap section, like so:
<html>
<head>
<!-- <x-compile> -->
<!-- <x-bootstrap> -->
<script src="ext/ext-dev.js" type="text/javascript"></script>
<script src="build/bootstrap.js" type="text/javascript"></script>
<!-- </x-bootstrap> -->
<script src="js/app.js" type="text/javascript"></script>
<!-- </x-compile> -->
</head>
<body>
<?php ... ?>
</body>
</html>
There are other uses for code metadata. For details on generating metadata and what kinds
of metadata are provided, see Generating Metadata.
Note. This is handled automatically for generated applications.