Repository files navigation

no-pro provides CPU profiling tools for Node.js.

This repository is a mono-repo, with the following embedded packages:

• runtime

  This package is the core runtime function to generate profile data, to beadded as instrumentationn to your application.

• express-middleware

  This package provides express-compatible middleware to profile requestssent with a keyed header.

• profile-viewer

  This package provides a web app to view profiles.

This repository contains a number of independent packages rooted in thepackages directory - like alerna repo, but currentlynot actually a lerna repo. These packages are referred to below as"embedded packages".

The root directory contains apackage.json which largely just includesdevDependencies used by the embedded packages. Generally, the embeddedpackages do not containanydevDependencies.

The downside of this approach is thatdevDependencies executables are notdirectly available, when running in an embedded package's root directory.

To counter this down-side, there are some command-line tools available in thetools directory, intended to be run from the root directory of the repository,to perform actions on the embedded packages.

For more info, see thetools/README.md file.

Runningnpm install on the root directory will do annpm install in eachembedded package, via an npmpostinstall script.

Typical development flow when updating a single embedded package:

• tools/watch-one.js <embedded package> - run the watch command for anembedded project, which watches for changes, runs tests, etc.

• when you're done,npm run test to run tests for all embedded packages

On occaison, runnpm run ncu andtools/version-info.js to keep an eye ondependencies.

This package is licensed under the MIT license. See theLICENSE.md filefor more information.

Awesome! We're happy that you want to contribute.

Please read theCONTRIBUTING.md file for more information.