Return-Path: X-Original-To: apmail-cordova-dev-archive@www.apache.org Delivered-To: apmail-cordova-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 37EC317C5F for ; Thu, 5 Mar 2015 05:24:46 +0000 (UTC) Received: (qmail 86505 invoked by uid 500); 5 Mar 2015 05:24:45 -0000 Delivered-To: apmail-cordova-dev-archive@cordova.apache.org Received: (qmail 86463 invoked by uid 500); 5 Mar 2015 05:24:45 -0000 Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list dev@cordova.apache.org Received: (qmail 86450 invoked by uid 99); 5 Mar 2015 05:24:45 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Mar 2015 05:24:45 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4FFB2E03AF; Thu, 5 Mar 2015 05:24:45 +0000 (UTC) From: nikhilkh To: dev@cordova.apache.org Reply-To: dev@cordova.apache.org References: In-Reply-To: Subject: [GitHub] cordova-lib pull request: CB-8596 Expose APIs to retrieve platform... Content-Type: text/plain Message-Id: <20150305052445.4FFB2E03AF@git1-us-west.apache.org> Date: Thu, 5 Mar 2015 05:24:45 +0000 (UTC) Github user nikhilkh commented on a diff in the pull request: https://github.com/apache/cordova-lib/pull/177#discussion_r25840412 --- 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'} ] +// ToDO: Once we move to npm, this function should be updated to rely on npm instead +function getPlugins(projectRoot){ --- End diff -- Ah..in that case it makes sense to remain consistent and return Q. Is this API documented? JSDoc comments are easier to read and serve as good documentation. From: Omar Mefire [mailto:notifications@github.com] Sent: Wednesday, March 4, 2015 8:50 PM To: apache/cordova-lib Cc: Nikhil Khandelwal Subject: Re: [cordova-lib] CB-8596 Expose APIs to retrieve platforms and plugins saved in config.xml (#177) In cordova-lib/src/cordova/project_metadata.js: > + 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'} ] > +// ToDO: Once we move to npm, this function should be updated to rely on npm instead > +function getPlugins(projectRoot){ valid point! however, we already return promises with all our other APIs. — Reply to this email directly or view it on GitHub. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastructure@apache.org or file a JIRA ticket with INFRA. --- --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org For additional commands, e-mail: dev-help@cordova.apache.org