[
https://issues.apache.org/jira/browse/CB-8596?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14355263#comment-14355263
]
ASF GitHub Bot commented on CB-8596:
------------------------------------
Github user omefire commented on a diff in the pull request:
https://github.com/apache/cordova-lib/pull/177#discussion_r26143818
--- Diff: cordova-lib/src/cordova/project_metadata.js ---
@@ -0,0 +1,60 @@
+/**
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+*/
+
+var cordova_util = require('./util'),
+ ConfigParser = require('../configparser/ConfigParser'),
+ Q = require('q');
+
+// Returns all the platforms that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [{name: 'android', version: '3.5.0'}, {name:
'wp8', version: 'C:/path/to/platform'}, {name: 'ios', version: 'git://...'}]
+// ToDo: Once we move to npm, this function should be updated to rely on
npm instead
+function getPlatforms(projectRoot){
+ var xml = cordova_util.projectConfig(projectRoot);
+ var cfg = new ConfigParser(xml);
+ return Q(cfg.getEngines());
+}
+
+// Returns all the plugins that are currently saved into config.xml
+// Return type is a promise that is fulfilled with a list of objects with
name and version properties. e.g: [ {id: 'org.apache.cordova.device', name:
'Device', APP_ID: 'my-app-id', APP_NAME: 'my-app-name'} ]
--- End diff --
Thanks for the suggestion. definitely cleaner comments...
I just pushed cleaner, more readable comments.
> cordova-lib API for retrieval of platforms and plugins from config.xml
> -----------------------------------------------------------------------
>
> Key: CB-8596
> URL: https://issues.apache.org/jira/browse/CB-8596
> Project: Apache Cordova
> Issue Type: New Feature
> Reporter: Omar Mefire
> Assignee: Omar Mefire
>
> IDE's and other apps using cordova's APIs need a way to access project's
> metadata (platforms and plugins within config.xml) without going directly
> through the ConfigParser. They should be abstracted away from the storage
> details.
> This modification is made even more important with the upcoming move to npm
> that is going to necessitate moving platforms and plugins infos to
> package.json.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
