diff --git a/.changeset/config.json b/.changeset/config.json new file mode 100644 index 0000000000..fe7470104e --- /dev/null +++ b/.changeset/config.json @@ -0,0 +1,13 @@ +{ + "$schema": "https://unpkg.com/@changesets/config@1.6.4/schema.json", + "changelog": "@changesets/cli/changelog", + "commit": false, + "linked": [], + "access": "public", + "baseBranch": "main", + "updateInternalDependencies": "patch", + "ignore": [], + "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": { + "onlyUpdatePeerDependentsWhenOutOfRange": true + } +} diff --git a/.eslintignore b/.eslintignore index b8937bc428..3be8d8f8d5 100644 --- a/.eslintignore +++ b/.eslintignore @@ -7,3 +7,5 @@ build coverage node_modules __snapshots__ +storybook-static +.vscode/* diff --git a/.eslintrc b/.eslintrc deleted file mode 100644 index 0fefa29298..0000000000 --- a/.eslintrc +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parser": "babel-eslint", - "extends": [ - "eslint:recommended", - "plugin:react/recommended", - "prettier" - ], - "globals": { - "chrome": true - }, - "env": { - "es6": true, - "browser": true, - "jest": true, - "node": true - }, - "rules": { - "eol-last": ["warn"], - "max-len": ["warn", { "code": 120 , "ignoreComments": true }], - "quotes": ["warn", "single", "avoid-escape"], - "jsx-quotes": ["warn", "prefer-double"], - "react/prop-types": 0 - }, - "plugins": [ - "prettier", - "react", - "babel" - ], - "settings": { - "react": { - "version": "detect" - } - } -} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..6313b56c57 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000000..dc43f65305 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: Methuselah96 +open_collective: redux-devtools-extension diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 0000000000..fd5d78bdd1 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,31 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + build: + runs-on: 'ubuntu-22.04' + + steps: + - uses: actions/checkout@v5 + - uses: pnpm/action-setup@v4 + - uses: actions/setup-node@v5 + with: + node-version: 'lts/*' + cache: 'pnpm' + - name: Install dependencies + run: pnpm install + - name: Check formatting + run: pnpm run format:check + - name: Build + run: pnpm run build:all + - name: Lint + run: pnpm run lint:all + - name: Test + uses: coactions/setup-xvfb@v1 + with: + run: pnpm run test:all diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000000..618b1be4ea --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,58 @@ +name: Release + +on: + push: + branches: + - main + +permissions: write-all + +jobs: + release: + name: Release + runs-on: 'ubuntu-22.04' + steps: + - name: Checkout Repo + uses: actions/checkout@v5 + with: + # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits + fetch-depth: 0 + + - uses: pnpm/action-setup@v4 + + - name: Setup Node.js + uses: actions/setup-node@v5 + with: + node-version: 'lts/*' + cache: 'pnpm' + + - name: Install Dependencies + run: pnpm install + + - name: Create Release Pull Request or Publish to npm + id: changesets + uses: changesets/action@v1 + with: + version: pnpm changeset version + publish: pnpm run release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + + - name: Archive Chrome Extension + uses: actions/upload-artifact@v4 + with: + name: chrome + path: extension/chrome/dist + + - name: Archive Edge Extension + uses: actions/upload-artifact@v4 + with: + name: edge + path: extension/edge/dist + + - name: Archive Firefox Extension + uses: actions/upload-artifact@v4 + with: + name: firefox + path: extension/firefox/dist diff --git a/.gitignore b/.gitignore index c3f4054287..34daf06adc 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ build coverage .idea .eslintcache +!packages/redux-devtools-slider-monitor/examples/todomvc/dist/index.html +.nx diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000000..1838b1ff4c --- /dev/null +++ b/.prettierignore @@ -0,0 +1,14 @@ +*.log +.idea +lib +dist +umd +build +coverage +node_modules +__snapshots__ +dev +**/demo/public/** +storybook-static +.vscode/* +pnpm-lock.yaml diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000000..544138be45 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,3 @@ +{ + "singleQuote": true +} diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 221c2e8fd0..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,12 +0,0 @@ -sudo: false -language: node_js -node_js: - - "stable" -cache: - yarn: true - directories: - - "node_modules" -script: - - yarn build:all - - yarn lint:all - - yarn test diff --git a/.yarnrc b/.yarnrc deleted file mode 100644 index 19daacaa08..0000000000 --- a/.yarnrc +++ /dev/null @@ -1 +0,0 @@ -workspaces-experimental true diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index f0df8f8cfa..0000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,4 +0,0 @@ -# Change log - -This project adheres to [Semantic Versioning](http://semver.org/). -See all notable changes on [Releases](https://github.com/gaearon/redux-devtools/releases) page. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000..55bc8dfbe9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015-present Dan Abramov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 9bbc41aa07..8ff056c431 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,100 @@ -[![Build Status](https://travis-ci.org/reduxjs/redux-devtools.svg?branch=master)](https://travis-ci.org/reduxjs/redux-devtools) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=round-square)](https://github.com/reduxjs/redux-devtools/pulls) +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/reduxjs/redux-devtools/CI) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=round-square)](https://github.com/reduxjs/redux-devtools/pulls) +[![OpenCollective](https://opencollective.com/redux-devtools-extension/backers/badge.svg)](#backers) +[![OpenCollective](https://opencollective.com/redux-devtools-extension/sponsors/badge.svg)](#sponsors) # Redux DevTools -Developer Tools to power-up [Redux](https://github.com/reactjs/redux) development workflow or any other architecture which handles the state change (see [integrations](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/Integrations.md)). +Developer Tools to power-up [Redux](https://redux.js.org/) development workflow or any other architecture which handles the state change (see [integrations](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/Integrations.md)). -It can be used as a browser extension (for [Chrome](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/)), as [a standalone app](https://github.com/zalmoxisus/remotedev-app) or as [a React component](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools) integrated in the client app. +It can be used as a browser extension (for [Chrome](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd), [Edge](https://microsoftedge.microsoft.com/addons/detail/redux-devtools/nnkgneoiohoecpdiaponcejilbhhikei) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/)), as [a standalone app](https://github.com/reduxjs/redux-devtools/tree/main/packages/redux-devtools-app) or as [a React component](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools) integrated in the client app. ![image](https://user-images.githubusercontent.com/7957859/48663602-3aac4900-ea9b-11e8-921f-97059cbb599c.png) -> Note that this repository is work in progress for [the monorepo](https://github.com/reduxjs/redux-devtools/issues/412), which will merge all the packages. Please refer to [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension) and [Redux DevTools package](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools). +## Documentation -### Documentation - -- [Browser Extension Installation and Configuration](https://github.com/zalmoxisus/redux-devtools-extension#installation) +- [Browser Extension Installation and Configuration](https://github.com/reduxjs/redux-devtools/tree/main/extension#installation) - [Manual Integration as a React Component](./docs/Walkthrough.md#manual-integration) -- [Extension Options (Arguments)](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/docs/API/Arguments.md) -- [Extension Methods (Advanced API)](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/docs/API/Methods.md) +- [Extension Options (Arguments)](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/API/Arguments.md) +- [Extension Methods (Advanced API)](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/API/Methods.md) - [Remote monitoring](./docs/Integrations/Remote.md) -- [Troubleshooting](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/docs/Troubleshooting.md) -- [Recipes](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/docs/Recipes.md) -- [FAQ](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/docs/FAQ.md) +- [Troubleshooting](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/Troubleshooting.md) +- [Recipes](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/Recipes.md) +- [FAQ](https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/FAQ.md) + +## Development + +This is a monorepo powered by [pnpm](https://pnpm.io/). [Install pnpm](https://pnpm.io/installation) and run `pnpm install` to get started. Each package's dependencies need to be built before the package itself can be built. You can either build all the packages (i.e., `pnpm run build:all`) or use pnpm workspace commands to build only the packages necessary for the packages you're working on (i.e., `pnpm --filter "remotedev-redux-devtools-extension" build`). + +## Backers + +Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/redux-devtools-extension#backer)] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Sponsors + +Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/redux-devtools-extension#sponsor)] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ### License diff --git a/babel.config.js b/babel.config.js deleted file mode 100755 index 274c7b183a..0000000000 --- a/babel.config.js +++ /dev/null @@ -1,14 +0,0 @@ -module.exports = { - presets: ['@babel/preset-env', '@babel/preset-react', '@babel/preset-flow'], - plugins: [ - [ - '@babel/plugin-transform-runtime', - { - regenerator: true - } - ], - ['@babel/plugin-proposal-decorators', { legacy: true }], - '@babel/plugin-proposal-class-properties', - '@babel/plugin-proposal-export-default-from' - ] -}; diff --git a/docs/Integrations/Remote.md b/docs/Integrations/Remote.md index d154e4c7c4..7a9bd8e321 100644 --- a/docs/Integrations/Remote.md +++ b/docs/Integrations/Remote.md @@ -1,6 +1,6 @@ ## Remote monitoring -By installing [`redux-devtools-cli`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-cli#usage), starting the server server and launching the Redux DevTools app (`redux-devtools --open`), you can connect any remote application, even not javascript. There are some integrations for javascript like [remote-redux-devtools](https://github.com/zalmoxisus/remote-redux-devtools) and [remotedev](https://github.com/zalmoxisus/remotedev), but the plan is to deprecate them and support it out of the box from the extension without a websocket server. It is more useful for non-js apps. +By installing [`@redux-devtools/cli`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-cli#usage), starting the server server and launching the Redux DevTools app (`redux-devtools --open`), you can connect any remote application, even not javascript. There are some integrations for javascript like [remote-redux-devtools](https://github.com/zalmoxisus/remote-redux-devtools) and [remotedev](https://github.com/zalmoxisus/remotedev), but the plan is to deprecate them and support it out of the box from the extension without a websocket server. It is more useful for non-js apps. ### WebSocket Clients @@ -19,7 +19,7 @@ The client driver provides a way to connect to the server via websockets (see th ```js var socket = socketCluster.connect({ hostname: 'localhost', - port: 8000 + port: 8000, }); ``` @@ -39,13 +39,13 @@ SocketCluster client handles reconnecting for you, but you still might want to k ##### JavaScript ```js -socket.on('connect', status => { +socket.on('connect', (status) => { // Here will come the next step }); -socket.on('disconnect', code => { +socket.on('disconnect', (code) => { console.warn('Socket disconnected with code', code); }); -socket.on('error', error => { +socket.on('error', (error) => { console.warn('Socket error', error); }); ``` @@ -125,7 +125,7 @@ const message = { payload: state, id: socket.id, instanceId: window.btoa(location.href), - name: document.title + name: document.title, }; socket.emit(socket.id ? 'log' : 'log-noid', message); ``` diff --git a/docs/Walkthrough.md b/docs/Walkthrough.md index ad48cf3876..ae1d0ce058 100644 --- a/docs/Walkthrough.md +++ b/docs/Walkthrough.md @@ -2,7 +2,7 @@ ## Browser Extension -If you don’t want to bother with installing Redux DevTools and integrating it into your project, consider using [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension) for Chrome and Firefox. It provides access to the most popular monitors, is easy to configure to filter actions, and doesn’t require installing any packages. +If you don’t want to bother with installing Redux DevTools and integrating it into your project, consider using [Redux DevTools Extension](https://github.com/reduxjs/redux-devtools/tree/master/extension) for Chrome and Firefox. It provides access to the most popular monitors, is easy to configure to filter actions, and doesn’t require installing any packages. ## Manual Integration @@ -12,14 +12,14 @@ It’s more steps, but you will have full control over monitors and their config ### Installation ``` -npm install --save-dev redux-devtools +npm install --save-dev @redux-devtools/core ``` You’ll also likely want to install some monitors: ``` -npm install --save-dev redux-devtools-log-monitor -npm install --save-dev redux-devtools-dock-monitor +npm install --save-dev @redux-devtools/log-monitor +npm install --save-dev @redux-devtools/dock-monitor ``` ### Usage @@ -34,11 +34,11 @@ Somewhere in your project, create a `DevTools` component by passing a `monitor` import React from 'react'; // Exported from redux-devtools -import { createDevTools } from 'redux-devtools'; +import { createDevTools } from '@redux-devtools/core'; // Monitors are separate packages, and you can make a custom one -import LogMonitor from 'redux-devtools-log-monitor'; -import DockMonitor from 'redux-devtools-dock-monitor'; +import LogMonitor from '@redux-devtools/log-monitor'; +import DockMonitor from '@redux-devtools/dock-monitor'; // createDevTools takes a monitor and produces a DevTools component const DevTools = createDevTools( @@ -52,7 +52,7 @@ const DevTools = createDevTools( defaultIsVisible={true} > - + , ); export default DevTools; @@ -88,7 +88,7 @@ const enhancer = compose( // Middleware you want to use in development: applyMiddleware(d1, d2, d3), // Required! Enable Redux DevTools with the monitors you chose - DevTools.instrument() + DevTools.instrument(), ); export default function configureStore(initialState) { @@ -100,8 +100,8 @@ export default function configureStore(initialState) { if (module.hot) { module.hot.accept('../reducers', () => store.replaceReducer( - require('../reducers') /*.default if you use Babel 6+ */ - ) + require('../reducers') /*.default if you use Babel 6+ */, + ), ); } @@ -113,7 +113,7 @@ If you’d like, you may add another store enhancer called `persistState()`. It ```js // ... -import { persistState } from 'redux-devtools'; +import { persistState } from '@redux-devtools/core'; const enhancer = compose( // Middleware you want to use in development: @@ -121,7 +121,7 @@ const enhancer = compose( // Required! Enable Redux DevTools with the monitors you chose DevTools.instrument(), // Optional. Lets you write ?debug_session= in address bar to persist debug sessions - persistState(getDebugSessionKey()) + persistState(getDebugSessionKey()), ); function getDebugSessionKey() { @@ -190,7 +190,7 @@ export default function configureStore(initialState) { ```js import { createStore, applyMiddleware, compose } from 'redux'; -import { persistState } from 'redux-devtools'; +import { persistState } from '@redux-devtools/core'; import rootReducer from '../reducers'; import DevTools from '../containers/DevTools'; @@ -200,7 +200,7 @@ const enhancer = compose( // Required! Enable Redux DevTools with the monitors you chose DevTools.instrument(), // Optional. Lets you write ?debug_session= in address bar to persist debug sessions - persistState(getDebugSessionKey()) + persistState(getDebugSessionKey()), ); function getDebugSessionKey() { @@ -219,8 +219,8 @@ export default function configureStore(initialState) { if (module.hot) { module.hot.accept('../reducers', () => store.replaceReducer( - require('../reducers') /*.default if you use Babel 6+ */ - ) + require('../reducers') /*.default if you use Babel 6+ */, + ), ); } @@ -333,7 +333,7 @@ render( , - document.getElementById('root') + document.getElementById('root'), ); if (process.env.NODE_ENV !== 'production') { @@ -353,7 +353,7 @@ export default function showDevTools(store) { const popup = window.open( null, 'Redux DevTools', - 'menubar=no,location=no,resizable=yes,scrollbars=no,status=no' + 'menubar=no,location=no,resizable=yes,scrollbars=no,status=no', ); // Reload in case it already exists popup.location.reload(); @@ -362,7 +362,7 @@ export default function showDevTools(store) { popup.document.write('
'); render( , - popup.document.getElementById('react-devtools-root') + popup.document.getElementById('react-devtools-root'), ); }, 10); } diff --git a/eslint.js.config.base.mjs b/eslint.js.config.base.mjs new file mode 100644 index 0000000000..31f147f9b5 --- /dev/null +++ b/eslint.js.config.base.mjs @@ -0,0 +1,4 @@ +import eslint from '@eslint/js'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default [eslint.configs.recommended, eslintConfigPrettier]; diff --git a/eslint.js.react.jest.config.base.mjs b/eslint.js.react.jest.config.base.mjs new file mode 100644 index 0000000000..47997596d5 --- /dev/null +++ b/eslint.js.react.jest.config.base.mjs @@ -0,0 +1,43 @@ +import eslint from '@eslint/js'; +import react from 'eslint-plugin-react'; +import { fixupPluginRules } from '@eslint/compat'; +import eslintPluginReactHooks from 'eslint-plugin-react-hooks'; +import jest from 'eslint-plugin-jest'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default [ + { + files: ['test/**/*.js', 'test/**/*.jsx'], + ...eslint.configs.recommended, + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + ...react.configs.flat.recommended, + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + settings: { + react: { + version: 'detect', + }, + }, + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + plugins: { + 'react-hooks': fixupPluginRules(eslintPluginReactHooks), + }, + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + ...jest.configs['flat/recommended'], + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + ...jest.configs['jest/style'], + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + ...eslintConfigPrettier, + }, +]; diff --git a/eslint.ts.config.base.mjs b/eslint.ts.config.base.mjs new file mode 100644 index 0000000000..2af98f40be --- /dev/null +++ b/eslint.ts.config.base.mjs @@ -0,0 +1,55 @@ +import eslint from '@eslint/js'; +import tseslint from 'typescript-eslint'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default (tsconfigRootDir, files = ['**/*.ts'], project = true) => [ + { + files, + ...eslint.configs.recommended, + }, + ...tseslint.configs.recommendedTypeChecked.map((config) => ({ + files, + ...config, + })), + ...tseslint.configs.stylisticTypeChecked.map((config) => ({ + files, + ...config, + })), + { + files, + languageOptions: { + parserOptions: { + project, + tsconfigRootDir, + }, + }, + }, + { + files, + ...eslintConfigPrettier, + }, + { + files, + rules: { + '@typescript-eslint/no-unsafe-return': 'off', + '@typescript-eslint/no-unsafe-assignment': 'off', + '@typescript-eslint/no-unsafe-call': 'off', + '@typescript-eslint/no-unsafe-member-access': 'off', + '@typescript-eslint/prefer-optional-chain': 'off', + '@typescript-eslint/no-base-to-string': 'off', + '@typescript-eslint/consistent-indexed-object-style': 'off', + '@typescript-eslint/prefer-nullish-coalescing': 'off', + '@typescript-eslint/consistent-type-definitions': 'off', + '@typescript-eslint/no-unused-vars': 'off', + '@typescript-eslint/no-explicit-any': 'off', + '@typescript-eslint/prefer-for-of': 'off', + '@typescript-eslint/non-nullable-type-assertion-style': 'off', + '@typescript-eslint/class-literal-property-style': 'off', + '@typescript-eslint/no-redundant-type-constituents': 'off', + '@typescript-eslint/prefer-string-starts-ends-with': 'off', + '@typescript-eslint/no-duplicate-type-constituents': 'off', + '@typescript-eslint/array-type': 'off', + '@typescript-eslint/prefer-function-type': 'off', + }, + }, +]; diff --git a/eslint.ts.jest.config.base.mjs b/eslint.ts.jest.config.base.mjs new file mode 100644 index 0000000000..fd916a03f2 --- /dev/null +++ b/eslint.ts.jest.config.base.mjs @@ -0,0 +1,64 @@ +import eslint from '@eslint/js'; +import tseslint from 'typescript-eslint'; +import jest from 'eslint-plugin-jest'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default (tsconfigRootDir) => [ + { + files: ['test/**/*.ts'], + ...eslint.configs.recommended, + }, + ...tseslint.configs.recommendedTypeChecked.map((config) => ({ + files: ['test/**/*.ts'], + ...config, + })), + ...tseslint.configs.stylisticTypeChecked.map((config) => ({ + files: ['test/**/*.ts'], + ...config, + })), + { + files: ['test/**/*.ts'], + languageOptions: { + parserOptions: { + project: ['./tsconfig.test.json'], + tsconfigRootDir, + }, + }, + }, + { + files: ['test/**/*.ts'], + ...jest.configs['flat/recommended'], + }, + { + files: ['test/**/*.ts'], + ...jest.configs['jest/style'], + }, + { + files: ['test/**/*.ts'], + ...eslintConfigPrettier, + }, + { + files: ['test/**/*.ts'], + rules: { + '@typescript-eslint/no-unsafe-return': 'off', + '@typescript-eslint/no-unsafe-assignment': 'off', + '@typescript-eslint/no-unsafe-call': 'off', + '@typescript-eslint/no-unsafe-member-access': 'off', + '@typescript-eslint/prefer-optional-chain': 'off', + '@typescript-eslint/no-base-to-string': 'off', + '@typescript-eslint/consistent-indexed-object-style': 'off', + '@typescript-eslint/prefer-nullish-coalescing': 'off', + '@typescript-eslint/consistent-type-definitions': 'off', + '@typescript-eslint/no-unused-vars': 'off', + '@typescript-eslint/no-explicit-any': 'off', + '@typescript-eslint/prefer-for-of': 'off', + '@typescript-eslint/non-nullable-type-assertion-style': 'off', + '@typescript-eslint/class-literal-property-style': 'off', + '@typescript-eslint/no-redundant-type-constituents': 'off', + '@typescript-eslint/prefer-string-starts-ends-with': 'off', + '@typescript-eslint/no-duplicate-type-constituents': 'off', + '@typescript-eslint/array-type': 'off', + '@typescript-eslint/prefer-function-type': 'off', + }, + }, +]; diff --git a/eslint.ts.react.config.base.mjs b/eslint.ts.react.config.base.mjs new file mode 100644 index 0000000000..110f1e8a21 --- /dev/null +++ b/eslint.ts.react.config.base.mjs @@ -0,0 +1,89 @@ +import eslint from '@eslint/js'; +import tseslint from 'typescript-eslint'; +import react from 'eslint-plugin-react'; +import { fixupPluginRules } from '@eslint/compat'; +import eslintPluginReactHooks from 'eslint-plugin-react-hooks'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default ( + tsconfigRootDir, + files = ['**/*.ts', '**/*.tsx'], + project = true, +) => [ + { + files, + ...eslint.configs.recommended, + }, + ...tseslint.configs.recommendedTypeChecked.map((config) => ({ + files, + ...config, + })), + ...tseslint.configs.stylisticTypeChecked.map((config) => ({ + files, + ...config, + })), + { + files, + languageOptions: { + parserOptions: { + project, + tsconfigRootDir, + }, + }, + }, + { + files, + ...react.configs.flat.recommended, + }, + { + files, + settings: { + react: { + version: 'detect', + }, + }, + }, + { + files, + plugins: { + 'react-hooks': fixupPluginRules(eslintPluginReactHooks), + }, + }, + { + files, + ...eslintConfigPrettier, + }, + { + files, + rules: { + '@typescript-eslint/no-unsafe-return': 'off', + '@typescript-eslint/no-unsafe-assignment': 'off', + '@typescript-eslint/no-unsafe-call': 'off', + '@typescript-eslint/no-unsafe-member-access': 'off', + '@typescript-eslint/no-misused-promises': [ + 'error', + { + checksVoidReturn: { + attributes: false, + }, + }, + ], + '@typescript-eslint/prefer-optional-chain': 'off', + '@typescript-eslint/no-base-to-string': 'off', + '@typescript-eslint/consistent-indexed-object-style': 'off', + '@typescript-eslint/prefer-nullish-coalescing': 'off', + '@typescript-eslint/consistent-type-definitions': 'off', + '@typescript-eslint/no-unused-vars': 'off', + '@typescript-eslint/no-explicit-any': 'off', + '@typescript-eslint/prefer-for-of': 'off', + '@typescript-eslint/non-nullable-type-assertion-style': 'off', + '@typescript-eslint/class-literal-property-style': 'off', + '@typescript-eslint/no-redundant-type-constituents': 'off', + '@typescript-eslint/prefer-string-starts-ends-with': 'off', + '@typescript-eslint/no-duplicate-type-constituents': 'off', + '@typescript-eslint/array-type': 'off', + '@typescript-eslint/prefer-function-type': 'off', + 'react/prop-types': 'off', + }, + }, +]; diff --git a/eslint.ts.react.jest.config.base.mjs b/eslint.ts.react.jest.config.base.mjs new file mode 100644 index 0000000000..f0db2ab2fb --- /dev/null +++ b/eslint.ts.react.jest.config.base.mjs @@ -0,0 +1,85 @@ +import eslint from '@eslint/js'; +import tseslint from 'typescript-eslint'; +import react from 'eslint-plugin-react'; +import { fixupPluginRules } from '@eslint/compat'; +import eslintPluginReactHooks from 'eslint-plugin-react-hooks'; +import jest from 'eslint-plugin-jest'; +import eslintConfigPrettier from 'eslint-config-prettier'; + +export default (tsconfigRootDir) => [ + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...eslint.configs.recommended, + }, + ...tseslint.configs.recommendedTypeChecked.map((config) => ({ + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...config, + })), + ...tseslint.configs.stylisticTypeChecked.map((config) => ({ + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...config, + })), + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + languageOptions: { + parserOptions: { + project: ['./tsconfig.test.json'], + tsconfigRootDir, + }, + }, + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...react.configs.flat.recommended, + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + settings: { + react: { + version: 'detect', + }, + }, + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + plugins: { + 'react-hooks': fixupPluginRules(eslintPluginReactHooks), + }, + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...jest.configs['flat/recommended'], + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...jest.configs['jest/style'], + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + ...eslintConfigPrettier, + }, + { + files: ['test/**/*.ts', 'test/**/*.tsx'], + rules: { + '@typescript-eslint/no-unsafe-return': 'off', + '@typescript-eslint/no-unsafe-assignment': 'off', + '@typescript-eslint/no-unsafe-call': 'off', + '@typescript-eslint/no-unsafe-member-access': 'off', + '@typescript-eslint/prefer-optional-chain': 'off', + '@typescript-eslint/no-base-to-string': 'off', + '@typescript-eslint/consistent-indexed-object-style': 'off', + '@typescript-eslint/prefer-nullish-coalescing': 'off', + '@typescript-eslint/consistent-type-definitions': 'off', + '@typescript-eslint/no-unused-vars': 'off', + '@typescript-eslint/no-explicit-any': 'off', + '@typescript-eslint/prefer-for-of': 'off', + '@typescript-eslint/non-nullable-type-assertion-style': 'off', + '@typescript-eslint/class-literal-property-style': 'off', + '@typescript-eslint/no-redundant-type-constituents': 'off', + '@typescript-eslint/prefer-string-starts-ends-with': 'off', + '@typescript-eslint/no-duplicate-type-constituents': 'off', + '@typescript-eslint/array-type': 'off', + '@typescript-eslint/prefer-function-type': 'off', + }, + }, +]; diff --git a/extension/.gitignore b/extension/.gitignore new file mode 100644 index 0000000000..f06235c460 --- /dev/null +++ b/extension/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist diff --git a/extension/CHANGELOG.md b/extension/CHANGELOG.md new file mode 100644 index 0000000000..0a676ccd3f --- /dev/null +++ b/extension/CHANGELOG.md @@ -0,0 +1,247 @@ +# remotedev-redux-devtools-extension + +## 3.2.11 + +### Patch Changes + +- Updated dependencies [6163276] + - @redux-devtools/app@7.0.0 + - @redux-devtools/slider-monitor@6.0.0 + - @redux-devtools/ui@2.0.0 + +## 3.2.10 + +### Patch Changes + +- @redux-devtools/app@6.2.2 + +## 3.2.9 + +### Patch Changes + +- Updated dependencies [91f21b2] + - @redux-devtools/core@4.1.1 + - @redux-devtools/slider-monitor@5.1.1 + - @redux-devtools/utils@3.1.1 + - @redux-devtools/app@6.2.1 + +## 3.2.8 + +### Patch Changes + +- Updated dependencies [6830118] + - react-json-tree@0.20.0 + - @redux-devtools/app@6.2.0 + - @redux-devtools/slider-monitor@6.0.0 + - @redux-devtools/ui@1.4.0 + - @redux-devtools/core@4.1.0 + - @redux-devtools/utils@4.0.0 + +## 3.2.7 + +### Patch Changes + +- b25bf13: Send state from background when monitor connects + +## 3.2.6 + +### Patch Changes + +- 50d7682: Fix DevTools from losing connection + +## 3.2.5 + +### Patch Changes + +- eb3ac09: Add logging to background service worker + +## 3.2.4 + +### Patch Changes + +- f1d6158: Fix mocking Chrome API for Electron + +## 3.2.3 + +### Patch Changes + +- fd9f950: Fix monitoring on opening panel +- e49708d: Fix manifest.json for Edge + +## 3.2.1 + +### Patch Changes + +- abd03a7: Fix: only send data to extension if DevTools are open + +## 3.2.0 + +### Minor Changes + +- 83b2c19: Upgrade to Manifest V3 + +## 3.1.11 + +### Patch Changes + +- 73688e1: Fix releasing Firefox extension + +## 3.1.10 + +### Patch Changes + +- 2163bc3: Split large messages sent from background page to devpanel + +## 3.1.9 + +### Patch Changes + +- Updated dependencies [bbb1a40] + - react-json-tree@0.19.0 + - @redux-devtools/slider-monitor@5.0.1 + - @redux-devtools/ui@1.3.2 + +## 3.1.8 + +### Patch Changes + +- 191d419: Convert d3 packages to ESM +- Updated dependencies [191d419] + - @redux-devtools/app@6.0.1 + +## 3.1.7 + +### Patch Changes + +- Updated dependencies [5cfe3e5] +- Updated dependencies [decc035] + - @redux-devtools/app@6.0.0 + - @redux-devtools/slider-monitor@5.0.0 + - @redux-devtools/core@4.0.0 + - @redux-devtools/utils@3.0.0 + +## 3.1.6 + +### Patch Changes + +- Updated dependencies [158ba2c] + - @redux-devtools/app@5.0.0 + +## 3.1.5 + +### Patch Changes + +- 65205f90: Replace Action with Action +- Updated dependencies [65205f90] + - @redux-devtools/app@4.0.1 + - @redux-devtools/core@3.13.2 + +## 3.1.4 + +### Patch Changes + +- Updated dependencies [e57bcb39] + - @redux-devtools/app@4.0.0 + +## 3.1.3 + +### Patch Changes + +- bca76009: Fix missing CSS for code editor + +## 3.1.2 + +### Patch Changes + +- 64ed81b0: Fix extension in Firefox and Chrome Incognito + +## 3.1.1 + +### Patch Changes + +- d18525b5: Increase min-width of popup +- Updated dependencies [57751ff9] + - @redux-devtools/app@3.0.0 + +## 3.1.0 + +### Minor Changes + +- d54adb76: Option to sort State Tree keys alphabetically + Option to disable collapsing of object keys + +### Patch Changes + +- @redux-devtools/app@2.2.2 + +## 3.0.19 + +### Patch Changes + +- 450cde6e: Fix responsive layout + +## 3.0.18 + +### Patch Changes + +- Updated dependencies [81926f32] + - react-json-tree@0.18.0 + - @redux-devtools/app@2.2.1 + +## 3.0.17 + +### Patch Changes + +- 1aa6c4f7: Fix remounting root for devpanel + +## 3.0.16 + +### Patch Changes + +- 20ebf725: Remove source map from page wrap bundle + +## 3.0.14 + +### Patch Changes + +- 24f60a7a: bump min popup window width to 760px #1126 #1129 + +## 3.0.13 + +### Patch Changes + +- Updated dependencies [8a7eae4] + - react-json-tree@0.17.0 + - @redux-devtools/app@2.2.0 + - @redux-devtools/slider-monitor@4.0.0 + - @redux-devtools/ui@1.3.0 + - @redux-devtools/core@3.13.0 + - @redux-devtools/utils@2.0.0 + +## 3.0.12 + +### Patch Changes + +- Updated dependencies [4891bf6] + - @redux-devtools/core@3.12.0 + - @redux-devtools/slider-monitor@3.1.2 + - @redux-devtools/utils@1.2.1 + - @redux-devtools/app@2.1.4 + +## 3.0.11 + +### Patch Changes + +- ab3c0e2: Avoid persisting the selected action index between sessions +- Updated dependencies [ab3c0e2] +- Updated dependencies [4c9a890] + - @redux-devtools/app@2.1.3 + - react-json-tree@0.16.2 + +## 3.0.10 + +### Patch Changes + +- 55cc37e: Fix filter to show state-controlled search value +- Updated dependencies [55cc37e] + - @redux-devtools/app@2.1.2 diff --git a/extension/CODE_OF_CONDUCT.md b/extension/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..c44e836960 --- /dev/null +++ b/extension/CODE_OF_CONDUCT.md @@ -0,0 +1,63 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/extension/LICENSE b/extension/LICENSE new file mode 100644 index 0000000000..b34f293474 --- /dev/null +++ b/extension/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015-present Mihail Diordiev + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/extension/README.md b/extension/README.md new file mode 100644 index 0000000000..c591da9fb2 --- /dev/null +++ b/extension/README.md @@ -0,0 +1,325 @@ +# Redux DevTools Extension + +[![Join the chat at https://gitter.im/zalmoxisus/redux-devtools-extension](https://badges.gitter.im/zalmoxisus/redux-devtools-extension.svg)](https://gitter.im/zalmoxisus/redux-devtools-extension?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=round-square)](http://makeapullrequest.com) +[![OpenCollective](https://opencollective.com/redux-devtools-extension/backers/badge.svg)](#backers) +[![OpenCollective](https://opencollective.com/redux-devtools-extension/sponsors/badge.svg)](#sponsors) + +![Demo](https://cloud.githubusercontent.com/assets/7957859/18002950/aacb82fc-6b93-11e6-9ae9-609862c18302.png) + +## Installation + +### 1. For Chrome + +- from [Chrome Web Store](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd); +- or download `extension.zip` from [last releases](https://github.com/zalmoxisus/redux-devtools-extension/releases), unzip, open `chrome://extensions` url and turn on developer mode from top left and then click; on `Load Unpacked` and select the extracted folder for use +- or build it with `npm i && npm run build:extension` and [load the extension's folder](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked) `./build/extension`; +- or run it in dev mode with `npm i && npm start` and [load the extension's folder](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked) `./dev`. + +### 2. For Firefox + +- from [Mozilla Add-ons](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/); +- or build it with `npm i && npm run build:firefox` and [load the extension's folder](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) `./build/firefox` (just select a file from inside the dir). + +### 3. For Electron + +- just specify `REDUX_DEVTOOLS` in [`electron-devtools-installer`](https://github.com/GPMDP/electron-devtools-installer). + +### 4. For other browsers and non-browser environment + +- use [`remote-redux-devtools`](https://github.com/zalmoxisus/remote-redux-devtools). + +## Usage + +> Note that starting from v2.7, `window.devToolsExtension` was renamed to `window.__REDUX_DEVTOOLS_EXTENSION__` / `window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__`. + +## 1. With Redux + +### 1.1 Basic store + +For a basic [Redux store](https://redux.js.org/api/createstore#createstorereducer-preloadedstate-enhancer) simply add: + +```diff + const store = createStore( + reducer, /* preloadedState, */ ++ window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__() + ); +``` + +Note that [`preloadedState`](https://redux.js.org/api/createstore#createstorereducer-preloadedstate-enhancer) argument is optional in Redux's [`createStore`](https://redux.js.org/api/createstore#createstorereducer-preloadedstate-enhancer). + +> For universal ("isomorphic") apps, prefix it with `typeof window !== 'undefined' &&`. + +```js +const composeEnhancers = + (typeof window !== 'undefined' && + window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__) || + compose; +``` + +> For TypeScript use [`redux-devtools-extension` npm package](#13-use-redux-devtoolsextension-package-from-npm), which contains all the definitions, or just use `(window as any)` (see [Recipes](/docs/Recipes.md#using-in-a-typescript-project) for an example). + +```js +const composeEnhancers = (window as any).__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose; +``` + +In case ESLint is configured to not allow using the underscore dangle, wrap it like so: + +```diff ++ /* eslint-disable no-underscore-dangle */ + const store = createStore( + reducer, /* preloadedState, */ + window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__() + ); ++ /* eslint-enable */ +``` + +> **Note**: Passing enhancer as last argument requires **redux@>=3.1.0**. For older versions apply it like [here](https://github.com/zalmoxisus/redux-devtools-extension/blob/v0.4.2/examples/todomvc/store/configureStore.js) or [here](https://github.com/zalmoxisus/redux-devtools-extension/blob/v0.4.2/examples/counter/store/configureStore.js#L7-L12). Don't mix the old Redux API with the new one. + +> You don't need to npm install [`redux-devtools`](https://github.com/gaearon/redux-devtools) when using the extension (that's a different lib). + +### 1.2 Advanced store setup + +If you setup your store with [middleware and enhancers](http://redux.js.org/docs/api/applyMiddleware.html), change: + +```diff + import { createStore, applyMiddleware, compose } from 'redux'; + ++ const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose; ++ const store = createStore(reducer, /* preloadedState, */ composeEnhancers( +- const store = createStore(reducer, /* preloadedState, */ compose( + applyMiddleware(...middleware) + )); +``` + +> Note that when the extension is not installed, we’re using Redux compose here. + +To specify [extension’s options](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md), use it like so: + +```js +const composeEnhancers = + typeof window === 'object' && window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ + ? window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({ + // Specify extension’s options like name, actionsDenylist, actionsCreators, serialize... + }) + : compose; + +const enhancer = composeEnhancers( + applyMiddleware(...middleware), + // other store enhancers if any +); +const store = createStore(reducer, enhancer); +``` + +> [See the post for more details](https://medium.com/@zalmoxis/improve-your-development-workflow-with-redux-devtools-extension-f0379227ff83). + +### 1.3 Use `@redux-devtools/extension` package from npm + +To make things easier, there's an npm package to install: + +``` +npm install --save @redux-devtools/extension +``` + +and to use like so: + +```js +import { createStore, applyMiddleware } from 'redux'; +import { composeWithDevTools } from '@redux-devtools/extension'; + +const store = createStore( + reducer, + composeWithDevTools( + applyMiddleware(...middleware), + // other store enhancers if any + ), +); +``` + +To specify [extension’s options](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md#windowdevtoolsextensionconfig): + +```js +import { createStore, applyMiddleware } from 'redux'; +import { composeWithDevTools } from '@redux-devtools/extension'; + +const composeEnhancers = composeWithDevTools({ + // Specify name here, actionsDenylist, actionsCreators and other options if needed +}); +const store = createStore( + reducer, + /* preloadedState, */ composeEnhancers( + applyMiddleware(...middleware), + // other store enhancers if any + ), +); +``` + +> There are just a [few lines of code](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/npm-package/index.js) added to your bundle. + +In case you don't include other enhancers and middlewares, just use `devToolsEnhancer`: + +```js +import { createStore } from 'redux'; +import { devToolsEnhancer } from '@redux-devtools/extension'; + +const store = createStore( + reducer, + /* preloadedState, */ devToolsEnhancer(), + // Specify name here, actionsDenylist, actionsCreators and other options if needed +); +``` + +### 1.4 Using in production + +It's useful to include the extension in production as well. Usually you [can use it for development](https://medium.com/@zalmoxis/using-redux-devtools-in-production-4c5b56c5600f). + +If you want to restrict it there, use `composeWithDevToolsLogOnlyInProduction` or `devToolsEnhancerLogOnlyInProduction`: + +```js +import { createStore } from 'redux'; +import { devToolsEnhancerLogOnlyInProduction } from '@redux-devtools/extension'; + +const store = createStore( + reducer, + /* preloadedState, */ devToolsEnhancerLogOnlyInProduction(), + // options like actionSanitizer, stateSanitizer +); +``` + +or with middlewares and enhancers: + +```js +import { createStore, applyMiddleware } from 'redux'; +import { composeWithDevToolsLogOnlyInProduction } from '@redux-devtools/extension'; + +const composeEnhancers = composeWithDevToolsLogOnlyInProduction({ + // options like actionSanitizer, stateSanitizer +}); +const store = createStore( + reducer, + /* preloadedState, */ composeEnhancers( + applyMiddleware(...middleware), + // other store enhancers if any + ), +); +``` + +> You'll have to add `'process.env.NODE_ENV': JSON.stringify('production')` in your Webpack config for the production bundle ([to envify](https://github.com/gaearon/redux-devtools/blob/master/docs/Walkthrough.md#exclude-devtools-from-production-builds)). If you use `create-react-app`, [it already does it for you.](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/config/webpack.config.prod.js#L253-L257) + +If you're already checking `process.env.NODE_ENV` when creating the store, import `composeWithDevToolsLogOnly` or `devToolsEnhancerLogOnly` for production environment. + +If you don’t want to allow the extension in production, just use `composeWithDevToolsDevelopmentOnly` or `devToolsEnhancerDevelopmentOnly`. + +> See [the article](https://medium.com/@zalmoxis/using-redux-devtools-in-production-4c5b56c5600f) for more details. + +### 1.5 For React Native, hybrid, desktop and server side Redux apps + +For React Native we can use [`react-native-debugger`](https://github.com/jhen0409/react-native-debugger), which already included [the same API](https://github.com/jhen0409/react-native-debugger/blob/master/docs/redux-devtools-integration.md) with Redux DevTools Extension. + +For most platforms, include [`Remote Redux DevTools`](https://github.com/zalmoxisus/remote-redux-devtools)'s store enhancer, and from the extension's context menu choose 'Open Remote DevTools' for remote monitoring. + +## 2. Without Redux + +See [integrations](docs/Integrations.md) and [the blog post](https://medium.com/@zalmoxis/redux-devtools-without-redux-or-how-to-have-a-predictable-state-with-any-architecture-61c5f5a7716f) for more details on how to use the extension with any architecture. + +## Docs + +- [Options (arguments)](docs/API/Arguments.md) +- [Methods (advanced API)](docs/API/Methods.md) +- [FAQ](docs/FAQ.md) +- Features + - [Trace actions calls](/docs/Features/Trace.md) +- [Troubleshooting](docs/Troubleshooting.md) +- [Articles](docs/Articles.md) +- [Videos](docs/Videos.md) +- [Feedback](docs/Feedback.md) + +## Demo + +Live demos to use the extension with: + +- [Counter](http://zalmoxisus.github.io/examples/counter/) +- [TodoMVC](http://zalmoxisus.github.io/examples/todomvc/) +- [Redux Form](http://redux-form.com/6.5.0/examples/simple/) +- [React Tetris](https://chvin.github.io/react-tetris/?lan=en) +- [Book Collection (Angular ngrx store)](https://ngrx.github.io/platform/example-app/) + +Also see [`./examples` folder](https://github.com/zalmoxisus/redux-devtools-extension/tree/master/examples). + +## Backers + +Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/redux-devtools-extension#backer)] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## Sponsors + +Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/redux-devtools-extension#sponsor)] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +## License + +MIT + +## Created By + +If you like this, follow [@mdiordiev](https://twitter.com/mdiordiev) on twitter. diff --git a/extension/babel.config.json b/extension/babel.config.json new file mode 100644 index 0000000000..47246cb3a3 --- /dev/null +++ b/extension/babel.config.json @@ -0,0 +1,7 @@ +{ + "presets": [ + ["@babel/preset-env", { "targets": "defaults" }], + "@babel/preset-react", + "@babel/preset-typescript" + ] +} diff --git a/extension/build.mjs b/extension/build.mjs new file mode 100644 index 0000000000..9c378cf4c7 --- /dev/null +++ b/extension/build.mjs @@ -0,0 +1,55 @@ +import * as fs from 'node:fs'; +import * as esbuild from 'esbuild'; +import pug from 'pug'; + +const args = process.argv.slice(2); +const prod = !args.includes('--dev'); + +await esbuild.build({ + bundle: true, + logLevel: 'info', + outdir: 'dist', + minify: prod, + sourcemap: !prod, + define: { + 'process.env.NODE_ENV': prod ? '"production"' : '"development"', + 'process.env.BABEL_ENV': prod ? '"production"' : '"development"', + }, + entryPoints: [ + { out: 'background.bundle', in: 'src/background/index.ts' }, + { out: 'options.bundle', in: 'src/options/index.tsx' }, + { out: 'remote.bundle', in: 'src/remote/index.tsx' }, + { out: 'devpanel.bundle', in: 'src/devpanel/index.tsx' }, + { out: 'devtools.bundle', in: 'src/devtools/index.ts' }, + { out: 'content.bundle', in: 'src/contentScript/index.ts' }, + { out: 'page.bundle', in: 'src/pageScript/index.ts' }, + ], + loader: { + '.woff2': 'file', + }, +}); + +console.log(); + +console.log('Creating HTML files...'); +const htmlFiles = ['devpanel', 'devtools', 'options', 'remote']; +for (const htmlFile of htmlFiles) { + fs.writeFileSync( + `dist/${htmlFile}.html`, + pug.renderFile(`src/${htmlFile}/${htmlFile}.pug`), + ); +} + +console.log('Copying manifest.json...'); +fs.copyFileSync('chrome/manifest.json', 'dist/manifest.json'); + +console.log('Copying assets...'); +fs.cpSync('src/assets', 'dist', { recursive: true }); + +console.log('Copying dist for each browser...'); +fs.cpSync('dist', 'chrome/dist', { recursive: true }); +fs.copyFileSync('chrome/manifest.json', 'chrome/dist/manifest.json'); +fs.cpSync('dist', 'edge/dist', { recursive: true }); +fs.copyFileSync('edge/manifest.json', 'edge/dist/manifest.json'); +fs.cpSync('dist', 'firefox/dist', { recursive: true }); +fs.copyFileSync('firefox/manifest.json', 'firefox/dist/manifest.json'); diff --git a/extension/chrome/manifest.json b/extension/chrome/manifest.json new file mode 100644 index 0000000000..bade9c592c --- /dev/null +++ b/extension/chrome/manifest.json @@ -0,0 +1,64 @@ +{ + "version": "3.2.10", + "name": "Redux DevTools", + "description": "Redux DevTools for debugging application's state changes.", + "homepage_url": "https://github.com/reduxjs/redux-devtools", + "manifest_version": 3, + "action": { + "default_icon": "img/logo/gray.png", + "default_title": "Redux DevTools", + "default_popup": "devpanel.html#popup" + }, + "commands": { + "devtools-window": { + "description": "DevTools window" + }, + "devtools-remote": { + "description": "Remote DevTools" + }, + "_execute_action": { + "suggested_key": { + "default": "Ctrl+Shift+E" + } + } + }, + "icons": { + "16": "img/logo/16x16.png", + "48": "img/logo/48x48.png", + "128": "img/logo/128x128.png" + }, + "options_ui": { + "page": "options.html" + }, + "background": { + "service_worker": "background.bundle.js" + }, + "content_scripts": [ + { + "matches": [""], + "exclude_globs": ["https://www.google*"], + "js": ["content.bundle.js"], + "run_at": "document_start", + "all_frames": true + }, + { + "matches": [""], + "exclude_globs": ["https://www.google*"], + "js": ["page.bundle.js"], + "run_at": "document_start", + "all_frames": true, + "world": "MAIN" + } + ], + "devtools_page": "devtools.html", + "externally_connectable": { + "ids": ["*"] + }, + "permissions": ["notifications", "contextMenus", "storage"], + "host_permissions": ["file:///*", "http://*/*", "https://*/*"], + "content_security_policy": { + "extension_pages": "script-src 'self'; object-src 'self'; style-src * 'unsafe-inline'; img-src 'self' data:;" + }, + "update_url": "https://clients2.google.com/service/update2/crx", + "key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsdJEPwY92xUACA9CcDBDBmbdbp8Ap3cKQ0DJTUuVQvqb4FQAv8RtKY3iUjGvdwuAcSJQIZwHXcP2aNDH3TiFik/NhRK2GRW8X3OZyTdkuDueABGP2KEX8q1WQDgjX/rPIinGYztUrvoICw/UerMPwNW62jwGoVU3YhAGf+15CgX2Y6a4tppnf/+1mPedKPidh0RsM+aJY98rX+r1SPAHPcGzMjocLkqcT75DZBXer8VQN14tOOzRCd6T6oy7qm7eWru8lJwcY66qMQvhk0osqEod2G3nA7aTWpmqPFS66VEiecP9PgZlp8gQdgZ3dFhA62exydlD55JuRhiMIR63yQIDAQAB" +} diff --git a/extension/docs/API/Arguments.md b/extension/docs/API/Arguments.md new file mode 100644 index 0000000000..3e7784de78 --- /dev/null +++ b/extension/docs/API/Arguments.md @@ -0,0 +1,323 @@ +# Options + +Use with + +- `window.__REDUX_DEVTOOLS_EXTENSION__([options])` +- `window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__([options])()` +- `window.__REDUX_DEVTOOLS_EXTENSION__.connect([options])` +- `@redux-devtools/extension` npm package: + +```js +import { composeWithDevTools } from '@redux-devtools/extension'; + +const composeEnhancers = composeWithDevTools(options); +const store = createStore( + reducer, + /* preloadedState, */ composeEnhancers( + applyMiddleware(...middleware), + // other store enhancers if any + ), +); +``` + +The `options` object is optional, and can include any of the following. + +### `name` + +_string_ - the instance name to be shown on the monitor page. Default value is `document.title`. If not specified and there's no document title, it will consist of `tabId` and `instanceId`. + +### `actionCreators` + +_array_ or _object_ - action creators functions to be available in the Dispatcher. See [the example](https://github.com/zalmoxisus/redux-devtools-extension/commit/477e69d8649dfcdc9bf84dd45605dab7d9775c03). + +### `latency` + +_number (in ms)_ - if more than one action is dispatched in the indicated interval, all new actions will be collected and sent at once. It is the joint between performance and speed. When set to `0`, all actions will be sent instantly. Set it to a higher value when experiencing perf issues (also `maxAge` to a lower value). Default is `500 ms`. + +### `maxAge` + +_number_ (>1) - maximum allowed actions to be stored in the history tree. The oldest actions are removed once maxAge is reached. It's critical for performance. Default is `50`. + +### `trace` + +_boolean_ or _function_ - if set to `true`, will include stack trace for every dispatched action, so you can see it in trace tab jumping directly to that part of code ([more details](../Features/Trace.md)). You can use a function (with action object as argument) which should return `new Error().stack` string, getting the stack outside of reducers. Default to `false`. + +### `traceLimit` + +_number_ - maximum stack trace frames to be stored (in case `trace` option was provided as `true`). By default it's `10`. Note that, because extension's calls are excluded, the resulted frames could be 1 less. If `trace` option is a function, `traceLimit` will have no effect, as it's supposed to be handled there. + +### `serialize` + +_boolean_ or _object_ which contains: + +- **options** `object or boolean`: + - `undefined` - will use regular `JSON.stringify` to send data (it's the fast mode). + - `false` - will handle also circular references. + - `true` - will handle also date, regex, undefined, primitives, error objects, symbols, maps, sets and functions. + - object, which contains `date`, `regex`, `undefined`, `nan`, `infinity`, `error`, `symbol`, `map`, `set` and `function` keys. For each of them you can indicate if to include (by setting as `true`). For `function` key you can also specify a custom function which handles serialization. See [`jsan`](https://github.com/kolodny/jsan) for more details. Example: + + ```js + const store = Redux.createStore( + reducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: { + options: { + undefined: true, + function: function (fn) { + return fn.toString(); + }, + }, + }, + }), + ); + ``` + +- **replacer** `function(key, value)` - [JSON `replacer` function](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) used for both actions and states stringify. + + Example of usage with [mori data structures](https://github.com/swannodette/mori): + + ```js + const store = Redux.createStore( + reducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: { + replacer: (key, value) => + value && mori.isMap(value) ? mori.toJs(value) : value, + }, + }), + ); + ``` + + In addition, you can specify a data type by adding a [`__serializedType__`](https://github.com/zalmoxisus/remotedev-serialize/blob/master/helpers/index.js#L4) key. So you can deserialize it back while importing or persisting data. Moreover, it will also [show a nice preview showing the provided custom type](https://cloud.githubusercontent.com/assets/7957859/21814330/a17d556a-d761-11e6-85ef-159dd12f36c5.png): + + ```js + const store = Redux.createStore( + reducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: { + replacer: (key, value) => { + if (Immutable.List.isList(value)) { + // use your custom data type checker + return { + data: value.toArray(), // ImmutableJS custom method to get JS data as array + __serializedType__: 'ImmutableList', // mark you custom data type to show and retrieve back + }; + } + }, + }, + }), + ); + ``` + +- **reviver** `function(key, value)` - [JSON `reviver` function](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) used for parsing the imported actions and states. See [`remotedev-serialize`](https://github.com/zalmoxisus/remotedev-serialize/blob/master/immutable/serialize.js#L8-L41) as an example on how to serialize special data types and get them back: + + ```js + const store = Redux.createStore( + reducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: { + reviver: (key, value) => { + if ( + typeof value === 'object' && + value !== null && + '__serializedType__' in value + ) { + switch (value.__serializedType__) { + case 'ImmutableList': + return Immutable.List(value.data); + } + } + }, + }, + }), + ); + ``` + +- **immutable** `object` - automatically serialize/deserialize immutablejs via [remotedev-serialize](https://github.com/zalmoxisus/remotedev-serialize). Just pass the Immutable library like so: + + ```js + import Immutable from 'immutable'; // https://facebook.github.io/immutable-js/ + // ... + // Like above, only showing off compose this time. Reminder you might not want this in prod. + const composeEnhancers = + typeof window === 'object' && + typeof window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ !== 'undefined' + ? window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({ + serialize: { + immutable: Immutable, + }, + }) + : compose; + ``` + + It will support all ImmutableJS structures. You can even export them into a file and get them back. The only exception is `Record` class, for which you should pass in addition the references to your classes in `refs`. + +- **refs** `array` - ImmutableJS `Record` classes used to make possible restore its instances back when importing, persisting... Example of usage: + + ```js + import Immutable from 'immutable'; + // ... + + const ABRecord = Immutable.Record({ a: 1, b: 2 }); + const myRecord = new ABRecord({ b: 3 }); // used in the reducers + + const store = createStore( + rootReducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: { + immutable: Immutable, + refs: [ABRecord], + }, + }), + ); + ``` + +Also you can specify alternative values right in the state object (in the initial state of the reducer) by adding `toJSON` function: + +In the example bellow it will always send `{ component: '[React]' }`, regardless of the state's `component` value (useful when you don't want to send lots of unnecessary data): + +```js +function component( + state = { component: null, toJSON: () => ({ component: '[React]' }) }, + action, +) { + switch (action.type) { + case 'ADD_COMPONENT': + return { component: action.component }; + default: + return state; + } +} +``` + +You could also alter the value. For example when state is `{ count: 1 }`, we'll send `{ counter: 10 }` (notice we don't have an arrow function this time to use the object's `this`): + +```js +function counter( + state = { + count: 0, + toJSON: function () { + return { conter: this.count * 10 }; + }, + }, + action, +) { + switch (action.type) { + case 'INCREMENT': + return { count: state.count + 1 }; + default: + return state; + } +} +``` + +### `actionSanitizer` / `stateSanitizer` + +- **actionSanitizer** (_function_) - function which takes `action` object and id number as arguments, and should return `action` object back. See the example bellow. +- **stateSanitizer** (_function_) - function which takes `state` object and index as arguments, and should return `state` object back. + +Example of usage: + +```js +const actionSanitizer = (action) => + action.type === 'FILE_DOWNLOAD_SUCCESS' && action.data + ? { ...action, data: '<>' } + : action; +const store = createStore( + rootReducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + actionSanitizer, + stateSanitizer: (state) => + state.data ? { ...state, data: '<>' } : state, + }), +); +``` + +### `actionsDenylist` / `actionsAllowlist` + +_string or array of strings as regex_ - actions types to be hidden / shown in the monitors (while passed to the reducers). If `actionsAllowlist` specified, `actionsDenylist` is ignored. + +Example: + +```js +createStore( + reducer, + remotedev({ + sendTo: 'http://localhost:8000', + actionsDenylist: 'SOME_ACTION', + // or actionsDenylist: ['SOME_ACTION', 'SOME_OTHER_ACTION'] + // or just actionsDenylist: 'SOME_' to omit both + }), +); +``` + +### `predicate` + +_function_ - called for every action before sending, takes `state` and `action` object, and returns `true` in case it allows sending the current data to the monitor. Use it as a more advanced version of `actionsDenylist`/`actionsAllowlist` parameters. +Example of usage: + +```js +const store = createStore( + rootReducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + predicate: (state, action) => + state.dev.logLevel === VERBOSE && !action.forwarded, + }), +); +``` + +### `shouldRecordChanges` + +_boolean_ - if specified as `false`, it will not record the changes till clicking on `Start recording` button. Default is `true`. Available only for Redux enhancer, for others use `autoPause`. + +### `pauseActionType` + +_string_ - if specified, whenever clicking on `Pause recording` button and there are actions in the history log, will add this action type. If not specified, will commit when paused. Available only for Redux enhancer. Default is `@@PAUSED`. + +### `autoPause` + +_boolean_ - auto pauses when the extension’s window is not opened, and so has zero impact on your app when not in use. Not available for Redux enhancer (as it already does it but storing the data to be sent). Default is `false`. + +### `shouldStartLocked` + +_boolean_ - if specified as `true`, it will not allow any non-monitor actions to be dispatched till clicking on `Unlock changes` button. Available only for Redux enhancer. Default is `false`. + +### `shouldHotReload` + +_boolean_ - if set to `false`, will not recompute the states on hot reloading (or on replacing the reducers). Available only for Redux enhancer. Default to `true`. + +### `shouldCatchErrors` + +_boolean_ - if specified as `true`, whenever there's an exception in reducers, the monitors will show the error message, and next actions will not be dispatched. + +### `features` + +If you want to restrict the extension, just specify the features you allow: + +```js +const composeEnhancers = composeWithDevTools({ + features: { + pause: true, // start/pause recording of dispatched actions + lock: true, // lock/unlock dispatching actions and side effects + persist: true, // persist states on page reloading + export: true, // export history of actions in a file + import: 'custom', // import history of actions from a file + jump: true, // jump back and forth (time travelling) + skip: true, // skip (cancel) actions + reorder: true, // drag and drop actions in the history list + dispatch: true, // dispatch custom actions or action creators + test: true, // generate tests for the selected actions + }, + // other options like actionSanitizer, stateSanitizer +}); +``` + +If not specified, all of the features are enabled. When set as an object, only those included as `true` will be allowed. +Note that except `true`/`false`, `import` and `export` can be set as `custom` (which is by default for Redux enhancer), meaning that the importing/exporting occurs on the client side. Otherwise, you'll get/set the data right from the monitor part. diff --git a/extension/docs/API/Methods.md b/extension/docs/API/Methods.md new file mode 100644 index 0000000000..946e424136 --- /dev/null +++ b/extension/docs/API/Methods.md @@ -0,0 +1,93 @@ +## Communicate with the extension directly + +> Note this is advanced API, which you usually don't need to use with Redux enhancer. + +Use the following methods of `window.__REDUX_DEVTOOLS_EXTENSION__`: + +- [connect](#connect) +- [disconnect](#disconnect) +- [send](#send) +- [listen](#listen) +- [open](#open) +- [notifyErrors](#notifyerrors) + + + +### connect([options]) + +##### Arguments + +- [`options`] _Object_ - [see the available options](Arguments.md). + +##### Returns + +_Object_ containing the following methods: + +- `subscribe(listener)` - adds a change listener. It will be called any time an action is dispatched from the monitor. Returns a function to unsubscribe the current listener. +- `unsubscribe()` - unsubscribes all listeners. +- `send(action, state)` - sends a new action and state manually to be shown on the monitor. If action is `null` then we suppose we send `liftedState`. +- `init(state)` - sends the initial state to the monitor. +- `error(message)` - sends the error message to be shown in the extension's monitor. + +Example of usage: + +```js +const devTools = window.__REDUX_DEVTOOLS_EXTENSION__.connect(config); +devTools.subscribe((message) => { + if (message.type === 'DISPATCH' && message.state) { + console.log('DevTools requested to change the state to', message.state); + } +}); +devTools.init({ value: 'initial state' }); +devTools.send('change state', { value: 'state changed' }); +``` + +See [redux enhancer's example](https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-extension/src/logOnly.ts), [react example](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/examples/react-counter-messaging/components/Counter.js) and [blog post](https://medium.com/@zalmoxis/redux-devtools-without-redux-or-how-to-have-a-predictable-state-with-any-architecture-61c5f5a7716f) for more details. + +### disconnect() + +Remove extensions listener and disconnect extensions background script connection. Usually just unsubscribing the listener inside the `connect` is enough. + + + +### send(action, state, [options, instanceId]) + +Send a new action and state manually to be shown on the monitor. It's recommended to use [`connect`](connect), unless you want to hook into an already created instance. + +##### Arguments + +- `action` _String_ (action type) or _Object_ with required `type` key. +- `state` _any_ - usually object to expand. +- [`options`] _Object_ - [see the available options](Arguments.md). +- [`instanceId`] _String_ - instance id for which to include the log. If not specified and not present in the `options` object, will be the first available instance. + + + +### listen(onMessage, instanceId) + +Listen for messages dispatched for specific `instanceId`. For most cases it's better to use `subcribe` inside the [`connect`](connect). + +##### Arguments + +- `onMessage` _Function_ to call when there's an action from the monitor. +- `instanceId` _String_ - instance id for which to handle actions. + + + +### open([position]) + +Open the extension's window. This should be conditional (usually you don't need to open extension's window automatically). + +##### Arguments + +- [`position`] _String_ - window position: `left`, `right`, `bottom`. Also can be `panel` to [open it in a Chrome panel](../FAQ.md#how-to-keep-devtools-window-focused-all-the-time-in-a-chrome-panel). Or `remote` to [open remote monitor](../FAQ.md#how-to-get-it-work-with-webworkers-react-native-hybrid-desktop-and-server-side-apps). By default is `left`. + + + +### notifyErrors([onError]) + +When called, the extension will listen for uncaught exceptions on the page, and, if any, will show native notifications. Optionally, you can provide a function to be called when an exception occurs. + +##### Arguments + +- [`onError`] _Function_ to call when there's an exceptions. diff --git a/extension/docs/API/README.md b/extension/docs/API/README.md new file mode 100644 index 0000000000..13781355d7 --- /dev/null +++ b/extension/docs/API/README.md @@ -0,0 +1,4 @@ +# API Reference + +- [Parameters](Arguments.md) +- [Methods](Methods.md) diff --git a/extension/docs/Architecture.md b/extension/docs/Architecture.md new file mode 100644 index 0000000000..1c8137e163 --- /dev/null +++ b/extension/docs/Architecture.md @@ -0,0 +1,37 @@ +# Architecture Notes + +This document exists to keep track of how the different parts of the Redux DevTools interact, since it's easy to forget how it all works together. This is intended for internal purposes and is just a collection of notes to myself. + +## Entry Points + +### Window + +This is the default view that is shown in the Redux DevTools popup, the Chrome DevTools tab (if direct access to the background page is available), and new popup windows that are created. It has direct access to the background page via `chrome.runtime.getBackgroundPage`. + +### DevPanel + +This is the view that is shown in the Chrome DevTools tab if direct access to the background page is not available. + +Initially this was the view that was always used for the Chrome DevTools tab, but when support to directly access the background page from the DevTools tab was added, [the Window View became the preferred view](https://github.com/zalmoxisus/redux-devtools-extension/pull/580). + +### Remote + +This does not interact with the other parts of the extension at all, it just renders the `App` component from `@redux-devtools/app`. + +It can be triggered by hitting the "Remote" button in any of the other views, which calls `chrome.windows.create` and creates a new window. + +### DevTools + +This is the script that adds the Redux panel in the Chrome DevTools using `chrome.devtools.panels.create`. + +It creates a Window View if it has direct access to the background page, otherwise it creates a DevPanel View. + +Note that this used to always show the DevPanel View, but [started using the Window View by default](https://github.com/zalmoxisus/redux-devtools-extension/pull/580) once direct access to the background page was added to Chrome DevTools tabs. + +### Content Script + +Passes messages between the injected page script and the background page. + +It listens for messages from the injected page script using `window.addEventListener('message', ...)`. It knows the message is from the injected page script if `message.source` is `'@devtools-page'`. See the Chrome DevTools docs where this approach [is documented](https://developer.chrome.com/docs/extensions/how-to/devtools/extend-devtools#evaluated-scripts-to-devtools). + +It creates a connection to the background page using `chrome.runtime.connect` with the name `'tab'` when it receives the first message from the injected page script. diff --git a/extension/docs/Articles.md b/extension/docs/Articles.md new file mode 100644 index 0000000000..09de66adbf --- /dev/null +++ b/extension/docs/Articles.md @@ -0,0 +1,5 @@ +# Articles + +- [Improve your development workflow with Redux DevTools Extension](https://medium.com/@zalmoxis/improve-your-development-workflow-with-redux-devtools-extension-f0379227ff83) +- [Using Redux DevTools in production](https://medium.com/@zalmoxis/using-redux-devtools-in-production-4c5b56c5600f) +- [Redux DevTools without Redux](https://medium.com/@zalmoxis/redux-devtools-without-redux-or-how-to-have-a-predictable-state-with-any-architecture-61c5f5a7716f) diff --git a/extension/docs/Credits.md b/extension/docs/Credits.md new file mode 100644 index 0000000000..f7ec16de1c --- /dev/null +++ b/extension/docs/Credits.md @@ -0,0 +1,11 @@ +# Credits + +- Built using [Crossbuilder](https://github.com/zalmoxisus/crossbuilder) boilerplate. +- Includes [Dan Abramov](https://github.com/gaearon)'s [redux-devtools](https://github.com/gaearon/redux-devtools) and the following monitors: + - [Log Monitor](https://github.com/gaearon/redux-devtools-log-monitor) + - [Inspector](https://github.com/alexkuz/redux-devtools-inspector) + - [Dispatch](https://github.com/YoruNoHikage/redux-devtools-dispatch) + - [Slider](https://github.com/calesce/redux-slider-monitor) + - [Chart](https://github.com/romseguy/redux-devtools-chart-monitor) +- [The logo icon](https://github.com/reactjs/redux/issues/151) made by [Keith Yong](https://github.com/keithyong) . +- Examples from [Redux](https://github.com/rackt/redux/tree/master/examples). diff --git a/extension/docs/FAQ.md b/extension/docs/FAQ.md new file mode 100644 index 0000000000..d46253b57f --- /dev/null +++ b/extension/docs/FAQ.md @@ -0,0 +1,45 @@ +# Redux DevTools Extension FAQ + +## Table of Contents + +- [How to get it work](#how-to-get-it-work) +- [How to disable/enable it in production](#how-to-disable-it-in-production) +- [How to persist debug sessions across page reloads](#how-to-persist-debug-sessions-across-page-reloads) +- [How to open DevTools programmatically](#how-to-open-devtools-programmatically) +- [How to enable/disable errors notifying](#how-to-enabledisable-errors-notifying) +- [How to get it work with WebWorkers, React Native, hybrid, desktop and server side apps](#how-to-get-it-work-with-webworkers-react-native-hybrid-desktop-and-server-side-apps) +- [Keyboard shortcuts](#keyboard-shortcuts) + +#### How to get it work + +- Check the extension with [Counter](http://zalmoxisus.github.io/examples/counter/) or [TodoMVC](http://zalmoxisus.github.io/examples/todomvc/) demo. +- Reload the extension on the extensions page (`chrome://extensions/`). +- If something goes wrong, [open an issue](https://github.com/zalmoxisus/redux-devtools-extension/issues) or tweet me: [@mdiordiev](https://twitter.com/mdiordiev). + +#### How to disable it in production + +Usually you don't have to. See [the article for details on how to include it in production](https://medium.com/@zalmoxis/using-redux-devtools-in-production-4c5b56c5600f). + +#### How to persist debug sessions across page reloads + +Just click the `Persist` button or add `?debug_session=` to the url. + +#### How to open DevTools programmatically + +```js +window.__REDUX_DEVTOOLS_EXTENSION__.open(); +``` + +Make sure to have it conditionally. Auto opening windows is a bad DX. See the [API](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Methods.md#open) for details. + +#### How to enable/disable errors notifying + +Just find `Redux DevTools` on the extensions page (`chrome://extensions/`) and click the `Options` link to customize everything. The errors notifying is disabled by default. If enabled, it works only when the store enhancer is called (in order not to show notifications for any sites you visit). In case you want notifications for a non-redux app, init it explicitly by calling `window.__REDUX_DEVTOOLS_EXTENSION__.notifyErrors()` (probably you'll check if `window.__REDUX_DEVTOOLS_EXTENSION__` exists before calling it). + +#### How to get it work with WebWorkers, React Native, hybrid, desktop and server side apps + +It is not possible to inject extension's script there and to communicate directly. To solve this, use [Remote Redux DevTools](https://github.com/zalmoxisus/remote-redux-devtools). After including it inside the app, click `Remote` button for remote monitoring. + +#### Keyboard shortcuts + +To set/change the keyboard shortcuts, click "Keyboard shortcuts" button on the bottom of the extensions page (`chrome://extensions/`). By default only `Cmd` (`Ctrl`) + `Shift` + `E` is available, which will open the extension popup (only when the Redux store is available in the current page). diff --git a/extension/docs/Features/Trace.md b/extension/docs/Features/Trace.md new file mode 100644 index 0000000000..1aa2505b2a --- /dev/null +++ b/extension/docs/Features/Trace.md @@ -0,0 +1,13 @@ +## Trace actions calls + +![trace-demo](https://user-images.githubusercontent.com/7957859/50161148-a1639300-02e3-11e9-80e7-18d3215a0bf8.gif) + +One of the features of Redux DevTools is to select an action in the history and see the callstack that triggered it. It aims to solve the problem of finding the source of events in the event list. + +By default it's disabled as, depending of the use case, generating and serializing stack traces for every action can impact the performance. To enable it, set `trace` option to `true` as in [examples](https://github.com/zalmoxisus/redux-devtools-extension/commit/64717bb9b3534ff616d9db56c2be680627c7b09d). See [the API](../API/Arguments.md#trace) for more details. + +For some edge cases where stack trace cannot be obtained with just `Error().stack`, you can pass a function as `trace` with your implementation. It's useful for cases where the stack is broken, like, for example, [when calling `setTimeout`](https://github.com/zalmoxisus/redux-devtools-instrument/blob/e7c05c98e7e9654cb7db92a2f56c6b5f3ff2452b/test/instrument.spec.js#L735-L737). It takes `action` object as argument and should return `stack` string. This way it can be also used to provide stack conditionally only for certain actions. + +There's also an optional `traceLimit` parameter, which is `10` by default, to prevent consuming too much memory and serializing large stacks and also allows you to get larger stacks than limited by the browser (it will overpass default limit of `10` imposed by Chrome in `Error.stackTraceLimit`). If `trace` option is a function, `traceLimit` will have no effect, that should be handled there like so: `trace: () => new Error().stack.split('\n').slice(0, limit+1).join('\n')` (`+1` is needed for Chrome where's an extra 1st frame for `Error\n`). + +Apart from opening resources in Chrome DevTools, as seen in the demo above, it can open the file (and jump to the line-column) right in your editor. Pretty useful for debugging, and also as an alternative when it's not possible to use openResource (for Firefox or when using the extension from window or for remote debugging). You can click Settings button and enable that, also adding the path to your project root directory to use. It works out of the box for VSCode, Atom, Webstorm/Phpstorm/IntelliJ, Sublime, Emacs, MacVim, Textmate on Mac and Windows. For Linux you can use [`atom-url-handler`](https://github.com/eclemens/atom-url-handler). diff --git a/extension/docs/Feedback.md b/extension/docs/Feedback.md new file mode 100644 index 0000000000..d31b7e6d93 --- /dev/null +++ b/extension/docs/Feedback.md @@ -0,0 +1,5 @@ +# Feedback wanted + +[File an issue](https://github.com/zalmoxisus/redux-devtools-extension/issues) or [submit a PR](https://github.com/zalmoxisus/redux-devtools-extension/pulls) if you have suggestions, rate us and leave a review on [Chrome Store](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd/reviews), post feature requests and bug reports on [Product Pains](https://productpains.com/product/redux-devtools-extension), or ping me on Twitter as [@mdiordiev](https://twitter.com/mdiordiev). + + diff --git a/extension/docs/Integrations.md b/extension/docs/Integrations.md new file mode 100644 index 0000000000..7f9175d112 --- /dev/null +++ b/extension/docs/Integrations.md @@ -0,0 +1,302 @@ +# Integrations for js and non-js frameworks + +Mostly functional: + +- [React](#react) +- [Angular](#angular) +- [Cycle](#cycle) +- [Ember](#ember) +- [Fable](#fable) +- [Freezer](#freezer) +- [Mobx](#mobx) +- [PureScript](#purescript) +- [Reductive](#reductive) +- [Aurelia](#aurelia) + +In progress: + +- [ClojureScript](#clojurescript) +- [Horizon](#horizon) +- [Python](#python) +- [Swift](#swift) + +### [React](https://github.com/facebook/react) + +#### Inspect React props + +##### [`react-inspect-props`](https://github.com/lucasconstantino/react-inspect-props) + +```js +import { compose, withState } from 'recompose'; +import { inspectProps } from 'react-inspect-props'; + +compose( + withState('count', 'setCount', 0), + inspectProps('Counter inspector'), +)(Counter); +``` + +#### Inspect React states + +##### [`remotedev-react-state`](https://github.com/jhen0409/remotedev-react-state) + +```js +import connectToDevTools from 'remotedev-react-state' + +componentWillMount() { + // Connect to devtools after setup initial state + connectToDevTools(this/*, options */) + } +``` + +#### Inspect React hooks (useState and useReducer) + +##### [`reinspect`](https://github.com/troch/reinspect) + +```js +import { useState } from 'reinspect'; + +export function CounterWithUseState({ id }) { + const [count, setCount] = useState(0, id); + // ... +} +``` + +### [Mobx](https://github.com/mobxjs/mobx) + +#### [`mobx-remotedev`](https://github.com/zalmoxisus/mobx-remotedev) + +```js +import remotedev from 'mobx-remotedev'; +// or import remotedev from 'mobx-remotedev/lib/dev' +// in case you want to use it in production or don't have process.env.NODE_ENV === 'development' + +const appStore = observable({ + // ... +}); + +// Or +class appStore { + // ... +} + +export default remotedev(appStore); +``` + +### [Angular](https://github.com/angular/angular) + +#### [ng2-redux](https://github.com/angular-redux/ng2-redux) + +```js +import { NgReduxModule, NgRedux, DevToolsExtension } from 'ng2-redux'; + +@NgModule({ + /* ... */ + imports: [ /* ... */, NgReduxModule ] +})export class AppModule { + constructor( + private ngRedux: NgRedux, + private devTools: DevToolsExtension) { + + let enhancers = []; + // ... add whatever other enhancers you want. + + // You probably only want to expose this tool in devMode. + if (__DEVMODE__ && devTools.isEnabled()) { + enhancers = [ ...enhancers, devTools.enhancer() ]; + } + + this.ngRedux.configureStore( + rootReducer, + initialState, + [], + enhancers); + } +} +``` + +For Angular 1 see [ng-redux](https://github.com/angular-redux/ng-redux). + +#### [Angular @ngrx/store](https://ngrx.io/) + [`@ngrx/store-devtools`](https://ngrx.io/guide/store-devtools) + +```js +import { StoreDevtoolsModule } from '@ngrx/store-devtools'; + +@NgModule({ + imports: [ + StoreModule.forRoot(rootReducer), + // Instrumentation must be imported after importing StoreModule (config is optional) + StoreDevtoolsModule.instrument({ + maxAge: 5, + }), + ], +}) +export class AppModule {} +``` + +[`Example of integration`](https://github.com/ngrx/platform/tree/master/projects/example-app/) ([live demo](https://ngrx.github.io/platform/example-app/)). + +### [Ember](http://emberjs.com/) + +#### [`ember-redux`](https://github.com/ember-redux/ember-redux) + +```js +//app/enhancers/index.js +import { compose } from 'redux'; +var devtools = window.__REDUX_DEVTOOLS_EXTENSION__ + ? window.__REDUX_DEVTOOLS_EXTENSION__() + : (f) => f; +export default compose(devtools); +``` + +### [Cycle](https://github.com/cyclejs/cyclejs) + +#### [`@culli/store`](https://github.com/milankinen/culli/tree/master/packages/store) + +```js +import { run } from '@cycle/most-run'; +import { makeDOMDriver as DOM } from '@cycle/dom'; +import Store, { ReduxDevtools } from '@culli/store'; +import App, { newId } from './App'; + +run(App, { + DOM: DOM('#app'), + Store: Store( + ReduxDevtools({ + items: [ + { id: newId(), num: 0 }, + { id: newId(), num: 0 }, + ], + }), + ), +}); +``` + +### [Freezer](https://github.com/arqex/freezer) + +#### [`freezer-redux-devtools`](https://github.com/arqex/freezer-redux-devtools) + +```js +import React, { Component } from 'react'; +import { supportChromeExtension } from 'freezer-redux-devtools/freezer-redux-middleware'; +import Freezer from 'freezer-js'; + +// Our state is a freezer object +var State = new Freezer({ hello: 'world' }); + +// Enable the extension +supportChromeExtension(State); +``` + +### [Horizon](https://github.com/rethinkdb/horizon) + +#### [`horizon-remotedev`](https://github.com/zalmoxisus/horizon-remotedev) + +```js +// import hzRemotedev from 'horizon-remotedev'; +// or import hzRemotedev from 'horizon-remotedev/lib/dev' +// in case you want to use it in production or don't have process.env.NODE_ENV === 'development' + +//Setup Horizon connection +const horizon = Horizon(); + +// ... +// Specify the horizon instance to monitor +hzRemotedev(horizon('react_messages')); +``` + +### [Fable](https://github.com/fable-compiler/Fable) + +#### [`fable-elmish/debugger`](https://github.com/fable-elmish/debugger) + +```fsharp +open Elmish.Debug + +Program.mkProgram init update view +|> Program.withDebugger // connect to a devtools monitor via Chrome extension if available +|> Program.run + +``` + +or + +```fsharp +open Elmish.Debug + +Program.mkProgram init update view +|> Program.withDebuggerAt (Remote("localhost",8000)) // connect to a server running on localhost:8000 +|> Program.run +``` + +### [PureScript](https://github.com/purescript/purescript) + +#### [`purescript-react-redux`](https://github.com/ethul/purescript-react-redux) + +[`Example of integration`](https://github.com/ethul/purescript-react-redux-example). + +### [ClojureScript](https://github.com/clojure/clojurescript) + +[`Example of integration`](http://gitlab.xet.ru:9999/publicpr/clojurescript-redux/tree/master#dev-setup) + +### [Python](https://www.python.org/) + +#### [`pyredux`](https://github.com/peterpeter5/pyredux) + +[WIP](https://github.com/zalmoxisus/remotedev-server/issues/34) + +### [Swift](https://github.com/apple/swift) + +#### [`katanaMonitor`](https://github.com/bolismauro/katanaMonitor-lib-swift) for [`katana-swift`](https://github.com/BendingSpoons/katana-swift) + +```swift +import KatanaMonitor + +var middleware: [StoreMiddleware] = [ +// other middleware +] + +#if DEBUG +middleware.append(MonitorMiddleware.create(using: .defaultConfiguration)) +#endif +``` + +### [Reductive](https://github.com/reasonml-community/reductive) + +#### [`reductive-dev-tools`](https://github.com/ambientlight/reductive-dev-tools) + +```reason +let storeEnhancer = + ReductiveDevTools.( + Connectors.reductiveEnhancer( + Extension.enhancerOptions(~name="MyApp", ()), + ) + ); + +let storeCreator = storeEnhancer @@ Reductive.Store.create; +``` + +### [Aurelia](http://aurelia.io) + +#### [`aurelia-store`](https://aurelia.io/docs/plugins/store) + +```ts +import {Aurelia} from 'aurelia-framework'; +import {initialState} from './state'; + +export function configure(aurelia: Aurelia) { + aurelia.use + .standardConfiguration() + .feature('resources'); + + ... + + aurelia.use.plugin('aurelia-store', { + initialState, + devToolsOptions: { // optional + ... // see https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md + }, + }); + + aurelia.start().then(() => aurelia.setRoot()); +} +``` diff --git a/extension/docs/README.md b/extension/docs/README.md new file mode 100644 index 0000000000..f6df934a2c --- /dev/null +++ b/extension/docs/README.md @@ -0,0 +1,21 @@ +# Documentation + +- [Extension](/README.md) + - [Installation](/README.md#installation) + - [Usage](/README.md#usage) + - [Demo](/README.md#demo) +- [API Reference](/docs/API/README.md) + - [Options (arguments)](/docs/API/Arguments.md) + - [Methods (advanced API)](/docs/API/Methods.md) +- Features + - [Trace actions calls](/docs/Features/Trace.md) +- [Integrations](/docs/Integrations.md) +- [FAQ](/docs/FAQ.md) +- [Troubleshooting](/docs/Troubleshooting.md) +- [Recipes](/docs/Recipes.md) +- [Articles](/docs/Articles.md) +- [Videos](/docs/Videos.md) +- [Credits](/docs/Credits.md) +- [Support us](/README.md#backers) +- [Feedback](/docs/Feedback.md) +- [Change Log](https://github.com/zalmoxisus/redux-devtools-extension/releases) diff --git a/extension/docs/Recipes.md b/extension/docs/Recipes.md new file mode 100644 index 0000000000..2ab0cf140a --- /dev/null +++ b/extension/docs/Recipes.md @@ -0,0 +1,78 @@ +# Recipes + +### Using in a typescript project + +The recommended way is to use [`@redux-devtools/extension` npm package](/README.md#13-use-redux-devtools-extension-package-from-npm), which contains all typescript definitions. Or you can just use `window as any`: + +```js +const store = createStore( + rootReducer, + initialState, + (window as any).__REDUX_DEVTOOLS_EXTENSION__ && + (window as any).__REDUX_DEVTOOLS_EXTENSION__() +); +``` + +Note that you many need to set `no-any` to false in your `tslint.json` file. + +Alternatively you can use type-guard in order to avoid +casting to any. + +```typescript +import { createStore, StoreEnhancer } from 'redux'; + +// ... + +type WindowWithDevTools = Window & { + __REDUX_DEVTOOLS_EXTENSION__: () => StoreEnhancer; +}; + +const isReduxDevtoolsExtenstionExist = ( + arg: Window | WindowWithDevTools, +): arg is WindowWithDevTools => { + return '__REDUX_DEVTOOLS_EXTENSION__' in arg; +}; + +// ... + +const store = createStore( + rootReducer, + initialState, + isReduxDevtoolsExtenstionExist(window) + ? window.__REDUX_DEVTOOLS_EXTENSION__() + : undefined, +); +``` + +### Export from browser console or from application + +```js +store.liftedStore.getState(); +``` + +The extension is not sharing `store` object, so you should take care of that. + +### Applying multiple times with different sets of options + +We're [not allowing that from instrumentation part](https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-extension/src/logOnly.ts), which can be used it like so: + +```js +import { createStore, compose } from 'redux'; +import { devToolsEnhancerLogOnly } from '@redux-devtools/extension'; + +const store = createStore( + reducer, + /* preloadedState, */ compose( + devToolsEnhancerLogOnly({ + instaceID: 1, + name: 'Denylisted', + actionsDenylist: '...', + }), + devToolsEnhancerLogOnly({ + instaceID: 2, + name: 'Allowlisted', + actionsAllowlist: '...', + }), + ), +); +``` diff --git a/extension/docs/Troubleshooting.md b/extension/docs/Troubleshooting.md new file mode 100644 index 0000000000..a166972af7 --- /dev/null +++ b/extension/docs/Troubleshooting.md @@ -0,0 +1,131 @@ +# Troubleshooting + +### I just see empty log or "No store found" + +Make sure you [applied the enhancer](https://github.com/zalmoxisus/redux-devtools-extension#2-use-with-redux). Note that passing enhancer as last argument requires redux@>=3.1.0. For older versions apply it like [here](https://github.com/zalmoxisus/redux-devtools-extension/blob/v0.4.2/examples/todomvc/store/configureStore.js) or [here](https://github.com/zalmoxisus/redux-devtools-extension/blob/v0.4.2/examples/counter/store/configureStore.js#L7-L12). + +Don't mix the old Redux API with the new one. Pass enhancers and applyMiddleware as last createStore argument. + +### Access file url (`file:///`) + +If you develop on your local filesystem, make sure to allow Redux DevTools access to `file:///` URLs in the settings of this extension: + +extensions + +### It shows only the `@@INIT` action or moving back and forth doesn't update the state + +Most likely you mutate the state. Check it by [adding `redux-immutable-state-invariant` middleware](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/examples/counter/store/configureStore.js#L3). + +Another cause could be that you are creating multiple stores, which means that the devtools get attached to one but the application uses another. See [https://github.com/reduxjs/redux-toolkit/issues/2753](this issue). + +### @@INIT or REPLACE action resets the state of the app or last actions RE-APPLIED + +`@@redux/REPLACE` (or `@@INIT`) is used internally when the application is hot reloaded. When you use `store.replaceReducer` the effect will be the same as for hot-reloading, where the extension is recomputing all the history again. To avoid that set [`shouldHotReload`](/docs/API/Arguments.md#shouldhotreload) parameter to `false`. + +### It doesn't work with other store enhancers + +Usually the extension's store enhancer should be last in the compose. When you're using [`window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__`](/README.md#12-advanced-store-setup) or [`composeWithDevTools`](/README.md#13-use-redux-devtools-extension-package-from-npm) helper you don't have to worry about the enhancers order. However some enhancers ([like `redux-batched-subscribe`](https://github.com/zalmoxisus/redux-devtools-extension/issues/261)) also have this requirement to be the last in the compose. In this case you can use it like so: + +```js +const store = createStore( + reducer, + preloadedState, + compose( + // applyMiddleware(thunk), + window.__REDUX_DEVTOOLS_EXTENSION__ + ? window.__REDUX_DEVTOOLS_EXTENSION__() + : (noop) => noop, + batchedSubscribe(/* ... */), + ), +); +``` + +Where `batchedSubscribe` is `redux-batched-subscribe` store enhancer. + +### Excessive use of memory and CPU + +That is happening due to serialization of some huge objects included in the state or action. The solution is to [sanitize them](/docs/API/Arguments.md#actionsanitizer--statesanitizer). + +You can do that by including/omitting data containing specific values, having specific types... In the example below we're omitting parts of action and state objects with the key `data` (in case of action only when was dispatched action `FILE_DOWNLOAD_SUCCESS`): + +```js +const actionSanitizer = (action) => + action.type === 'FILE_DOWNLOAD_SUCCESS' && action.data + ? { ...action, data: '<>' } + : action; +const store = createStore( + rootReducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + actionSanitizer, + stateSanitizer: (state) => + state.data ? { ...state, data: '<>' } : state, + }), +); +``` + +There's a more advanced [example on how to implement that for `ui-router`](https://github.com/zalmoxisus/redux-devtools-extension/issues/455#issuecomment-404538385). + +The extension is in different process and cannot access the store object directly, unlike vanilla [`redux-devtools`](https://github.com/reduxjs/redux-devtools) which doesn't have this issue. In case sanitizing doesn't fit your use case, you might consider including it directly as a react component, so there will be no need to serialize the data, but it would add some complexity. + +### It fails to serialize data when [passing synthetic events](https://github.com/zalmoxisus/redux-devtools-extension/issues/275) or [calling an action directly with `redux-actions`](https://github.com/zalmoxisus/redux-devtools-extension/issues/287) + +React synthetic event cannot be reused for performance reason. So, it's not possible to serialize event objects you pass to action payloads. + +1. The best solution is **not to pass the whole event object to reducers, but the data you need**: + +```diff +function click(event) { + return { + type: ELEMENT_CLICKED, +- event: event ++ value: event.target.value + }; +} +``` + +2. If you cannot pick data from the event object or, for some reason, you need the whole object, use `event.persist()` as suggested in [React Docs](https://facebook.github.io/react/docs/events.html#event-pooling), but it will consume RAM while not needed. + + ```diff + function increment(event) { + + event.persist(); + return { + type: ELEMENT_CLICKED, + event: event, + }; + } + ``` + +3. A workaround, to pass the whole object and at the same time not to persist it, is to override this key of the stringified payload in your action creator. Add a custom `toJSON` function right in the action object (which will be called by the extension before accessing the object): + + ```diff + function increment(event) { + return { + type: ELEMENT_CLICKED, + event: event, + + toJSON: function (){ + + return { ...this, event: '[Event]' }; + + } + }; + } + ``` + + Note that it shouldn't be arrow function as we want to have access to the function's `this`. + + As we don't have access to the original object, skipping and recomputing actions during hot reloading will not work in this case. We recommend to use the first solution whenever possible. + +### Symbols or other unserializable data not shown + +To get data which cannot be serialized by `JSON.stringify`, set [`serialize` parameter](/docs/API/Arguments.md#serialize): + +```js +const store = Redux.createStore( + reducer, + window.__REDUX_DEVTOOLS_EXTENSION__ && + window.__REDUX_DEVTOOLS_EXTENSION__({ + serialize: true, + }), +); +``` + +It will handle also date, regex, undefined, error objects, symbols, maps, sets and functions. diff --git a/extension/docs/Videos.md b/extension/docs/Videos.md new file mode 100644 index 0000000000..bb4fbb827e --- /dev/null +++ b/extension/docs/Videos.md @@ -0,0 +1,6 @@ +# Videos + +- [Debugging flux applications in production at React Europe 2016](https://youtu.be/YU8jQ2HtqH4) +- [Hot Reloading with Time Travel at React Europe 2015](https://youtu.be/xsSnOQynTHs) +- [Getting Started with Redux DevTools Extension](https://egghead.io/lessons/javascript-getting-started-with-redux-dev-tools) +- [React & Redux With ExpressJS](https://www.youtube.com/watch?v=6ygcbRpZFR4) diff --git a/extension/edge/manifest.json b/extension/edge/manifest.json new file mode 100644 index 0000000000..1e58c1bbd1 --- /dev/null +++ b/extension/edge/manifest.json @@ -0,0 +1,62 @@ +{ + "version": "3.2.10", + "name": "Redux DevTools", + "description": "Redux DevTools for debugging application's state changes.", + "homepage_url": "https://github.com/reduxjs/redux-devtools", + "manifest_version": 3, + "action": { + "default_icon": "img/logo/gray.png", + "default_title": "Redux DevTools", + "default_popup": "devpanel.html#popup" + }, + "commands": { + "devtools-window": { + "description": "DevTools window" + }, + "devtools-remote": { + "description": "Remote DevTools" + }, + "_execute_action": { + "suggested_key": { + "default": "Ctrl+Shift+E" + } + } + }, + "icons": { + "16": "img/logo/16x16.png", + "48": "img/logo/48x48.png", + "128": "img/logo/128x128.png" + }, + "options_ui": { + "page": "options.html" + }, + "background": { + "service_worker": "background.bundle.js" + }, + "content_scripts": [ + { + "matches": [""], + "exclude_globs": ["https://www.google*"], + "js": ["content.bundle.js"], + "run_at": "document_start", + "all_frames": true + }, + { + "matches": [""], + "exclude_globs": ["https://www.google*"], + "js": ["page.bundle.js"], + "run_at": "document_start", + "all_frames": true, + "world": "MAIN" + } + ], + "devtools_page": "devtools.html", + "externally_connectable": { + "ids": ["*"] + }, + "permissions": ["notifications", "contextMenus", "storage"], + "host_permissions": ["file:///*", "http://*/*", "https://*/*"], + "content_security_policy": { + "extension_pages": "script-src 'self'; object-src 'self'; style-src * 'unsafe-inline'; img-src 'self' data:;" + } +} diff --git a/extension/eslint.config.mjs b/extension/eslint.config.mjs new file mode 100644 index 0000000000..18e89a790a --- /dev/null +++ b/extension/eslint.config.mjs @@ -0,0 +1,38 @@ +import globals from 'globals'; +import eslintJs from '../eslint.js.config.base.mjs'; +import eslintTsReact from '../eslint.ts.react.config.base.mjs'; +import eslintJsReactJest from '../eslint.js.react.jest.config.base.mjs'; + +export default [ + ...eslintJs, + ...eslintTsReact(import.meta.dirname), + ...eslintJsReactJest, + { + ignores: [ + 'chrome', + 'dist', + 'edge', + 'examples', + 'firefox', + 'test/electron/fixture/dist', + ], + }, + { + files: ['build.mjs'], + languageOptions: { + globals: { + ...globals.nodeBuiltin, + }, + }, + }, + { + files: ['test/**/*.js', 'test/**/*.jsx'], + languageOptions: { + globals: { + ...globals.browser, + ...globals.node, + EUI: true, + }, + }, + }, +]; diff --git a/extension/examples/buildAll.js b/extension/examples/buildAll.js new file mode 100644 index 0000000000..3a55876064 --- /dev/null +++ b/extension/examples/buildAll.js @@ -0,0 +1,36 @@ +/** + * Runs an ordered set of commands within each of the build directories. + */ + +import fs from 'fs'; +import path from 'path'; +import { spawnSync } from 'child_process'; + +var exampleDirs = fs.readdirSync(__dirname).filter((file) => { + return fs.statSync(path.join(__dirname, file)).isDirectory(); +}); + +// Ordering is important here. `npm install` must come first. +var cmdArgs = [ + { cmd: 'npm', args: ['install'] }, + { cmd: 'webpack', args: ['index.js'] }, +]; + +for (const dir of exampleDirs) { + for (const cmdArg of cmdArgs) { + // declare opts in this scope to avoid https://github.com/joyent/node/issues/9158 + const opts = { + cwd: path.join(__dirname, dir), + stdio: 'inherit', + }; + let result = {}; + if (process.platform === 'win32') { + result = spawnSync(cmdArg.cmd + '.cmd', cmdArg.args, opts); + } else { + result = spawnSync(cmdArg.cmd, cmdArg.args, opts); + } + if (result.status !== 0) { + throw new Error('Building examples exited with non-zero'); + } + } +} diff --git a/extension/examples/counter/.babelrc b/extension/examples/counter/.babelrc new file mode 100644 index 0000000000..9b7d435ad3 --- /dev/null +++ b/extension/examples/counter/.babelrc @@ -0,0 +1,3 @@ +{ + "presets": ["es2015", "stage-0", "react"] +} diff --git a/extension/examples/counter/actions/counter.js b/extension/examples/counter/actions/counter.js new file mode 100644 index 0000000000..94fcdca135 --- /dev/null +++ b/extension/examples/counter/actions/counter.js @@ -0,0 +1,37 @@ +export const INCREMENT_COUNTER = 'INCREMENT_COUNTER'; +export const DECREMENT_COUNTER = 'DECREMENT_COUNTER'; + +let t; + +export function increment() { + return { + type: INCREMENT_COUNTER, + }; +} + +export function decrement() { + return { + type: DECREMENT_COUNTER, + }; +} + +export function autoIncrement(delay = 10) { + return (dispatch) => { + if (t) { + clearInterval(t); + t = undefined; + return; + } + t = setInterval(() => { + dispatch(increment()); + }, delay); + }; +} + +export function incrementAsync(delay = 1000) { + return (dispatch) => { + setTimeout(() => { + dispatch(increment()); + }, delay); + }; +} diff --git a/extension/examples/counter/components/Counter.js b/extension/examples/counter/components/Counter.js new file mode 100644 index 0000000000..306ad814b7 --- /dev/null +++ b/extension/examples/counter/components/Counter.js @@ -0,0 +1,27 @@ +import React, { Component } from 'react'; +import PropTypes from 'prop-types'; + +class Counter extends Component { + render() { + const { increment, autoIncrement, incrementAsync, decrement, counter } = + this.props; + return ( +

