Extract project structure into its own file #977
Conversation
|
|
||
| ### Version control | ||
|
|
||
| It is recommended not to check in `platforms/` and `plugins/` directories into version control as they are considered a build artifact. Your platforms and plugins will be saved in config.xml & package.json automatically. These platforms/plugins will be downloaded when `cordova prepare` is invoked. |
There was a problem hiding this comment.
This should say "Your platforms and plugins will be saved in package.json automatically."
We no longer save them into config.xml as of Cordova 9.
There was a problem hiding this comment.
Yeah, exactly why I created this PR. This information being buried in the CLI referenc means it is ignored and I think most users never have seen it - but it could be so useful to understand what Cordova is actually doing and how it works.
I would love if you could add more comment on inaccuracies or missing information of this type here. Will try to work it all in.
There was a problem hiding this comment.
I applied changes so this can be re-reviewed.
| |-- package.json | ||
| |-- config.xml | ||
| |-- hooks/ | ||
| |-- merges/ |
There was a problem hiding this comment.
The merges folder is not created automatically anymore, and we kinda discourage its use (although it's still supported as far as I know).
Also, the example folders here are indented one level too far.
There was a problem hiding this comment.
Is what is written below about merges still accurate though?
Will have to splti existing document into "created by default" and "also supported" somehow I guess.
There was a problem hiding this comment.
I applied changes so this can be re-reviewed.
I tried to reorg the structure so there are now the "default" and "optional" sections.
Also, the example folders here are indented one level too far.
As for this comment, I am not sure what was wrong with the indention level. I went ahead and replaced the entire content with the printout of the tree command.
I made little edits to the printout such as:
- Add the
myappto the top. - Add a
/to the end of directories. This should remove confusion between a directory vs file with no extension.
| myapp/ | ||
| |-- package.json | ||
| |-- config.xml | ||
| |-- hooks/ |
There was a problem hiding this comment.
As with merges, usage of the hooks folder is deprecated.
There was a problem hiding this comment.
Hooks are still supported via config files though, and then can be in random locations, right?
So this here should be removed, but maybe a new paragraph that links to the hooks documentation (that hopyfully exists).
There was a problem hiding this comment.
Yes. Hooks can live anywhere, and we want them explicitly listed in config.xml now instead of auto-detected through the hooks folder.
There was a problem hiding this comment.
For later reference: https://cordova.apache.org/docs/en/9.x/guide/appdev/hooks/index.html is the docs about hooks
There was a problem hiding this comment.
I applied changes so this can be re-reviewed.
erisu
force-pushed
the
janpio-extract_project_structure_from_cli
branch
from
1a3a19e
to
be72066
Compare
This file is extraxcted from cordova-cli via apache/cordova-cli#428
Slight modifications already done, will have to checked if still up to date and probably restructured quite a bit.
Comments and suggestions welcome!