Skip to content
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

Update create doc with proper default values #554

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ath0mas
Copy link

@ath0mas ath0mas commented Apr 18, 2021

Platforms affected

Docs

Motivation and Context

Mixed default values for create between cli doc, cordova-android and cordova-ios.

Description

After reviewing the various values used in cordova-android and cordova-ios for create here are my suggested proper defaults:

  • id / package name: io.cordova.helloCordova
  • name / project name: Hello Cordova

These are the most common values already used but not always ; see linked PRs to fix this situation (apache/cordova-ios#1100, apache/cordova-android#1213).

Testing

in cordova-android and cordova-ios respectively

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

`Hello Cordova` is the project_name default value already used or like so in cordova-android and cordova-ios (config.xml, templates, specs, etc.)
`io.cordova.helloCordova` is the package_name default value already used or like so in cordova-android and cordova-ios (config.xml, templates, specs, etc.)
@codecov-commenter
Copy link

codecov-commenter commented Apr 18, 2021

Codecov Report

❗ No coverage uploaded for pull request base (master@ad7fd5d). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #554   +/-   ##
=========================================
  Coverage          ?   70.40%           
=========================================
  Files             ?        4           
  Lines             ?      321           
  Branches          ?        0           
=========================================
  Hits              ?      226           
  Misses            ?       95           
  Partials          ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ad7fd5d...049daaa. Read the comment docs.

Copy link
Member

@NiklasMerz NiklasMerz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just created a new app yesterday and the default config.xml looks like this:

<?xml version='1.0' encoding='utf-8'?>
<widget id="io.cordova.hellocordova" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
    <name>HelloCordova</name>
    <description>
        A sample Apache Cordova application that responds to the deviceready event.
    </description>
    <author email="dev@cordova.apache.org" href="http://cordova.io">
        Apache Cordova Team
    </author>
    <content src="index.html" />
    <access origin="*" />
    <allow-intent href="http://*/*" />
    <allow-intent href="https://*/*" />
    <allow-intent href="tel:*" />
    <allow-intent href="sms:*" />
    <allow-intent href="mailto:*" />
    <allow-intent href="geo:*" />
    <platform name="android">
        <allow-intent href="market:*" />
    </platform>
    <platform name="ios">
        <allow-intent href="itms:*" />
        <allow-intent href="itms-apps:*" />
    </platform>
</widget>

@ath0mas
Copy link
Author

ath0mas commented Sep 19, 2021

@NiklasMerz you are right :/
I looked for create values in cli, android and ios but it seems I missed the template is elsewhere... like in cordova-lib and or cordova-create ... ; I'm on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants