Contributing

  1. Fork to your account
  2. Make changes and push to YOUR fork of the repo (linting is run automatically on push, and tests/coverage are run on Travis)
  3. Create a pull request on react-redux-firebase with a description of your changes
  4. Confirm that you have no merge conflicts that will keep the code from being merged
  5. Keep an eye on the Pull Request for comments/updates

NPM Linking

It is often convenient to run a local version of react-redux-firebase within a project to debug issues. The can be accomplished by doing the following:

  1. Fork react-redux-firebase then clone to your local machine
  2. Go into your local react-redux-firebase folder and run npm link
  3. Go into your project or one of the examples and run npm link react-redux-firebase
  4. Go Back in your react-redux-firebase folder
  5. Add/Change some code (placing a simple console.log is a nice way to confirm things are working)
  6. run npm run build to build a new version with your changes
  7. Your local version should now run when using react-redux-firebase within your project

NOTE npm run watch can be used in your local react-redux-firebase folder to run a watch server that will rebuild as you make changes. Only the commonjs version is rebuild when using npm run watch. If using a different version, such as the es version, add watch flag to specific npm build command (i.e. npm run build:es -- --watch) to only rebuild that version when files are changed.

Troubleshooting

  • Module build failed: ReferenceError: Unknown plugin:

    Common Solution

    Include symlinked version of react-redux-firebase in your babel-loader excludes:

    Webpack 1

    {
      loaders: [
        {
          test: /\.(js|jsx)$/,
          exclude: [
            /node_modules/,
            /react-redux-firebase\/dist/, // browser version (most common in Webpack 1)
            /react-redux-firebase\/lib/, // commonjs version
            /react-redux-firebase\/es/ // es version
          ],
          loader: 'babel',
          query: {
            cacheDirectory: true,
            plugins: ['transform-decorators-legacy'],
            presets: ['es2015', 'react']
          }
        }
      ]
    
    }
    

    Webpack 2 & 3

    {
      rules: [
        {
          test: /\.(js|jsx)$/,
          exclude: [
            /node_modules/,
            /react-redux-firebase\/es/ // es version (since webpack 2/3 uses module field of package.json)
          ],
          use: [
            {
              loader: 'babel-loader',
              query: {
                cacheDirectory: true,
                plugins: ['transform-decorators-legacy'],
                presets: ['es2015', 'react']
              }
            }
          ]
        }
      ]
    }
    

    What Happened?

    This error most often appears due to Webpack config. A common pattern is to provide exclude: [/node_modules/] setting to babel-loader, which keeps the loader from transforming code within the node_modules folder. Now that we have used npm link, your project points to your local version of react-redux-firebase instead of the one in your node_modules folder, so we have to tell the loader to also exclude transforming react-redux-firebase.

results matching ""

    No results matching ""