Skip to content
Appcelerator development tools and UI package for the Atom text editor
JavaScript CSS
Branch: master
Clone or download
longton95 and ewanharris refactor(autocomplete): updated to use the commons module (#172)
* refactor(autocomplete): updated to use the commons module

* test(completions): updated to use the commons module

* refactor: updated success message

* refactor: addressed comments

* chore: update commons module to 0.3.0

* test: fix tests with missing sdk_version

* refactor: removed generate autocomplete config
Latest commit a5f6e31 Aug 26, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: add some more issue templates May 8, 2019
grammars [ATOM-13] Jump-to-Definition (#44) Nov 13, 2017
images Add @3X Ti logo Jul 11, 2018
lib refactor(autocomplete): updated to use the commons module (#172) Aug 26, 2019
settings Add support for native modules; add keyboard shortcuts for related Al… Jan 8, 2018
snippets Default to latest SDK if none selected; improved Alloy create functio… Feb 20, 2018
spec refactor(autocomplete): updated to use the commons module (#172) Aug 26, 2019
styles feat(updates): add update functionality (#162) Jul 15, 2019
.eslintignore Ignore data dir for eslint Jul 13, 2018
.eslintrc Fixup some linting and test misses, move to mocha and chai, setup dan… May 8, 2019
.gitignore [ATOM-2] Generate Alloy and Titanium completion list (#48) Nov 22, 2017
.travis.yml ci: move travis to using xenial to fix extract issues (#168) Jul 15, 2019
CHANGELOG.md chore(release): 1.9.0 [ci skip] Aug 13, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Sep 3, 2018
CONTRIBUTING.md Fixup some linting and test misses, move to mocha and chai, setup dan… May 8, 2019
Jenkinsfile ci: always clone master [ci skip] Aug 13, 2019
LICENSE Added license file and updated readme Dec 5, 2017
README.md Embed build status in Readme, "fix" last warnings Jul 13, 2018
dangerfile.js chore(deps): update to latest dependency versions (#163) Jul 15, 2019
package-lock.json refactor(autocomplete): updated to use the commons module (#172) Aug 26, 2019
package.json refactor(autocomplete): updated to use the commons module (#172) Aug 26, 2019

README.md

Appcelerator Titanium Package for Atom Build Status

Appcelerator Titanium build tools and UI for the Atom text editor.

Appcelerator Titanium for Atom screenshot

Getting Started

  • Atom 1.21 (or later) is required.
  • Some features are implemented as providers for services in the Atom IDE package. Install atom-ide-ui package.
  • Install appcelerator-titanium package.

Using the Atom package manager

Preferences/Settings > Install > Search for appcelerator-titanium.

Using the CLI:

apm install appcelerator-titanium

Open a Titanium project

File > Open... > Browse to Titanium project

From the CLI:

atom /path/to/titanium/project

Features

Commands

Command Keymap Description
appc:build ctrl-alt-enter Build using the current selected command and configuration
appc:stop None Stop the current build
appc:console None Toggle the console
appc:generate None Open dialog to generate a new alloy file or component
appc:take-screenshot None Take a screenshot of the currently running device
appc:open view ctrl-alt-v Open the related Alloy XML file
appc:open style ctrl-alt-s Open the related Alloy TSS file
appc:open controller ctrl-alt-x Open the related JavaScript file
appc:open close related ctrl-alt-a Toggle the related Alloy XML, TSS and Javascript files
appc:clean ctrl-alt-k Clean the current project directory

Build tools

Toolbar

The toolbar provides a UI to commonly used commands when developing a Titanium application. Further information on each function is provided in the sections below.

Toolbar

1. Build select and run

Select to run on simulator or device, package for ad-hoc or App Store distribution or a custom build option.

2. Platform select

Select available platforms to build for.

3. Target select

Select simulator/emulator or local device. When attaching a device, select Refresh Targets option to add it to the target list.

4. Code signing / Android KeyStore configuration

When building for device (iOS) or distribution (iOS and Android) the option to configure code signing or keystore credentials is available.

5. LiveView toggle

Toggle the LiveView icon to enable or disable LiveView in your application.

6. Info panel

Provides information about the active project.

7. Generate component

Presents a dialog to generate a Titanium component: Controller, View, Style, Model, Widget or Alloy.jmk file.

8. Console

Show or hide the console which outputs debug information during build and run.

Build

The build select button executes and provides selections of the build command. Depending on the target platform selected, the drop-down will display options for the appc run command:

Build command select

  • Run: Build and run the app on selected simulator/emulator or device
  • Ad-Hoc: (iOS only) build and package the app for Ad-Hoc distribution using selected code signing
  • Publish: Build and package the app for distribution through the App Store or Google Play using selected code signing or keystore credentials
  • Custom: Execute appc run -d <project_dir> with custom arguments

Console

Build command select

The console displays debug logging during the build and run. The log level is passed to the appc run comand so selecting the log level does not alter output from the currently executing command. There are options to automatically scroll the console to the latest message and to open it when a build is initiated.

By default the executing command is displayed in the console to aid debugging. This can be disabled in the package settings.

iOS code signing

When building for a device and ad-hoc or App Store distribution, a certificate and provisioning profile must be selected. Click the code signing / keystore button (#4) to display the code signing options.

iOS code signing

Certificates are populated according to the selected build option (developer / distribution). Available provisioning profiles are displayed but only those which match the selected certificate and app ID are enabled.

Android KeyStore

When building for distribution through Google Play, the app must be signed with a keystore. Click the code signing / keystore button (#4) to display the keystore options.

Android keystore

The path to the keystore can be entered manually or by using the file picker. Keystore path and alias are stored in package configuration.

Autocompletion

Autocompletion support is provided to help speed up development by providing quick references to Titanium APIs and Alloy markup as well as references to modules, widgets and assets within your project.

Generation

On initial launch, autocomplete suggestions are generated for the current selected Titanium SDK. You can check and set this using the CLI:

$ appc ti sdk

...

Installed SDKs:
   7.2.0.GA [selected]  7.2.0.GA
$ appc ti sdk select

Autocomplete suggestions can be regenerated by selecting the 'Regenerate autocomplete suggestions' option from the package settings and relaunching Atom.

Regenerate autocomplete suggestions option

Titanium and Alloy

Titanium APIs and Alloy markup suggestions are provided in Titanium JavaScript and Alloy XML and TSS files. This includes classes, properties, methods and events. Where appropriate additional information is provided with a link to the online documentation. Deprecated properties are also indicated.

Alloy markup class autocomplete

Project references

Suggestions for other controllers, modules and widgets are presented when referencing through a Titanium function or Alloy markup.

Alloy markup widget reference autocomplete

Class and ID references

Suggestions for classes and IDs declared or defined in related Alloy XML and TSS files are presented.

TSS class reference autocomplete

Images

Image suggestions are presented where appropriate, including a thumbnail preview and information about the scaled versions available.

TSS image reference autocomplete

Alloy file and component generation

Alloy file and component generate dialog

A UI for the alloy generate command is provided. The Generate File dialog is presented by clicking the + icon in the toolbar or using the command from the menu or palette. Select the type of file or component to generate and provide the required information. The generated file(s) are then opened.

Open related files

Opening related Alloy files is supported (see above commands list).

  • From View, open related Style and/or Controller
  • From Style, open related View and/or Controller
  • From Controller, open related View and/or Style

Jump-to-definition

Jump-to-definition support is provided for quickly accessing the definiion or usage of Alloy markup and to easily generate new definitions. Images can be opened directly from their path.

Alloy

From Views, click through to style definitions for tags, classes and IDs, in related or global TSS. Click through to event definitions in the related controller.

View tag style definition

A prompt is displayed to generate undefined styles or functions.

View tag style generate definition

Strings

Click on localised string references to jump to their definition. The option to generate undefined strings is provided.

Images

Click on an image path to open the image in a new tab. For iOS, where multiple scaled images exist with the same name the first is opened (e.g. @2x).

Snippets

Code snippets for common Alloy and Titanium APIs are provided for use in Alloy controllers and modules. A description of the snippet and link to documentation are provided where appropriate. Type the prefix and the autocomplete overlay will be displayed with matching snippets.

Code snippet suggestions

Prefix Description
tidebug Debug log message
tierror Error log message
tiinfo Info log message
tiwarn Warn log message
titrace Trace log message
tiaddevent Add event listener
tiremevent Remove event listener
tifireevent Fire event
tialert Show alert dialog
tiopt Show option dialog
tianim View animation
tifile Open file
tisound Play sound
tiaudio Play local or remote audio
tivideo Play local or remove video
ticamera Open camera
alglo Alloy Globals object
alcfg Alloy CFG object
alcon Alloy create controller function
alcol Alloy create collection function
almod Alloy create model function
alwid Alloy create widget function
ifios iOS conditional statement
ifand Android conditional statement
ifwin Windows conditional statement

Contributions

This package would not be possible without support from the Titanium community. Autocompletion, jump-to-definition and grammar support provided by Jong Eun Lee through the Titanium Alloy package. Also a huge thanks to all our open source contributors that help making every release unique for the Titanium community!

Additional thanks

We doff our caps to:

Legal stuff

Appcelerator is a registered trademark of Appcelerator, Inc. Titanium is a registered trademark of Appcelerator, Inc. Please see the LEGAL information about using our trademarks, privacy policy, terms of usage and other legal information at http://www.appcelerator.com/legal.

You can’t perform that action at this time.