Skip to content

Commit

Permalink
Updated all GitHub links to point to React repo
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Vaughn committed Aug 15, 2019
1 parent a6aba5a commit db9e5c9
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#### Improved performance
The legacy DevTools extension used to add significant performance overhead, making it unusable for some larger React applications. That overhead has been effectively eliminated in version 4.

[Learn more](https://github.com/bvaughn/react-devtools-experimental/blob/master/OVERVIEW.md) about the performance optimizations that made this possible.
[Learn more](https://github.com/facebook/react/blob/master/packages/react-devtools/OVERVIEW.md) about the performance optimizations that made this possible.

#### Component stacks

Expand All @@ -43,7 +43,7 @@ Filter preferences are remembered between sessions.

#### No more in-line props

Components in the tree no longer show in-line props. This was done to [make DevTools faster](https://github.com/bvaughn/react-devtools-experimental/blob/master/OVERVIEW.md) and to make it easier to browse larger component trees.
Components in the tree no longer show in-line props. This was done to [make DevTools faster](https://github.com/facebook/react/blob/master/packages/react-devtools/OVERVIEW.md) and to make it easier to browse larger component trees.

You can view a component's props, state, and hooks by selecting it:

Expand Down
2 changes: 1 addition & 1 deletion OVERVIEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ Even when dealing with a single component, serializing deeply nested properties

Hooks present a unique challenge for the DevTools because of the concept of _custom_ hooks. (A custom hook is essentially any function that calls at least one of the built-in hooks. By convention custom hooks also have names that begin with "use".)

So how does DevTools identify custom functions called from within third party components? It does this by temporarily overriding React's built-in hooks and shallow rendering the component in question. Whenever one of the (overridden) built-in hooks are called, it parses the call stack to spot potential custom hooks (functions between the component itself and the built-in hook). This approach enables it to build a tree structure describing all of the calls to both the built-in _and_ custom hooks, along with the values passed to those hooks. (If you're interested in learning more about this, [here is the source code](https://github.com/bvaughn/react-devtools-experimental/blob/master/src/backend/ReactDebugHooks.js).)
So how does DevTools identify custom functions called from within third party components? It does this by temporarily overriding React's built-in hooks and shallow rendering the component in question. Whenever one of the (overridden) built-in hooks are called, it parses the call stack to spot potential custom hooks (functions between the component itself and the built-in hook). This approach enables it to build a tree structure describing all of the calls to both the built-in _and_ custom hooks, along with the values passed to those hooks. (If you're interested in learning more about this, [here is the source code](https://github.com/facebook/react/blob/master/packages/react-debug-tools/src/ReactDebugHooks.js).)

> **Note**: DevTools obtains hooks info by re-rendering a component.
> Breakpoints will be invoked during this additional (shallow) render,
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ yarn build:extension:firefox # builds at "shells/browser/firefox/build"

# Support

As this extension is in a beta period, it is not officially supported. However if you find a bug, we'd appreciate you reporting it as a [GitHub issue](https://github.com/bvaughn/react-devtools-experimental/issues/new) with repro instructions.
As this extension is in a beta period, it is not officially supported. However if you find a bug, we'd appreciate you reporting it as a [GitHub issue](https://github.com/facebook/react/issues/new?labels=Component:%20Developer%20Tools) with repro instructions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"build:extension:firefox:dev": "cross-env NODE_ENV=development node ./shells/browser/firefox/build",
"build:standalone": "cd packages/react-devtools-core && yarn run build",
"deploy": "yarn run deploy:demo && yarn run deploy:chrome && yarn run deploy:firefox",
"deploy:demo": "yarn run build:demo && cd shells/dev/ && now deploy && now alias react-devtools-experimental",
"deploy:demo": "yarn run build:inline && yarn run build:demo && cd shells/dev/ && now deploy && now alias react-devtools-experimental",
"deploy:chrome": "node ./shells/browser/chrome/deploy",
"deploy:firefox": "node ./shells/browser/firefox/deploy",
"linc": "lint-staged",
Expand Down
2 changes: 1 addition & 1 deletion packages/react-devtools-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "MIT",
"main": "./dist/backend.js",
"repository": {
"url": "https://github.com/bvaughn/react-devtools-experimental.git",
"url": "https://github.com/facebook/react.git",
"type": "git"
},
"files": [
Expand Down
2 changes: 1 addition & 1 deletion packages/react-devtools-inline/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "MIT",
"main": "./dist/backend.js",
"repository": {
"url": "https://github.com/bvaughn/react-devtools-experimental.git",
"url": "https://github.com/facebook/react.git",
"type": "git"
},
"files": [
Expand Down
2 changes: 1 addition & 1 deletion packages/react-devtools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Use react-devtools outside of the browser",
"license": "MIT",
"repository": {
"url": "https://github.com/bvaughn/react-devtools-experimental.git",
"url": "https://github.com/facebook/react.git",
"type": "git"
},
"bin": {
Expand Down
7 changes: 3 additions & 4 deletions shells/browser/shared/deploy.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,11 @@ <h1>

<h3>
Created on <strong>%date%</strong> from
<a href="http://github.com/bvaughn/react-devtools-experimental/commit/%commit%"><code>%commit%</code></a>
<a href="http://github.com/facebook/react/commit/%commit%"><code>%commit%</code></a>
</h3>

<p>
This is a preview build of an <a href="https://github.com/bvaughn/react-devtools-experimental">unreleased DevTools extension</a>.
It has no developer support.
This is a preview build of the <a href="https://github.com/facebook/react">React DevTools extension</a>.
</p>

<h2>Installation instructions</h2>
Expand All @@ -34,7 +33,7 @@ <h2>Installation instructions</h2>

<h2>Bug reports</h2>
<p>
Please report bugs as <a href="https://github.com/bvaughn/react-devtools-experimental/issues/new?labels=bug">GitHub issues</a>.
Please report bugs as <a href="https://github.com/facebook/react/issues/new?labels=Component:%20Developer%20Tools">GitHub issues</a>.
Please include all of the info required to reproduce the bug (e.g. links, code, instructions).
</p>

Expand Down
8 changes: 7 additions & 1 deletion shells/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ function getGitCommit() {
}

function getGitHubURL() {
// TODO potentially replace this with an fb.me URL (assuming it can forward the query params)
// HACK We are in the middle of migrating;
// For now, forcefully direct people to the new repository-
// even though we may be deploying from the old repo.
return 'https://github.com/facebook/react';

/* TODO potentially replace this with an fb.me URL (assuming it can forward the query params)
const url = execSync('git remote get-url origin')
.toString()
.trim();
Expand All @@ -22,6 +27,7 @@ function getGitHubURL() {
.replace('git@', 'https://')
.replace('.git', '');
}
*/
}

function getVersionString() {
Expand Down
2 changes: 1 addition & 1 deletion src/constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const LOCAL_STORAGE_SHOULD_PATCH_CONSOLE_KEY =
export const PROFILER_EXPORT_VERSION = 4;

export const CHANGE_LOG_URL =
'https://github.com/bvaughn/react-devtools-experimental/blob/master/CHANGELOG.md';
'https://github.com/facebook/react/blob/master/packages/react-devtools/CHANGELOG.md';

// HACK
//
Expand Down
2 changes: 1 addition & 1 deletion src/devtools/views/ErrorBoundary.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export default class ErrorBoundary extends Component<Props, State> {
let bugURL = process.env.GITHUB_URL;
if (bugURL) {
const title = `Error: "${errorMessage || ''}"`;
const label = '😭 bug';
const label = 'Component: Developer Tools';

let body = '<!-- please provide repro information here -->\n';
body += '\n---------------------------------------------';
Expand Down

0 comments on commit db9e5c9

Please sign in to comment.