-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
PlatformApi definition and documentation. #9
Closed
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3147d05
PlatformApi definition and documentation.
07f99e6
Rename ProjectInfo -> CordovaProject
687fd92
Updates PlatformApi class:
e5a3602
Adds CordovaProject class description
5acd082
Updates output signature of `build` method.
15fb001
Addresses review notes
107596a
Adds high-level ProjectApi class reference
4992734
Adds CordovaPlatform class description
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* jshint node:true, unused:false */ | ||
|
|
||
| var path = require('path'); | ||
| var BuildConfig = require('cordova-common').BuildConfig; | ||
| var ConfigParser = require('cordova-common').ConfigParser; | ||
|
|
||
| /** | ||
| * Encapsulates and stores platform's information. | ||
| * | ||
| * @class | ||
| */ | ||
| function CordovaPlatform(root) { | ||
| /** | ||
| * Simple object that exposes platform's filesystem locations, such as www | ||
| * directory. | ||
| * | ||
| * @type {Object} | ||
| */ | ||
| this.locations = { | ||
| /** @type {String} Platform's www directory location */ | ||
| www: path.join(root, 'www'), | ||
| /** @type {String} Platform's config.xml file location */ | ||
| configXml: path.join(root, 'config.xml'), | ||
| /** | ||
| * Location of cordova.js that shipped with platform. | ||
| * NOTE: THIS PATH IS NOT ABSOLUTE. IT IS RELATIVE TO PLATFORM'S | ||
| * ORIGINAL PACKAGE DIRECTORY, NOT THE INSTALLED PLATFORM'S LOCATION. | ||
| * | ||
| * @type {String} | ||
| */ | ||
| cordovaJs: path.join('bin', 'template', 'www', 'cordova.js'), | ||
| /** | ||
| * Location of platform's cordova.js sources, shipped with platform. | ||
| * NOTE: THIS PATH IS NOT ABSOLUTE. IT IS RELATIVE TO PLATFORM'S | ||
| * ORIGINAL PACKAGE DIRECTORY, NOT THE INSTALLED PLATFORM'S LOCATION. | ||
| * | ||
| * @type {String} | ||
| */ | ||
| cordovaJsSrc: 'cordova-js-src' | ||
| }; | ||
|
|
||
| /** | ||
| * The installed platform's root location. | ||
| * | ||
| * @type {String} | ||
| */ | ||
| this.root = root; | ||
|
|
||
| /** | ||
| * Represents the platform's design-time and runtime configuration which | ||
| * stored in config.xml file. | ||
| * | ||
| * @type {ConfigParser} | ||
| */ | ||
| this.projectConfig = new ConfigParser(this.locations.configXml); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /* jshint node:true, unused:false */ | ||
|
|
||
| var path = require('path'); | ||
| var BuildConfig = require('cordova-common').BuildConfig; | ||
| var ConfigParser = require('cordova-common').ConfigParser; | ||
|
|
||
| /** | ||
| * Encapsulates and stores project information. | ||
| * | ||
| * @class | ||
| */ | ||
| function CordovaProject(root) { | ||
| /** | ||
| * Simple object that exposes this project's filesystem locations, such as www | ||
| * directory. | ||
| * | ||
| * @type {Object} | ||
| */ | ||
| this.locations = { | ||
| /** @type {String} Www directory location */ | ||
| www: path.join(root, 'www'), | ||
| /** @type {String} config.xml file location */ | ||
| configXml: path.join(root, 'config.xml'), | ||
| /** @type {String} Installed platforms location */ | ||
| platforms: path.join(root, 'platforms'), | ||
| /** @type {String} Installed plugins location */ | ||
| plugins: path.join(root, 'plugins') | ||
| }; | ||
|
|
||
| /** | ||
| * The project's root location. | ||
| * | ||
| * @type {String} | ||
| */ | ||
| this.root = root; | ||
|
|
||
| /** | ||
| * Represents the configuration, used for building project. Populated with | ||
| * values from build.json, if exists, or with some default values, | ||
| * if not. | ||
| * | ||
| * @type {BuildConfig} | ||
| */ | ||
| this.buildConfig = new BuildConfig(root); | ||
|
|
||
| /** | ||
| * Represents the project design-time and runtime configuration which stored in | ||
| * project's config.xml file. | ||
| * | ||
| * @type {ConfigParser} | ||
| */ | ||
| this.projectConfig = new ConfigParser(this.locations.configXml); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we be exposing this file ? I think we should expose the one that gets generated by 'prepare' and is in the 'www' folder.