+ Clicked: {counter} times {' '} + {' '} + {' '} + +

+ ); + } +} + +Counter.propTypes = { + increment: PropTypes.func.isRequired, + autoIncrement: PropTypes.func.isRequired, + incrementAsync: PropTypes.func.isRequired, + decrement: PropTypes.func.isRequired, + counter: PropTypes.number.isRequired, +}; + +export default Counter; diff --git a/extension/examples/counter/containers/App.js b/extension/examples/counter/containers/App.js new file mode 100644 index 0000000000..47287ecfdf --- /dev/null +++ b/extension/examples/counter/containers/App.js @@ -0,0 +1,16 @@ +import { bindActionCreators } from 'redux'; +import { connect } from 'react-redux'; +import Counter from '../components/Counter'; +import * as CounterActions from '../actions/counter'; + +function mapStateToProps(state) { + return { + counter: state.counter, + }; +} + +function mapDispatchToProps(dispatch) { + return bindActionCreators(CounterActions, dispatch); +} + +export default connect(mapStateToProps, mapDispatchToProps)(Counter); diff --git a/extension/examples/counter/index.html b/extension/examples/counter/index.html new file mode 100644 index 0000000000..58c0aa80b9 --- /dev/null +++ b/extension/examples/counter/index.html @@ -0,0 +1,10 @@ + + + + Redux counter example + + +
+ + + diff --git a/extension/examples/counter/index.js b/extension/examples/counter/index.js new file mode 100644 index 0000000000..7536393420 --- /dev/null +++ b/extension/examples/counter/index.js @@ -0,0 +1,14 @@ +import React from 'react'; +import { render } from 'react-dom'; +import { Provider } from 'react-redux'; +import App from './containers/App'; +import configureStore from './store/configureStore'; + +const store = configureStore(); + +render( + + + , + document.getElementById('root'), +); diff --git a/extension/examples/counter/package.json b/extension/examples/counter/package.json new file mode 100644 index 0000000000..73fb3ab2f1 --- /dev/null +++ b/extension/examples/counter/package.json @@ -0,0 +1,41 @@ +{ + "name": "redux-counter-example", + "version": "0.0.0", + "description": "Redux counter example", + "scripts": { + "start": "node server.js", + "test": "NODE_ENV=test mocha --recursive --compilers js:babel-core/register --require ./test/setup.js", + "test:watch": "npm test -- --watch" + }, + "repository": { + "type": "git", + "url": "https://github.com/rackt/redux.git" + }, + "license": "MIT", + "bugs": { + "url": "https://github.com/rackt/redux/issues" + }, + "homepage": "http://rackt.github.io/redux", + "dependencies": { + "prop-types": "^15.6.2", + "react": "^16.7.0", + "react-dom": "^16.7.0", + "react-redux": "^6.0.0", + "redux": "^4.0.1", + "redux-devtools-extension": "^2.13.7", + "redux-thunk": "^2.3.0" + }, + "devDependencies": { + "babel-cli": "^6.3.17", + "babel-core": "^6.3.17", + "babel-loader": "^7.0.0", + "babel-preset-es2015": "^6.0.0", + "babel-preset-react": "6.3.13", + "babel-preset-stage-0": "^6.3.13", + "express": "^4.13.3", + "redux-immutable-state-invariant": "^2.1.0", + "webpack": "^4.0.0", + "webpack-dev-server": "^3.0.0", + "webpack-hot-middleware": "^2.2.0" + } +} diff --git a/extension/examples/counter/reducers/counter.js b/extension/examples/counter/reducers/counter.js new file mode 100644 index 0000000000..c16e5d4456 --- /dev/null +++ b/extension/examples/counter/reducers/counter.js @@ -0,0 +1,12 @@ +import { INCREMENT_COUNTER, DECREMENT_COUNTER } from '../actions/counter'; + +export default function counter(state = 0, action) { + switch (action.type) { + case INCREMENT_COUNTER: + return state + 1; + case DECREMENT_COUNTER: + return state - 1; + default: + return state; + } +} diff --git a/extension/examples/counter/reducers/index.js b/extension/examples/counter/reducers/index.js new file mode 100644 index 0000000000..eba07a1561 --- /dev/null +++ b/extension/examples/counter/reducers/index.js @@ -0,0 +1,8 @@ +import { combineReducers } from 'redux'; +import counter from './counter'; + +const rootReducer = combineReducers({ + counter, +}); + +export default rootReducer; diff --git a/extension/examples/counter/server.js b/extension/examples/counter/server.js new file mode 100644 index 0000000000..3b64665ad2 --- /dev/null +++ b/extension/examples/counter/server.js @@ -0,0 +1,32 @@ +var webpack = require('webpack'); +var webpackDevMiddleware = require('webpack-dev-middleware'); +var webpackHotMiddleware = require('webpack-hot-middleware'); +var config = require('./webpack.config'); + +var app = new require('express')(); +var port = 4001; + +var compiler = webpack(config); +app.use( + webpackDevMiddleware(compiler, { + noInfo: true, + publicPath: config.output.publicPath, + }), +); +app.use(webpackHotMiddleware(compiler)); + +app.get('/', function (req, res) { + res.sendFile(__dirname + '/index.html'); +}); + +app.listen(port, function (error) { + if (error) { + console.error(error); + } else { + console.info( + '==> 🌎 Listening on port %s. Open up http://localhost:%s/ in your browser.', + port, + port, + ); + } +}); diff --git a/extension/examples/counter/store/configureStore.js b/extension/examples/counter/store/configureStore.js new file mode 100644 index 0000000000..41505920bd --- /dev/null +++ b/extension/examples/counter/store/configureStore.js @@ -0,0 +1,28 @@ +import { createStore, applyMiddleware, compose } from 'redux'; +import { composeWithDevTools } from 'redux-devtools-extension'; +import thunk from 'redux-thunk'; +import invariant from 'redux-immutable-state-invariant'; +import reducer from '../reducers'; +import * as actionCreators from '../actions/counter'; + +export default function configureStore(preloadedState) { + const composeEnhancers = composeWithDevTools({ + actionCreators, + trace: true, + traceLimit: 25, + }); + const store = createStore( + reducer, + preloadedState, + composeEnhancers(applyMiddleware(invariant(), thunk)), + ); + + if (module.hot) { + // Enable Webpack hot module replacement for reducers + module.hot.accept('../reducers', () => { + store.replaceReducer(require('../reducers').default); + }); + } + + return store; +} diff --git a/extension/examples/counter/test/actions/counter.spec.js b/extension/examples/counter/test/actions/counter.spec.js new file mode 100644 index 0000000000..5aa9ddf126 --- /dev/null +++ b/extension/examples/counter/test/actions/counter.spec.js @@ -0,0 +1,73 @@ +import expect from 'expect'; +import { applyMiddleware } from 'redux'; +import thunk from 'redux-thunk'; +import * as actions from '../../actions/counter'; + +const middlewares = [thunk]; + +/* + * Creates a mock of Redux store with middleware. + */ +function mockStore(getState, expectedActions, onLastAction) { + if (!Array.isArray(expectedActions)) { + throw new Error('expectedActions should be an array of expected actions.'); + } + if ( + typeof onLastAction !== 'undefined' && + typeof onLastAction !== 'function' + ) { + throw new Error('onLastAction should either be undefined or function.'); + } + + function mockStoreWithoutMiddleware() { + return { + getState() { + return typeof getState === 'function' ? getState() : getState; + }, + + dispatch(action) { + const expectedAction = expectedActions.shift(); + expect(action).toEqual(expectedAction); + if (onLastAction && !expectedActions.length) { + onLastAction(); + } + return action; + }, + }; + } + + const mockStoreWithMiddleware = applyMiddleware(...middlewares)( + mockStoreWithoutMiddleware, + ); + + return mockStoreWithMiddleware(); +} + +describe('actions', () => { + it('increment should create increment action', () => { + expect(actions.increment()).toEqual({ type: actions.INCREMENT_COUNTER }); + }); + + it('decrement should create decrement action', () => { + expect(actions.decrement()).toEqual({ type: actions.DECREMENT_COUNTER }); + }); + + it('incrementIfOdd should create increment action', (done) => { + const expectedActions = [{ type: actions.INCREMENT_COUNTER }]; + const store = mockStore({ counter: 1 }, expectedActions, done); + store.dispatch(actions.incrementIfOdd()); + }); + + it('incrementIfOdd shouldnt create increment action if counter is even', (done) => { + const expectedActions = []; + const store = mockStore({ counter: 2 }, expectedActions); + store.dispatch(actions.incrementIfOdd()); + done(); + }); + + it('incrementAsync should create increment action', (done) => { + const expectedActions = [{ type: actions.INCREMENT_COUNTER }]; + const store = mockStore({ counter: 0 }, expectedActions, done); + store.dispatch(actions.incrementAsync(100)); + }); +}); diff --git a/extension/examples/counter/test/components/Counter.spec.js b/extension/examples/counter/test/components/Counter.spec.js new file mode 100644 index 0000000000..4b91bce307 --- /dev/null +++ b/extension/examples/counter/test/components/Counter.spec.js @@ -0,0 +1,53 @@ +import expect from 'expect'; +import React from 'react'; +import TestUtils from 'react-addons-test-utils'; +import Counter from '../../components/Counter'; + +function setup() { + const actions = { + increment: expect.createSpy(), + incrementIfOdd: expect.createSpy(), + incrementAsync: expect.createSpy(), + decrement: expect.createSpy(), + }; + const component = TestUtils.renderIntoDocument( + , + ); + return { + component: component, + actions: actions, + buttons: TestUtils.scryRenderedDOMComponentsWithTag(component, 'button'), + p: TestUtils.findRenderedDOMComponentWithTag(component, 'p'), + }; +} + +describe('Counter component', () => { + it('should display count', () => { + const { p } = setup(); + expect(p.textContent).toMatch(/^Clicked: 1 times/); + }); + + it('first button should call increment', () => { + const { buttons, actions } = setup(); + TestUtils.Simulate.click(buttons[0]); + expect(actions.increment).toHaveBeenCalled(); + }); + + it('second button should call decrement', () => { + const { buttons, actions } = setup(); + TestUtils.Simulate.click(buttons[1]); + expect(actions.decrement).toHaveBeenCalled(); + }); + + it('third button should call incrementIfOdd', () => { + const { buttons, actions } = setup(); + TestUtils.Simulate.click(buttons[2]); + expect(actions.incrementIfOdd).toHaveBeenCalled(); + }); + + it('fourth button should call incrementAsync', () => { + const { buttons, actions } = setup(); + TestUtils.Simulate.click(buttons[3]); + expect(actions.incrementAsync).toHaveBeenCalled(); + }); +}); diff --git a/extension/examples/counter/test/containers/App.spec.js b/extension/examples/counter/test/containers/App.spec.js new file mode 100644 index 0000000000..ede61abb4f --- /dev/null +++ b/extension/examples/counter/test/containers/App.spec.js @@ -0,0 +1,53 @@ +import expect from 'expect'; +import React from 'react'; +import TestUtils from 'react-addons-test-utils'; +import { Provider } from 'react-redux'; +import App from '../../containers/App'; +import configureStore from '../../store/configureStore'; + +function setup(initialState) { + const store = configureStore(initialState); + const app = TestUtils.renderIntoDocument( + + + , + ); + return { + app: app, + buttons: TestUtils.scryRenderedDOMComponentsWithTag(app, 'button'), + p: TestUtils.findRenderedDOMComponentWithTag(app, 'p'), + }; +} + +describe('containers', () => { + describe('App', () => { + it('should display initial count', () => { + const { p } = setup(); + expect(p.textContent).toMatch(/^Clicked: 0 times/); + }); + + it('should display updated count after increment button click', () => { + const { buttons, p } = setup(); + TestUtils.Simulate.click(buttons[0]); + expect(p.textContent).toMatch(/^Clicked: 1 times/); + }); + + it('should display updated count after decrement button click', () => { + const { buttons, p } = setup(); + TestUtils.Simulate.click(buttons[1]); + expect(p.textContent).toMatch(/^Clicked: -1 times/); + }); + + it('shouldnt change if even and if odd button clicked', () => { + const { buttons, p } = setup(); + TestUtils.Simulate.click(buttons[2]); + expect(p.textContent).toMatch(/^Clicked: 0 times/); + }); + + it('should change if odd and if odd button clicked', () => { + const { buttons, p } = setup({ counter: 1 }); + TestUtils.Simulate.click(buttons[2]); + expect(p.textContent).toMatch(/^Clicked: 2 times/); + }); + }); +}); diff --git a/extension/examples/counter/test/reducers/counter.spec.js b/extension/examples/counter/test/reducers/counter.spec.js new file mode 100644 index 0000000000..45861187ca --- /dev/null +++ b/extension/examples/counter/test/reducers/counter.spec.js @@ -0,0 +1,23 @@ +import expect from 'expect'; +import counter from '../../reducers/counter'; +import { INCREMENT_COUNTER, DECREMENT_COUNTER } from '../../actions/counter'; + +describe('reducers', () => { + describe('counter', () => { + it('should handle initial state', () => { + expect(counter(undefined, {})).toBe(0); + }); + + it('should handle INCREMENT_COUNTER', () => { + expect(counter(1, { type: INCREMENT_COUNTER })).toBe(2); + }); + + it('should handle DECREMENT_COUNTER', () => { + expect(counter(1, { type: DECREMENT_COUNTER })).toBe(0); + }); + + it('should handle unknown action type', () => { + expect(counter(1, { type: 'unknown' })).toBe(1); + }); + }); +}); diff --git a/extension/examples/counter/test/setup.js b/extension/examples/counter/test/setup.js new file mode 100644 index 0000000000..b4e5ab07bf --- /dev/null +++ b/extension/examples/counter/test/setup.js @@ -0,0 +1,5 @@ +import { jsdom } from 'jsdom'; + +global.document = jsdom(''); +global.window = document.defaultView; +global.navigator = global.window.navigator; diff --git a/extension/examples/counter/webpack.config.js b/extension/examples/counter/webpack.config.js new file mode 100644 index 0000000000..d7aff9b141 --- /dev/null +++ b/extension/examples/counter/webpack.config.js @@ -0,0 +1,23 @@ +var path = require('path'); +var webpack = require('webpack'); + +module.exports = { + mode: 'development', + devtool: 'source-map', + entry: ['webpack-hot-middleware/client', './index'], + output: { + path: path.join(__dirname, 'dist'), + filename: 'bundle.js', + publicPath: '/static/', + }, + plugins: [new webpack.HotModuleReplacementPlugin()], + module: { + rules: [ + { + test: /\.js$/, + loaders: ['babel-loader'], + exclude: /node_modules/, + }, + ], + }, +}; diff --git a/extension/examples/react-counter-messaging/.babelrc b/extension/examples/react-counter-messaging/.babelrc new file mode 100644 index 0000000000..9b7d435ad3 --- /dev/null +++ b/extension/examples/react-counter-messaging/.babelrc @@ -0,0 +1,3 @@ +{ + "presets": ["es2015", "stage-0", "react"] +} diff --git a/extension/examples/react-counter-messaging/components/Counter.js b/extension/examples/react-counter-messaging/components/Counter.js new file mode 100644 index 0000000000..97eda01c9b --- /dev/null +++ b/extension/examples/react-counter-messaging/components/Counter.js @@ -0,0 +1,62 @@ +import React, { Component } from 'react'; + +const withDevTools = + // process.env.NODE_ENV === 'development' && + typeof window !== 'undefined' && window.__REDUX_DEVTOOLS_EXTENSION__; + +class Counter extends Component { + constructor() { + super(); + this.state = { counter: 0 }; + + this.increment = this.increment.bind(this); + this.decrement = this.decrement.bind(this); + } + + componentWillMount() { + if (withDevTools) { + this.devTools = window.__REDUX_DEVTOOLS_EXTENSION__.connect(); + this.unsubscribe = this.devTools.subscribe((message) => { + // Implement monitors actions. + // For example time traveling: + if ( + message.type === 'DISPATCH' && + message.payload.type === 'JUMP_TO_STATE' + ) { + this.setState(message.state); + } + }); + } + } + + componentWillUnmount() { + if (withDevTools) { + this.unsubscribe(); // Use if you have other subscribers from other components. + window.__REDUX_DEVTOOLS_EXTENSION__.disconnect(); // If there aren't other subscribers. + } + } + + increment() { + const state = { counter: this.state.counter + 1 }; + if (withDevTools) this.devTools.send('increment', state); + this.setState(state); + } + + decrement() { + const state = { counter: this.state.counter - 1 }; + if (withDevTools) this.devTools.send('decrement', state); + this.setState(state); + } + + render() { + const { counter } = this.state; + return ( +

+ Clicked: {counter} times {' '} + +

+ ); + } +} + +export default Counter; diff --git a/extension/examples/react-counter-messaging/index.html b/extension/examples/react-counter-messaging/index.html new file mode 100644 index 0000000000..352f8a0a9b --- /dev/null +++ b/extension/examples/react-counter-messaging/index.html @@ -0,0 +1,10 @@ + + + + React counter example + + +
+ + + diff --git a/extension/examples/react-counter-messaging/index.js b/extension/examples/react-counter-messaging/index.js new file mode 100644 index 0000000000..988779bbf6 --- /dev/null +++ b/extension/examples/react-counter-messaging/index.js @@ -0,0 +1,5 @@ +import React from 'react'; +import { render } from 'react-dom'; +import Counter from './components/Counter'; + +render(, document.getElementById('root')); diff --git a/extension/examples/react-counter-messaging/package.json b/extension/examples/react-counter-messaging/package.json new file mode 100644 index 0000000000..97db98974f --- /dev/null +++ b/extension/examples/react-counter-messaging/package.json @@ -0,0 +1,33 @@ +{ + "name": "react-counter-example", + "version": "0.0.0", + "description": "React counter example", + "scripts": { + "start": "webpack-dev-server --progress" + }, + "repository": { + "type": "git", + "url": "https://github.com/zalmoxisus/redux-devtools-extension.git" + }, + "license": "MIT", + "bugs": { + "url": "https://github.com/zalmoxisus/redux-devtools-extension/issues" + }, + "homepage": "https://github.com/zalmoxisus/redux-devtools-extension", + "dependencies": { + "react": "^16.0.0", + "react-dom": "^16.0.0" + }, + "devDependencies": { + "babel-cli": "^6.3.17", + "babel-core": "^6.3.17", + "babel-loader": "^7.0.0", + "babel-preset-es2015": "^6.0.0", + "babel-preset-react": "6.3.13", + "babel-preset-stage-0": "^6.3.13", + "webpack": "^4.0.0", + "webpack-cli": "^3.2.0", + "webpack-dev-server": "^3.0.0", + "webpack-hot-middleware": "^2.2.0" + } +} diff --git a/extension/examples/react-counter-messaging/webpack.config.js b/extension/examples/react-counter-messaging/webpack.config.js new file mode 100644 index 0000000000..43f3ab5bb0 --- /dev/null +++ b/extension/examples/react-counter-messaging/webpack.config.js @@ -0,0 +1,25 @@ +var path = require('path'); +var webpack = require('webpack'); + +module.exports = { + mode: 'development', + devtool: 'source-map', + entry: ['./index'], + output: { + path: path.join(__dirname, 'dist'), + filename: 'bundle.js', + publicPath: '/static/', + }, + module: { + rules: [ + { + test: /\.js$/, + loaders: ['babel-loader'], + exclude: /node_modules/, + }, + ], + }, + devServer: { + port: 4004, + }, +}; diff --git a/extension/examples/router/.babelrc b/extension/examples/router/.babelrc new file mode 100644 index 0000000000..6cc845b99b --- /dev/null +++ b/extension/examples/router/.babelrc @@ -0,0 +1,4 @@ +{ + "presets": ["es2015", "stage-0", "react"], + "plugins": ["add-module-exports", "transform-decorators-legacy"] +} diff --git a/extension/examples/router/actions/todos.js b/extension/examples/router/actions/todos.js new file mode 100644 index 0000000000..6424722129 --- /dev/null +++ b/extension/examples/router/actions/todos.js @@ -0,0 +1,25 @@ +import * as types from '../constants/ActionTypes'; + +export function addTodo(text) { + return { type: types.ADD_TODO, text }; +} + +export function deleteTodo(id) { + return { type: types.DELETE_TODO, id }; +} + +export function editTodo(id, text) { + return { type: types.EDIT_TODO, id, text }; +} + +export function completeTodo(id) { + return { type: types.COMPLETE_TODO, id }; +} + +export function completeAll() { + return { type: types.COMPLETE_ALL }; +} + +export function clearCompleted() { + return { type: types.CLEAR_COMPLETED }; +} diff --git a/extension/examples/router/components/Footer.js b/extension/examples/router/components/Footer.js new file mode 100644 index 0000000000..8972bd8a68 --- /dev/null +++ b/extension/examples/router/components/Footer.js @@ -0,0 +1,76 @@ +import React, { PropTypes, Component } from 'react'; +import classnames from 'classnames'; +import { + SHOW_ALL, + SHOW_COMPLETED, + SHOW_ACTIVE, +} from '../constants/TodoFilters'; + +const FILTER_TITLES = { + [SHOW_ALL]: 'All', + [SHOW_ACTIVE]: 'Active', + [SHOW_COMPLETED]: 'Completed', +}; + +class Footer extends Component { + renderTodoCount() { + const { activeCount } = this.props; + const itemWord = activeCount === 1 ? 'item' : 'items'; + + return ( + + {activeCount || 'No'} {itemWord} left + + ); + } + + renderFilterLink(filter) { + const title = FILTER_TITLES[filter]; + const { filter: selectedFilter, onShow } = this.props; + + return ( + onShow(filter)} + > + {title} + + ); + } + + renderClearButton() { + const { completedCount, onClearCompleted } = this.props; + if (completedCount > 0) { + return ( + + ); + } + } + + render() { + return ( +
+ {this.renderTodoCount()} +
    + {[SHOW_ALL, SHOW_ACTIVE, SHOW_COMPLETED].map((filter) => ( +
  • {this.renderFilterLink(filter)}
    • + ))} +
+ {this.renderClearButton()} +
+ ); + } +} + +Footer.propTypes = { + completedCount: PropTypes.number.isRequired, + activeCount: PropTypes.number.isRequired, + filter: PropTypes.string.isRequired, + onClearCompleted: PropTypes.func.isRequired, + onShow: PropTypes.func.isRequired, +}; + +export default Footer; diff --git a/extension/examples/router/components/Header.js b/extension/examples/router/components/Header.js new file mode 100644 index 0000000000..e09a2e2772 --- /dev/null +++ b/extension/examples/router/components/Header.js @@ -0,0 +1,30 @@ +import React, { PropTypes, Component } from 'react'; +import TodoTextInput from './TodoTextInput'; + +class Header extends Component { + handleSave(text) { + if (text.length !== 0) { + this.props.addTodo(text); + } + } + + render() { + const { path } = this.props; + return ( +
+

{path}

+ +
+ ); + } +} + +Header.propTypes = { + addTodo: PropTypes.func.isRequired, +}; + +export default Header; diff --git a/extension/examples/router/components/MainSection.js b/extension/examples/router/components/MainSection.js new file mode 100644 index 0000000000..53bd11d250 --- /dev/null +++ b/extension/examples/router/components/MainSection.js @@ -0,0 +1,94 @@ +import React, { Component, PropTypes } from 'react'; +import TodoItem from './TodoItem'; +import Footer from './Footer'; +import { + SHOW_ALL, + SHOW_COMPLETED, + SHOW_ACTIVE, +} from '../constants/TodoFilters'; + +const TODO_FILTERS = { + [SHOW_ALL]: () => true, + [SHOW_ACTIVE]: (todo) => !todo.completed, + [SHOW_COMPLETED]: (todo) => todo.completed, +}; + +class MainSection extends Component { + constructor(props, context) { + super(props, context); + this.state = { filter: SHOW_ALL }; + } + + handleClearCompleted() { + const atLeastOneCompleted = this.props.todos.some((todo) => todo.completed); + if (atLeastOneCompleted) { + this.props.actions.clearCompleted(); + } + } + + handleShow(filter) { + this.setState({ filter }); + } + + renderToggleAll(completedCount) { + const { todos, actions } = this.props; + if (todos.length > 0) { + return ( + + ); + } + } + + renderFooter(completedCount) { + const { todos } = this.props; + const { filter } = this.state; + const activeCount = todos.length - completedCount; + + if (todos.length) { + return ( +