actionCreators in each of the files are setup
so the actions can be called directly from the component.
-#[Reducers](https://github.com/devtools-html/debugger.html/tree/master/public/js/reducers)
+#[Reducers](https://github.com/devtools-html/debugger.html/tree/master/src/reducers)
-The [Reducers](https://github.com/devtools-html/debugger.html/tree/master/public/js/reducers) are all located in the public/js/reducers folder and are
+The [Reducers](https://github.com/devtools-html/debugger.html/tree/master/src/reducers) are all located in the src/reducers folder and are
all combined using Redux’s combineReducters() function. This function is
executed in main.js as follows:
@@ -243,7 +243,7 @@ The following action types are handled:
removing a breakpoint. If the breakpoint is being disabled the
disabled attribute of the breakpoint is set to false. If
the breakpoint is removed it is deleted from the breakpoints state.
-
+
The breakpoints reducer additionally supplies functions to
retrieve information from the breakpoints state. For example the
@@ -431,10 +431,10 @@ The tabs reducer handles the following action types:
- SELECT\_TAB – This action type is triggered when a specific
application is selected for debugging.
-#[Actions](https://github.com/devtools-html/debugger.html/tree/master/public/js/actions)
+#[Actions](https://github.com/devtools-html/debugger.html/tree/master/src/actions)
-The [actions](https://github.com/devtools-html/debugger.html/tree/master/public/js/actions) in debugger.html are all located in the
-public/js/actions folder; there is an action file corresponding to
+The [actions](https://github.com/devtools-html/debugger.html/tree/master/src/actions) in debugger.html are all located in the
+src/actions folder; there is an action file corresponding to
each reducer, which is responsible for dispatching the
proper event when the application state needs to be modified. In this
section we will cover each action file. As stated earlier, many of the
@@ -497,7 +497,7 @@ The event-listeners file exports the following functions:
currently have listeners bound for the application being debugged.
Once retrieved the fetchEventListeners() function dispatches the
FETCH\_EVENT\_LISTENERS action.
-
+
##pause
The **pause** action file handles all functions responsible for
@@ -505,8 +505,8 @@ pausing, resuming and manipulating the debugger by stepping through
code. The functions contained in this file handle several calls back and
forth with the connected client (Firefox, Chrome, Node). Most of the
client functions are defined in the
-public/js/clients/specificclient/events.js and
-public/js/clients/specificclient/commands.js files. The pause action
+src/clients/specificclient/events.js and
+src/clients/specificclient/commands.js files. The pause action
file exports the following functions:
- addExpression() – Called from the
@@ -543,7 +543,7 @@ file exports the following functions:
RightSideBar component. This is a generic function that sends
different commands to the connected client. After the command is
executed the COMMAND action is dispatched. The client commands are
- defined in the public/js/clients/specificclient/commands.js file.
+ defined in the src/clients/specificclient/commands.js file.
- stepIn() – This function is called from the RightSideBar. This
function calls the command() function to pass it
@@ -565,7 +565,7 @@ file exports the following functions:
pause button is pressed and the debugger is currently not paused.
This function calls the connected clients breakOnNext() function,
which is defined in the
- public/js/clients/specificclient/commands.js file. After returning
+ src/clients/specificclient/commands.js file. After returning
from the client call the BREAK\_ON\_NEXT action is dispatched.
- selectFrame() – This function is called from the Frames component when
@@ -581,8 +581,8 @@ file exports the following functions:
the variable tree is expanded. The function calls the connected
client to retrieve the values and dispatches the
LOAD\_OBJECT\_PROPERTIES action.
-
-
+
+
##sources
The **sources** action is responsible for providing functions that
@@ -591,7 +591,7 @@ editor and supplying black box and pretty print functionality. The sources
action file exports the following functions:
- newSource() – This function is called from the connected
- client as defined in public/js/clients/specificclient/events.js when
+ client as defined in src/clients/specificclient/events.js when
a project is loaded. In addition newSource() is called whenever a
source map is loaded to add it to the project. This function checks
to see if a source map needs to be loaded and if so dispatches the
@@ -612,7 +612,7 @@ action file exports the following functions:
promise completes and the text is loaded.
- selectSourceURL() – Currently this function is only exposed in the
- public/js/main.js file to external clients. The function first
+ src/main.js file to external clients. The function first
dispatches a SELECT\_SOURCE action and then dispatches the
SELECT\_SOURCE\_URL action. As stated above the text is loaded with
the selectSource() function.
@@ -634,7 +634,7 @@ action file exports the following functions:
adds the new file to the project. Next, the function dispatches a
TOGGLE\_PRETTY\_PRINT action, which contains a promise that starts a
Worker thread to transform the source. The worker is defined
- in public/build/pretty-print-worker.js. The selectSource() function is then
+ in assets/build/pretty-print-worker.js. The selectSource() function is then
called to select the new source.
- loadSourceText() – This function is called whenever a source is
@@ -654,22 +654,20 @@ action file exports the following functions:
- getTextForSources() – This function takes a set of source files and
calls loadSourceText() to load each file. Currently this function is
not used in debugger.html.
-
+
##tabs
The **tabs** action is responsible for gathering all connected
clients that can be debugged, and gathering the tabs for each application that can be debugged on the connected client. The tabs action
file exports the following functions:
-- newTabs() – This function is called from public/js/main.js and sets
+- newTabs() – This function is called from src/main.js and sets
the action type to ADD\_TABS. The action is dispatched from the
- public/js/main.js when debugger.html is loading and displaying
+ src/main.js when debugger.html is loading and displaying
the main page or when starting to debug when a specific tab
is selected.
-- selectTab() – This function is called from public/js/main.js when a
+- selectTab() – This function is called from src/main.js when a
user has selected a specific tab from a connected application
to debug. It sets the action type to SELECT\_TAB and the action is
- then dispatched in public/js/main.js.
-
-
+ then dispatched in src/main.js.
diff --git a/docs/local-development.md b/docs/local-development.md
index 50983c61ba..3773edaa79 100644
--- a/docs/local-development.md
+++ b/docs/local-development.md
@@ -57,7 +57,7 @@ The Debugger supports two types of internationalization RTL (right to left) layo
**L10N**
-[L10N](https://github.com/devtools-html/debugger.html/blob/master/packages/devtools-local-toolbox/public/js/utils/L10N.js) is a global module with two methods `getStr` and `getFormatStr`.
+[L10N](https://github.com/devtools-html/debugger.html/blob/master/packages/devtools-local-toolbox/src/utils/L10N.js) is a global module with two methods `getStr` and `getFormatStr`.
```js
L10N.getStr("scopes.header")
@@ -91,7 +91,7 @@ html[dir="rtl"] .source-footer .command-bar {
}
```
-Translated strings are added to the local [strings](https://github.com/devtools-html/debugger.html/blob/master/public/js/strings.json)
+Translated strings are added to the local [strings](https://github.com/devtools-html/debugger.html/blob/master/src/strings.json)
file and m-c [debugger properties](https://dxr.mozilla.org/mozilla-central/source/devtools/client/locales/en-US/debugger.properties) file.
### Flow
@@ -129,6 +129,6 @@ Storybook is a local development environment for react components for viewing co
**Getting Started:**
* install storybook `npm i -g @kadira/storybook`
+ start storybook `npm run storybook`
-+ edit a component story in `public/js/components/stories`
++ edit a component story in `src/components/stories`
diff --git a/docs/mochitests.md b/docs/mochitests.md
index 6b9b7f2d91..112d51a28c 100644
--- a/docs/mochitests.md
+++ b/docs/mochitests.md
@@ -2,7 +2,7 @@ We use [mochitests](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Mo
Mochitests require a local checkout of the Firefox source code. This is because they are used to test a lot of Firefox, and you would usually run them inside Firefox. We are developing the debugger outside of Firefox, but still want to test it as a devtools panel, so we've figured out a way to use them. It may not be elegant, but it allows us to ensure a high quality Firefox debugger.
-Mochitests live in `public/js/test/mochitest`.
+Mochitests live in `src/test/mochitest`.
## Getting Started
@@ -28,7 +28,7 @@ cd firefox
./mach mochitest --subsuite devtools devtools/client/debugger/new/test/mochitest/
```
-This works because we've symlinked the local mochitests into where the debugger lives in Firefox. Any changes to the tests in `public/js/test/mochitest` will be reflected and you can re-run the tests.
+This works because we've symlinked the local mochitests into where the debugger lives in Firefox. Any changes to the tests in `src/test/mochitest` will be reflected and you can re-run the tests.
Visit the [mochitest](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Mochitest) MDN page to learn more about mochitests and more advanced arguments. A few tips:
diff --git a/docs/reference/index.html b/docs/reference/index.html
index a116c5e499..c2556d2acd 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -64,33 +64,6 @@
-
-
-
-
-
- Source Map Worker
- - -Sets the source map's sourceRoot to be relative to the source map url.
- - -(Any)
- (Any)
- (Any)
- UI reducer
- - -Utils for Sources Tree Component
+Utils for working with Source URLs
-Trims the query part or reference identifier of a url string, if necessary.
-(Any)
- string
+
+
@@ -2541,11 +2391,11 @@ Returns true if the specified url and/or content type are specific to +javascript files.
-([Any]
- (default {})
+ contentType ([string]
+ (default "")
)
Any:
+ boolean
+True if the source is likely javascript.
+
+
+
+
@@ -2606,11 +2467,11 @@ Show a source url's filename. +If the source does not have a url, use the source id.
-(Any)
- (Any)
+ source (Source)
Utils for keyboard command strings
+Utils for mochitest
-Utils for working with Source URLs
- - -Trims the query part or reference identifier of a url string, if necessary.
- - - +([Any]
+ (default {})
+ )
string
-
-
@@ -2945,11 +2701,11 @@ Returns true if the specified url and/or content type are specific to -javascript files.
- + - +([string]
- (default "")
+ data ([Any]
+ (default {})
)
Any:
- boolean
-True if the source is likely javascript.
-
-
-
-
@@ -3021,11 +2766,11 @@ Show a source url's filename. -If the source does not have a url, use the source id.
- + -(Source)
+ store (Any)
+ (Any)
Immutable JS conversion utils
+Utils for keyboard command strings
-When our app state is fully typed, we should be able to get rid of -this function. This is only temporarily necessary to support -converting typed objects to immutable.js, which usually happens in -reducers.
- + -(Any)
- Any
+ string
@@ -3271,17 +3009,17 @@ This object provides the public module functions.
+Source Map Worker
-Creates and starts a new task.
+Sets the source map's sourceRoot to be relative to the source map url.
-(Any) A generator function
-
+ sourceMap (Any)
+ (Any)
+ (Any)
Any:
- A promise, resolved when the task terminates
-
-
-
-
@@ -3387,20 +3130,61 @@ When Flow 0.29 is released (very soon), we can use this Record type -instead of the builtin immutable.js Record type. This is better -because all the fields are actually typed, unlike the builtin one. -This depends on a performance fix that will go out in 0.29 though;
+UI reducer
-Immutable JS conversion utils
+ + +When our app state is fully typed, we should be able to get rid of +this function. This is only temporarily necessary to support +converting typed objects to immutable.js, which usually happens in +reducers.
-(Any)
+ Any
+
+
@@ -3468,11 +3273,61 @@ This object provides the public module functions.
+ + +Make an immutable record type
+Creates and starts a new task.
-(Any) the keys and their default values
+ task (Any) A generator function
Any:
- a state record factory function
+ A promise, resolved when the task terminates
@@ -3784,17 +3639,20 @@ Redux actions for breakpoints
+When Flow 0.29 is released (very soon), we can use this Record type +instead of the builtin immutable.js Record type. This is better +because all the fields are actually typed, unlike the builtin one. +This depends on a performance fix that will go out in 0.29 though;
-Argument parameters via Thunk middleware for Redux Thunk
- + -Enabling a breakpoint calls addBreakpoint -which will reuse the existing breakpoint information that is stored.
+Make an immutable record type
-Any:
+ a state record factory function
+
+
+
+
@@ -3921,8 +3786,161 @@ Redux actions for breakpoints
+ + +Argument parameters via Thunk middleware for Redux Thunk
+ + +Enabling a breakpoint calls addBreakpoint +which will reuse the existing breakpoint information that is stored.
+ + +(Location)
+ Update the condition of a breakpoint. -NOT IMPLEMENTED
+Update the condition of a breakpoint.
- + @@ -4233,6 +4250,43 @@(Object
+ (default {})
+ )
+ | Name | +Description | +
|---|---|
$1.condition Any
+ |
+ + |
$1.getTextForLine Any
+ |
+ + |
Redux actions for the event listeners state
+Redux actions for the sources state
-Handler for the debugger client's unsolicited newSource notification.
-(Source)
+ Deterministically select a source that has a given URL. This will +work regardless of the connection status or if the source exists +yet. This exists mostly for external things to interact with the +debugger.
- -Redux actions for the sources state
- - -(string)
+ ([SelectSourceOptions]
+ (default {})
+ )
+ Handler for the debugger client's unsolicited newSource notification.
- + -([SelectSourceOptions]
+ (default {})
+ )
Deterministically select a source that has a given URL. This will -work regardless of the connection status or if the source exists -yet. This exists mostly for external things to interact with the -debugger.
+Toggle the pretty printing of a source's text. All subsequent calls to +|getText| will return the pretty-toggled text. Nothing will happen for +non-javascript files.
-Any:
+ Promise
+A promise that resolves to
+[aSource, prettyText]
+ or rejects to
+
+[aSource, error]
+.
+
+
+
+
@@ -4644,11 +4750,11 @@ Starts fetching all the sources, silently.
+ + +([SelectSourceOptions]
- (default {})
- )
+ array (Any) actors
+The urls for the sources to fetch. If fetching a source's text
+takes too long, it will be discarded.
+
+ (Any)
Promise:
+ A promise that is resolved after source texts have been fetched.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Redux actions for the event listeners state
+ + +Toggle the pretty printing of a source's text. All subsequent calls to -|getText| will return the pretty-toggled text. Nothing will happen for -non-javascript files.
- - -(Any) id The source form from the RDP.
+
- (string)
- Any:
- Promise
-A promise that resolves to
-[aSource, prettyText]
- or rejects to
+ Redux store utils
+ + +Starts fetching all the sources, silently.
+This creates a dispatcher with all the standard middleware in place +that all code requires. It can also be optionally configured in +various ways, such as logging and recording.
-(Any) actors
-The urls for the sources to fetch. If fetching a source's text
-takes too long, it will be discarded.
+ opts ([object](default {})) :
+ - log: log all dispatched actions to console
+ - history: an array to store every action in. Should only be
+ used in tests.
+ - middleware: array of middleware to be included in the redux store
+(Any)
- Promise:
- A promise that is resolved after source texts have been fetched.
-
-
-
-
@@ -5888,20 +6130,17 @@ These functions implement search within the debugger. Since -search in the debugger is different from other components, -we can't use search.js CodeMirror addon. This is a slightly -modified version of that addon. Depends on searchcursor.js.
+Redux actions for the navigation state
-These functions implement search within the debugger. Since +search in the debugger is different from other components, +we can't use search.js CodeMirror addon. This is a slightly +modified version of that addon. Depends on searchcursor.js.
+ + +(Any)
- (Any)
- (Any)
- If there's a saved search, selects the next results. -Otherwise, creates a new search and selects the first -result.
- + -(Any)
- (Any)
- (Any)
+ cm (Any)
Selects the next result of a saved search.
- + -(Any)
+ cm (Any)
(Any)
+ query (Any)
+ (Any)
Clears the currently saved search.
+Ignore doing outline matches for less than 3 whitespaces
-(Any)
+ str (Any)
Starts a new search.
+This returns a mode object used by CoeMirror's addOverlay function +to parse and style tokens in the file. +The mode object contains a tokenizer function (token) which takes +a character stream as input, advances it past a token, and returns +a style for that token. For more details see +https://codemirror.net/doc/manual.html#modeapi
-(Any)
- (Any)
@@ -6353,11 +6594,11 @@ Finds the next item based on the currently saved search.
- + -(Any)
+ cm (Any)
+ (Any)
Finds the previous item based on the currently saved search.
+If there's a saved search, selects the next results. +Otherwise, creates a new search and selects the first +result.
-(Any)
+ (Any)
@@ -6481,61 +6737,11 @@ Redux store utils
- - -Selects the next result of a saved search.
-This creates a dispatcher with all the standard middleware in place -that all code requires. It can also be optionally configured in -various ways, such as logging and recording.
+Clears the currently saved search.
-([object](default {})) :
- - log: log all dispatched actions to console
- - history: an array to store every action in. Should only be
- used in tests.
- - middleware: array of middleware to be included in the redux store
-(Any)
Redux actions for the navigation state
+Starts a new search.
-(Any)
+ (Any)
+ Finds the next item based on the currently saved search.
-(Any)
+ (Any)
+