#92 (all)
JavaScript (change)
84 seconds
over 2 years ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
module.exports.isConfigFile in /lib/Utility.js E
A
isComplete in /lib/completion.js E
A
module.exports.packageNameToModuleName in /lib/Utility.js E
A
ReverseInteract.introduceToKeymetrics in /lib/Interactor/ReverseInteractor.js E
A
module.exports.startPoolingWorker in /lib/Interactor/PushInteractor.js E
Show 121 more ...
Proper documentation present
B
InteractorDaemonizer.getInteractInfo in /lib/Interactor/InteractorDaemonizer.js E
B
InteractorDaemonizer.launchRPC in /lib/Interactor/InteractorDaemonizer.js E
B
God.sendSignalToProcessName in /lib/God/ActionMethods.js E
B
InteractorDaemonizer.ping in /lib/Interactor/InteractorDaemonizer.js E
B
God.sendSignalToProcessId in /lib/God/ActionMethods.js E
B
Satan.getExposedMethods in /lib/Satan.js E
B
God.restartProcessName in /lib/God/ActionMethods.js E
B
God.duplicateProcessId in /lib/God/ActionMethods.js E
B
God.dumpProcessList in /lib/God/ActionMethods.js E
B
Satan.executeRemote in /lib/Satan.js E
B
God.deleteProcessId in /lib/God/ActionMethods.js E
B
God.getMonitorData in /lib/God/ActionMethods.js E
B
Satan.restartWatch in /lib/Satan.js E
B
God.startProcessId in /lib/God/ActionMethods.js E
B
God.findByFullPath in /lib/God/Methods.js E
B
Satan.launchDaemon in /lib/Satan.js E
B
God.stopProcessId in /lib/God/ActionMethods.js E
B
God.getSystemData in /lib/God/ActionMethods.js E
B
God.restartWatch in /lib/God/ActionMethods.js E
B
Satan.pingDaemon in /lib/Satan.js E
B
Satan.killDaemon in /lib/Satan.js E
B
God.killProcess in /lib/God/Methods.js E
B
Satan.stopWatch in /lib/Satan.js E
B
God.reloadLogs in /lib/God/ActionMethods.js E
B
God.findByPort in /lib/God/Methods.js E
B
God.msgProcess in /lib/God/ActionMethods.js E
B
God.getVersion in /lib/God/ActionMethods.js E
B
God.executeApp in /lib/God.js E
B
God.stopWatch in /lib/God/ActionMethods.js E
B
God.forkMode in /lib/God/ForkMode.js E
B
Satan.start in /lib/Satan.js E
B
God.nodeApp in /lib/God/ClusterMode.js E
B
softReload in /lib/God/Reload.js E
B
hardReload in /lib/God/Reload.js E
B
God.ping in /lib/God/ActionMethods.js E
B
Methods.pullCommitId in /lib/tools/VersionManagement.js E
B
God.softReloadProcessId in /lib/God/Reload.js E
B
God.restartProcessId in /lib/God/ActionMethods.js E
B
God.reloadProcessId in /lib/God/Reload.js E
B
God.processIsDead in /lib/God/Methods.js E
B
Methods.backward in /lib/tools/VersionManagement.js E
B
Methods.forward in /lib/tools/VersionManagement.js E
B
launchOrAttach in /lib/Interactor/InteractorDaemonizer.js E
B
God.killMe in /lib/God/ActionMethods.js E
B
InteractorDaemonizer.getSetKeys in /lib/Interactor/InteractorDaemonizer.js E
B
Modularizer.uninstall in /lib/Modularizer.js E
B
Satan.disconnectRPC in /lib/Satan.js E
B
Modularizer.publish in /lib/Modularizer.js E
B
Satan.launchRPC in /lib/Satan.js E
B
God.forceGc in /lib/God/Methods.js E
B
God.prepare in /lib/God.js E
B
script in /lib/completion.js E
B
Satan.processStateHandler in /lib/Satan.js E
B
God.logAndGenerateError in /lib/God/Methods.js E
B
crossPlatformGroupKill in /lib/God/Methods.js E
B
God.finalizeProcedure in /lib/God.js E
B
Common.prepareAppConf in /lib/Common.js E
B
Config.transCMDToConf in /lib/tools/Config.js E
B
Cipher.cipherMessage in /lib/Interactor/Cipher.js E
B
Config.validateJSON in /lib/tools/Config.js E
B
God.findProcessById in /lib/God/Methods.js E
B
Common.printError in /lib/Common.js E
B
Monit.updateBars in /lib/Monit.js E
B
UX.describeTable in /lib/CLI/CliUx.js E
B
Monit.updateBars in /lib/CLI/Monit.js E
B
God.checkProcess in /lib/God/Methods.js E
B
Monit.drawRatio in /lib/Monit.js E
B
Monit.drawRatio in /lib/CLI/Monit.js E
B
module.exports in /lib/God/Reload.js E
B
module.exports in /lib/God/Methods.js E
B
UX.dispAsTable in /lib/CLI/CliUx.js E
B
God.resetState in /lib/God/Methods.js E
B
module.exports in /lib/God/ForkMode.js E
B
module.exports in /lib/God/ActionMethods.js E
B
Common.exitCli in /lib/Common.js E
B
UX.bytesToSize in /lib/CLI/CliUx.js E
B
God.findByName in /lib/God/Methods.js E
B
UX.miniDisplay in /lib/CLI/CliUx.js E
B
module.exports in /lib/God/ClusterMode.js E
B
Monit.refresh in /lib/CLI/Monit.js E
B
Monit.refresh in /lib/Monit.js E
B
colorStatus in /lib/CLI/CliUx.js E
B
Monit.reset in /lib/Monit.js E
B
Monit.reset in /lib/CLI/Monit.js E
B
timeSince in /lib/CLI/CliUx.js E
B
Log.tail in /lib/CLI/Log.js E
B
exec in /lib/ProcessContainer.js E
B
God.handleExit in /lib/God.js E
B
Cipher.decipherMessage in /lib/Interactor/Cipher.js E
B
Log.stream in /lib/CLI/Log.js E
B
Common.sink.resolveInterpreter in /lib/Common.js E
B
Common.sink.determineExecMode in /lib/Common.js E
B
Common.safeExtend in /lib/Common.js E
B
setupConnection in /lib/Interactor/PushInteractor.js E
B
JSON5.stringify in /lib/tools/json5.js E
B
module.exports in /lib/Interactor/pm2-interface.js E
B
Common.extend in /lib/Common.js E
B
safeDeepClone in /lib/tools/safeclonedeep.js E
B
Object.size in /lib/Monit.js E
B
Object.size in /lib/CLI/Monit.js E
B
parseTasks in /lib/completion.js E
B
cloneWrap in /lib/tools/safeclonedeep.js E
B
cronize in /lib/ProcessContainer.js E
Please take a look
Undocumented
U
InteractorDaemonizer.launchAndInteract in /lib/Interactor/InteractorDaemonizer.js E
U
InteractorDaemonizer.disconnectRPC in /lib/Interactor/InteractorDaemonizer.js E
U
InteractorDaemonizer.killDaemon in /lib/Interactor/InteractorDaemonizer.js E
U
InteractorDaemonizer.daemonize in /lib/Interactor/InteractorDaemonizer.js E
U
InteractorDaemonizer.update in /lib/Interactor/InteractorDaemonizer.js E
Show 128 more ...

Let's raise the visibility of documentation in Open Source!

This page is for Unitech/pm2 and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.