apache / apache/cordova-cli

target of 'resource-file' in config.xml path correct?

Open
#582 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
967
Forks
344
Avg merge
8h 41m
Merged PRs (30d)
9

Description

# Bug Report (or feature?)

## Problem

When using `target` in `` tag of `config.xml` the path location is unclear looking at the documentation.

### What is expected to happen?

When using `` as [described in the docs](https://cordova.apache.org/docs/en/11.x/config_ref/index.html#resource-file) I'd expect the file to end up in the according resources folder of the platform, in this case `app/src/main/res/values/FooPluginStrings.xml`.

### What does actually happen?

The file ends up in the top-level project folder for Android.

## Information

I'm not sure if this is a bug or a feature but the documentation is at least misleading. `res/values/...xml` is the classic resource path for Android platform but you have to use `app/src/main/res/values/...xml` as `target` to actually get this path. In the example this should be:
```

```

In addition it seems the behavior in `config.xml` and `plugin.xml` is different 🤔. Plugin resource files seems to be placed in the correct folder without adding `app/src/main`.

### Command or Code

Put a resource in your config.xml and build the Cordova project, as seen in the docs:
```

```

### Environment, Platform, Device

Debian 9.5 terminal (Windows 11 WSL2), x86_64

### Version information

Cordova: 11.0.0, Android platform 11.0.0
Other Frameworks: none
Operating System: Debian 9.5 on Windows 11 WSL2

## Checklist

- [x] I searched for existing GitHub issues
- [x] I updated all Cordova tooling to most recent version
- [x] I included all the necessary information above

Contributor guide

Open the contributing guide

Research direction

Start with the resource-file section of the Cordova config.xml documentation and reproduce the example using config.xml, then compare its target path with the plugin.xml behavior described in the report. Update the documentation to state the target path base and the expected Android destination, once the behavior is confirmed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.