generate example with symlink by default

[brodycj]

As suggested by @sunnylqm in #232 (resolves #232):

Uses the following command to link the example as the default behavior:

yarn add link:../

From #232: This symlink behavior should enable the user to "directly modify the library code and test [...] in the example project ".

The previous file linkage behavior (yarn add file:../) may be enabled by using the new, deprecated --example-file-linkage option.

No example postinstall workaround script will be added unless the deprecated --example-file-linkage option is used.

Assuming the deprecated --example-file-linkage option is not used, this update will overwrite the example metro.config.js with the following workaround config code, as needed for Metro to work with the symlink:

// metro.config.js
//
// with multiple workarounds for this issue with symlinks:
// https://github.com/facebook/metro/issues/1
//
// with thanks to @johnryan (<https://github.com/johnryan>)
// for the pointers to multiple workaround solutions here:
// https://github.com/facebook/metro/issues/1#issuecomment-541642857
//
// see also this discussion:
// https://github.com/brodybits/create-react-native-module/issues/232

const path = require('path')

module.exports = {
  // workaround for an issue with symlinks encountered starting with
  // metro@0.55 / React Native 0.61
  // (not needed with React Native 0.60 / metro@0.54)
  resolver: {
    extraNodeModules: new Proxy(
      {},
      { get: (_, name) => path.resolve('.', 'node_modules', name) }
    )
  },

  // quick workaround for another issue with symlinks
  watchFolders: ['.', '..']
}

This symlink behavior is more consistent with the new, interactive brodybits/react-native-module-init CLI tool that I made around this one.

Due credit belongs to the following:

• Use symbol link for example #232 by @sunnylqm for both the symlink idea and ideas of Metro config workarounds
• Follow symlinks? facebook/metro#1 (comment) by @johnryan for pointers to both workaround solutions

---

Now tested generated example with:

• native view on React Native 0.62 on Android & iOS
• native module on React Native 0.62 on Android & iOS
• native view on react-native-tvos@0.61 on Android, iOS, & tvOS
• native module on react-native-tvos@0.61 on Android, iOS, & tvOS
• native view on React Native 0.61 on Android & iOS
• native module on React Native 0.61 on Android & iOS
• native view on react-native-tvos@0.60.4-6 on Android, iOS, & tvOS
• native module on react-native-tvos@0.60.4-6 on Android, iOS, & tvOS
• native view on React Native 0.60 on Android & iOS
• native module on React Native 0.60 on Android & iOS

[brodycj]

/merge master

[brodycj]

/merge brodybits-generate-example-with-symlink-by-default

[maitrungduc1410]

Hi @brodybits ,

I use option --generate-example when generate my project, but when I change my native code (Eg: iOS) and re-run using react-native run-ios, I don't see any update.

am I missing something?

Please help, thank you

[maitrungduc1410]

After a morning deep dive into the problem, I ended up with a simple solution:

• In your root library run: yarn link
• In the example project run: yarn link <your_library_name>

After this every changes from library with get effected into example project

Sorry for commenting directly here