ndb README

The project's README from github.com/GoogleChromeLabs/ndb. As one markdown file: README.md.

ndb

Build Status NPM ndb package

ndb is an improved debugging experience for Node.js, enabled by Chrome DevTools

Installation

Compatibility: ndb requires Node >=8.0.0. It works best with Node >=10.

Installation: ndb depends on Puppeteer which downloads a recent version of Chromium (~170MB Mac, ~280MB Linux, ~280MB Win).

# global install with npm:
npm install -g ndb


# alternatively, with yarn:
yarn global add ndb

Global installation may fail with different permission errors, you can find help in this thread.

Windows users: Installation may fail on Windows during compilation the native dependencies. The following command may help: npm install -g windows-build-tools

Local install

If you want ndb available from an npm script (eg. npm run debug runs ndb index.js), you can install it as a development dependency:

# local install with npm:
npm install --save-dev ndb


# alternatively, with yarn:
yarn add ndb --dev

You can then set up an npm script. In this case, ndb will not be available in your system path.

Getting Started

You can start debugging your Node.js application using one of the following ways:

ndb server.js

# Alternatively, you can prepend `ndb`
ndb node server.js

# If you use some other binary, just prepend `ndb`
## npm run unit
ndb npm run unit

# Debug any globally installed package
## mocha
ndb mocha

# To use a local binary, use `npx` and prepend before it
ndb npx mocha

# cd to your project folder (with a package.json)
ndb .
# In Sources panel > "NPM Scripts" sidebar, click the selected "Run" button 

ndb --prof npm run unit

What can I do?

ndb has some powerful features exclusively for Node.js:

  1. Child processes are detected and attached to.
  2. You can place breakpoints before the modules are required.
  3. You can edit your files within the UI. On Ctrl-S/Cmd-S, DevTools will save the changes to disk.
  4. By default, ndb blackboxes all scripts outside current working directory to improve focus. This includes node internal libraries (like _stream_wrap.js, async_hooks.js, fs.js) This behaviour may be changed by "Blackbox anything outside working dir" setting.

In addition, you can use all the DevTools functionality that you've used in typical Node debugging:

Screenshot

image

Contributing

Check out contributing guide to get an overview of ndb development.

Thanks to the 'OG' ndb

In early 2011, @smtlaissezfaire released the first serious debugger for Node.js, under the ndb package name. It's still preserved at github.com/smtlaissezfaire/ndb. We thank Scott for generously donating the package name.

ndb (GoogleChromeLabs/ndb)

Searching Database…

10.9K ·GitHub
Ndb
archived
Что это такое?ndb — это улучшенный инструмент отладки для Node.js, построенный на основе Chrome DevTools: вы отлаживаете свои приложения в привычном интерфейсе DevTools, а вдобавок получаете функции, сделанные специально для Node.
Так это отладчик только для терминала или у него есть графический интерфейс?Это графический отладчик, а не терминальный: ndb открывает интерфейс Chrome DevTools как отдельное настольное приложение. Его можно запустить сам по себе, и в него даже встроен терминал для запуска команд node, которые подключаются автоматически.
Как его установить и сколько он весит?Установите его глобально через npm (npm install -g @ndbjs/ndb). Требуется Node >=8.0.0, а лучше всего работает на Node >=10. Будьте готовы к большой загрузке: Puppeteer подтягивает Chromium (около 170 МБ на Mac и около 280 МБ на Linux и Windows).
Есть ли известные проблемы при установке?Да, пара штук. Глобальная установка может завершиться ошибкой из-за прав доступа, а на Windows сборка может упасть при компиляции нативных зависимостей — обычно помогает команда npm install -g windows-build-tools.
ndb ещё поддерживается?Нет. Репозиторий на GitHub заархивирован, поэтому он доступен только для чтения и больше не получает обновлений и исправлений ошибок. Установить и пользоваться им по-прежнему можно, но с самыми новыми версиями Node возможны проблемы.
Почему он называется ndb?У этого имени есть история: в начале 2011 года @smtlaissezfaire выпустил первый серьёзный отладчик для Node.js под именем ndb. Команда Google поблагодарила его за то, что он отдал это имя, а исходный проект сохранён на github.com/smtlaissezfaire/ndb.
What are similar projects?node-inspector, electron, claude-devtools, eruda, vConsole, LightTable, proxypin, chrome-devtools-mcp
Which topics is it in?debugger, chromium, chrome, devtools, npm-package, debugging, deprecated, gui, free, desktop-app, npm, terminal
Creator
GoogleChromeLabs
Size
0.7 MB
Stars
10.9K
Updated
CommitSep 12
Age
8y
Commits · 90 Days