Exclude unnecessary file and folders from release distribution

[SaeedZhiany]

all Gradle wrapper files need to be excluded from distribution

I already have the folder in my project that used this library as a dependency.

so I add the folder into .npmignore to exclude it from release distributions.

you can take a look at the discussion on this PR

cc @friederbluemle

[friederbluemle]

Nice @SaeedZhiany - Yes, the jar file should not be distributed. In addition to gradle/, you can also consider excluding the following files. They are all part of (or generated by) a Gradle wrapper distribution:

.gradle/
build/
gradlew
gradlew.bat
local.properties

[SaeedZhiany]

@friederbluemle
Is your suggested above list enough? I saw your PR with more ignored items

*.iml
.DS_Store
.gradle/
.idea/
.npmignore
build/
gradle/
gradlew
gradlew.bat
local.properties

[jdnichollsc]

Let me know when this PR is OK for you guys, thanks for your help! 💯

[friederbluemle]

@SaeedZhiany - You would need to either put these entries into a separate .npmignore file inside of android/, or prefix all android specific entries with android/. Otherwise they have no effect.

[SaeedZhiany]

@friederbluemle
Oh, you're right, thanks.
is there any file that must be ignored in the ios folder?

# root Directory
.github/
example/
.npmignore

# Android
android/*.iml
android/.gradle/
android/.idea/
android/build/
android/gradle/
android/gradlew
android/gradlew.bat
android/local.properties

is it OK?

@jdnichollsc
which one do you prefer? having multiple .npmignore files in separated folders (root, android) or aggregate all of them in the root directory of the repository?

[friederbluemle]

Ideally, you'd also want to add a files section in package.json with the files and folders to include in the release distribution. Once you do that, having only one .npmignore won't work anymore.

For this repository, the recommended setup would be:

// package.json
...
  "main": "index.js",
  "files": [
    "android/",
    "ios/",
    "index.d.ts",
    "RNInAppBrowser.podspec"
  ],
...

// .npmignore
example/

// android/.npmignore
*.iml
.DS_Store
.gradle/
.idea/
.npmignore
build/
gradle/
gradlew
gradlew.bat
local.properties

// ios/.npmignore
*/project.xcworkspace/
*/xcuserdata/
.DS_Store
.npmignore
Pods/
build/

[SaeedZhiany]

@friederbluemle
is it not necessary to include index.js in "files" too?

[friederbluemle]

Good question - Since index.js is set as main, it is not necessary to also include it in files. Along with several other files (e.g. package.json and README.md) it is always included in the archive.

[friederbluemle]

Btw, you can remove .github/ and .npmignore from the root .npmignore. In the root directory, only the entries listed under files in package.json (along with other defaults) are included.

[friederbluemle]

To test what will be included, just run:

npm pack --dry-run

[SaeedZhiany]

Thanks, @friederbluemle! I learn more new things every day from you 👍

[SaeedZhiany]

@jdnichollsc
I think it's OK to merge now.

this is the list of all files that will be package after merging this PR.

[friederbluemle]

I tested this locally, everything looks great. Ready to merge @jdnichollsc 👍

[jdnichollsc]

thanks for your help guys! 🥇

[SaeedZhiany]

Please also consider to release a new version.

[jdnichollsc]

give me a moment please 👍

[friederbluemle]

@jdnichollsc - Could you also merge #115 before the release? Even more unnecessary files will be excluded.