corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1905946 - Update new tab documentation to clarify watchmc usage r=home-newtab-reviewers,mconley DONTBUILD

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D240216
This commit is contained in:
Maxx Crawford
2025-03-03 21:46:52 +00:00
parent 8ab578c1d6
commit 6f1e2fc5b7
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
browser/extensions/newtab/docs/index.rst
View File

@@ -51,11 +51,18 @@ To build assets and run Firefox, run the following from the root of the mozilla-
Continuous development / debugging
----------------------------------
Running ``./mach npm run watchmc --prefix=browser/extensions/newtab`` will start a process that watches files in
``activity-stream`` and rebuilds the bundled files when JS or CSS files change.
**IMPORTANT NOTE**: This task will add inline source maps to help with debugging, which changes the memory footprint.
Do not use the ``watchmc`` task for profiling or performance testing!
For near real-time reloading, run the following commands in separate terminals to automatically rebuild bundled files whenever JSX or SCSS files change. After making a change, `restart your local instance </devtools-user/browser_console/index.html#controlling-the-browser>`_ to apply the updates.
.. code-block:: shell
./mach npm run watchmc --prefix=browser/extensions/newtab
./mach run
./mach watch
**IMPORTANT NOTE**: This task will add inline source maps to help with debugging, which changes the memory footprint. Do not use the ``watchmc`` task for profiling or performance testing! After finalizing your changes, be sure to run `the bundle command <./index.html#building-assets-and-running-firefox>`_ again before committing to remove the inline source maps.
Running tests
-------------