#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
A
module.exports.axmCustomActions in /lib/Interactor/RemoteActions/CustomActions.js E
A
module.exports.connectRemote in /lib/Interactor/PushInteractor.js E
A
module.exports.parseConfig in /lib/Utility.js E
A
module.exports.pm2Actions in /lib/Interactor/RemoteActions/Pm2Actions.js E
A
ReverseInteract.onMessage in /lib/Interactor/ReverseInteractor.js E
A
God.getFormatedProcesses in /lib/God/Methods.js E
A
Modularizer.listModules in /lib/Modularizer.js E
A
sendSignalToProcessName in /lib/God/ActionMethods.js E
A
module.exports.sendData in /lib/Interactor/PushInteractor.js E
A
module.exports.sendFile in /lib/Interactor/PushInteractor.js E
A
crossPlatformGroupKill in /lib/God/Methods.js E
A
sendSignalToProcessId in /lib/God/ActionMethods.js E
A
getFormatedProcesses in /lib/God/Methods.js E
A
God.watch.disableAll in /lib/Watcher.js E
A
module.exports.start in /lib/Interactor/PushInteractor.js E
A
logAndGenerateError in /lib/God/Methods.js E
A
softReloadProcessId in /lib/God/Reload.js E
A
Satan.remoteWrapper in /lib/Satan.js E
A
processStateHandler in /lib/Satan.js E
A
restartProcessName in /lib/God/ActionMethods.js E
A
duplicateProcessId in /lib/God/ActionMethods.js E
A
getPostUpdateCmds in /lib/tools/VersionManagement.js E
A
finalizeProcedure in /lib/God.js E
A
God.notifyKillPM2 in /lib/God/ActionMethods.js E
A
getExposedMethods in /lib/Satan.js E
A
getPostUpdateCmds in /lib/tools/VersionManagement.js E
A
restartProcessId in /lib/God/ActionMethods.js E
A
God.getProcesses in /lib/God/Methods.js E
A
findProcessById in /lib/God/Methods.js E
A
generateMethods in /lib/Interactor/InteractorDaemonizer.js E
A
dumpProcessList in /lib/God/ActionMethods.js E
A
decipherMessage in /lib/Interactor/Cipher.js E
A
reloadProcessId in /lib/God/Reload.js E
A
Common.printOut in /lib/Common.js E
A
getInteractInfo in /lib/Interactor/InteractorDaemonizer.js E
A
deleteProcessId in /lib/God/ActionMethods.js E
A
getMonitorData in /lib/God/ActionMethods.js E
A
startProcessId in /lib/God/ActionMethods.js E
A
launchOrAttach in /lib/Interactor/InteractorDaemonizer.js E
A
findByFullPath in /lib/God/Methods.js E
A
prepareAppConf in /lib/Common.js E
A
stopProcessId in /lib/God/ActionMethods.js E
A
executeRemote in /lib/Satan.js E
A
gracefullExit in /lib/Satan.js E
A
processIsDead in /lib/God/Methods.js E
A
remoteWrapper in /lib/Satan.js E
A
getSystemData in /lib/God/ActionMethods.js E
A
cipherMessage in /lib/Interactor/Cipher.js E
A
StaticSpinner in /lib/CLI/Spinner.js E
A
notifyKillPM2 in /lib/God/ActionMethods.js E
A
describeTable in /lib/CLI/CliUx.js E
A
execCommands in /lib/tools/VersionManagement.js E
A
restartWatch in /lib/God/ActionMethods.js E
A
execCommands in /lib/tools/VersionManagement.js E
A
checkProcess in /lib/God/Methods.js E
A
startLogging in /lib/Utility.js E
A
getProcesses in /lib/God/Methods.js E
A
restartWatch in /lib/Satan.js E
A
God.getNewId in /lib/God/Methods.js E
A
pullCommitId in /lib/tools/VersionManagement.js E
A
launchDaemon in /lib/Satan.js E
A
miniDisplay in /lib/CLI/CliUx.js E
A
killProcess in /lib/God/Methods.js E
A
listModules in /lib/Modularizer.js E
A
dispAsTable in /lib/CLI/CliUx.js E
A
colorStatus in /lib/CLI/CliUx.js E
A
bytesToSize in /lib/CLI/CliUx.js E
A
msgProcess in /lib/God/ActionMethods.js E
A
handleExit in /lib/God.js E
A
reloadLogs in /lib/God/ActionMethods.js E
A
executeApp in /lib/God.js E
A
pingDaemon in /lib/Satan.js E
A
softReload in /lib/God/Reload.js E
A
resetState in /lib/God/Methods.js E
A
disconnect in /lib/Interactor/pm2-interface.js E
A
hardReload in /lib/God/Reload.js E
A
getVersion in /lib/God/ActionMethods.js E
A
killDaemon in /lib/Satan.js E
A
printError in /lib/Common.js E
A
Monit.init in /lib/Monit.js E
A
Monit.stop in /lib/CLI/Monit.js E
A
findByName in /lib/God/Methods.js E
A
findByPort in /lib/God/Methods.js E
A
Monit.stop in /lib/Monit.js E
A
Monit.init in /lib/CLI/Monit.js E
A
stopWatch in /lib/Satan.js E
A
drawRatio in /lib/CLI/Monit.js E
A
daemonize in /lib/Interactor/InteractorDaemonizer.js E
A
drawRatio in /lib/Monit.js E
A
launchRPC in /lib/Interactor/InteractorDaemonizer.js E
A
launchRPC in /lib/Satan.js E
A
send_data in /lib/Interactor/PushInteractor.js E
A
stopWatch in /lib/God/ActionMethods.js E
A
timeSince in /lib/CLI/CliUx.js E
A
printOut in /lib/Common.js E
A
getNewId in /lib/God/Methods.js E
A
forkMode in /lib/God/ForkMode.js E
A
backward in /lib/tools/VersionManagement.js E
A
exports in /lib/God/ForkMode.js E
A
refresh in /lib/CLI/Monit.js E
A
forward in /lib/tools/VersionManagement.js E
A
exitCli in /lib/Common.js E
A
exports in /lib/God/ActionMethods.js E
A
exports in /lib/God/Reload.js E
A
refresh in /lib/Monit.js E
A
exports in /lib/God/Methods.js E
A
nodeApp in /lib/God/ClusterMode.js E
A
exports in /lib/God/ClusterMode.js E
A
forcegc in /lib/God/Methods.js E
A
killMe in /lib/God/ActionMethods.js E
A
watch in /lib/Watcher.js E
A
close in /lib/Watcher.js E
A
init in /lib/CLI/Monit.js E
A
ping in /lib/God/ActionMethods.js E
A
ping in /lib/Interactor/InteractorDaemonizer.js E
A
IPM2 in /lib/Interactor/pm2-interface.js E
A
stop in /lib/CLI/Monit.js E
A
init in /lib/Monit.js E
A
exec in /lib/ProcessContainer.js E
A
name in /lib/Interactor/InteractorDaemonizer.js E
A
stop in /lib/Monit.js E
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
Show 98 more ...
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.