#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
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
U
Modularizer.generateSample in /lib/Modularizer.js E
U
Common.getProcessIdByName in /lib/Common.js E
U
God.sendDataToProcessId in /lib/God/ActionMethods.js E
U
Common.getProcessByName in /lib/Common.js E
U
Common.getAllProcessId in /lib/Common.js E
U
God.resetMetaProcessId in /lib/God/ActionMethods.js E
U
Common.getAllModulesId in /lib/Common.js E
U
Configuration.multiset in /lib/Configuration.js E
U
Modularizer.launchAll in /lib/Modularizer.js E
U
God.notifyByProcessId in /lib/Event.js E
U
Configuration.getAll in /lib/Configuration.js E
U
Common.getAllProcess in /lib/Common.js E
U
DeployModule.deploy in /lib/CLI/Deploy.js E
U
Satan.disconnectBus in /lib/Satan.js E
U
Modularizer.install in /lib/Modularizer.js E
U
Configuration.unset in /lib/Configuration.js E
U
Configuration.get in /lib/Configuration.js E
U
Configuration.set in /lib/Configuration.js E
U
Configuration.set in /lib/Configuration.js E
U
Monit.addProcess in /lib/CLI/Monit.js E
U
HttpRequest.post in /lib/Interactor/HttpRequest.js E
U
Monit.addProcess in /lib/Monit.js E
U
HttpRequest.ping in /lib/Interactor/HttpRequest.js E
U
buildProcessTree in /lib/TreeKill.js E
U
Satan.launchBus in /lib/Satan.js E
U
Satan.notifyGod in /lib/Satan.js E
U
uninstallModule in /lib/Modularizer.js E
U
installModule in /lib/Modularizer.js E
U
UX.dispKeys in /lib/CLI/CliUx.js E
U
startModule in /lib/Modularizer.js E
U
cleanPrefix in /lib/completion.js E
U
installed in /lib/completion.js E
U
uninstall in /lib/completion.js E
U
complete in /lib/completion.js E
U
writeRc in /lib/completion.js E
U
install in /lib/completion.js E
U
readRc in /lib/completion.js E
U
abbrev in /lib/completion.js E
U
trim in /lib/completion.js E
U
log in /lib/completion.js E
U
InteractiveSpinner.setDefaultSpinnerString in /lib/CLI/Spinner.js E
U
InteractiveSpinner#setSpinnerString in /lib/CLI/Spinner.js E
U
module.exports.listenToPM2Events in /lib/Interactor/PushInteractor.js E
U
module.exports.whichFileExists in /lib/Utility.js E
U
module.exports.overrideConsole in /lib/Utility.js E
U
Modularizer.getAdditionalConf in /lib/Modularizer.js E
U
module.exports.preparePacket in /lib/Interactor/PushInteractor.js E
U
module.exports.pingKeepAlive in /lib/Interactor/Daemon.js E
U
module.exports.refreshWorker in /lib/Interactor/Daemon.js E
U
module.exports.connectToPM2 in /lib/Interactor/Daemon.js E
U
module.exports.formatMetada in /lib/Interactor/Daemon.js E
U
module.exports.startLogging in /lib/Utility.js E
U
module.exports.validateData in /lib/Interactor/Daemon.js E
U
module.exports.activateRPC in /lib/Interactor/Daemon.js E
U
module.exports.resetPacket in /lib/Interactor/PushInteractor.js E
U
ReverseInteract.changeUrl in /lib/Interactor/ReverseInteractor.js E
U
Common.sink.determineCron in /lib/Common.js E
U
module.exports.changeUrls in /lib/Interactor/Daemon.js E
U
module.exports.bufferData in /lib/Interactor/PushInteractor.js E
U
InteractiveSpinner#start in /lib/CLI/Spinner.js E
U
module.exports.formatCLU in /lib/Utility.js E
U
module.exports.resurrect in /lib/Interactor/WatchDog.js E
U
Configuration.getAllSync in /lib/Configuration.js E
U
InteractiveSpinner#stop in /lib/CLI/Spinner.js E
U
module.exports.autoDump in /lib/Interactor/WatchDog.js E
U
Configuration.unsetSync in /lib/Configuration.js E
U
God.getFormatedProcess in /lib/God/Methods.js E
U
module.exports.welcome in /lib/Interactor/Daemon.js E
U
module.exports.getDate in /lib/Utility.js E
U
makeBackwardCompatible in /lib/Interactor/Password.js E
U
ReverseInteract.start in /lib/Interactor/ReverseInteractor.js E
U
module.exports.extend in /lib/Utility.js E
U
Configuration.setSync in /lib/Configuration.js E
U
Configuration.getSync in /lib/Configuration.js E
U
module.exports.clone in /lib/Utility.js E
U
module.exports.start in /lib/Interactor/Daemon.js E
U
module.exports.start in /lib/Interactor/WatchDog.js E
U
module.exports.exit in /lib/Interactor/Daemon.js E
U
UX.processing.start in /lib/CLI/CliUx.js E
U
StaticSpinner#start in /lib/CLI/Spinner.js E
U
Filter.getProcessID in /lib/Interactor/Filter.js E
U
UX.postModuleInfos in /lib/CLI/CliUx.js E
U
StaticSpinner#stop in /lib/CLI/Spinner.js E
U
getModuleInstalled in /lib/Modularizer.js E
U
UX.processing.stop in /lib/CLI/CliUx.js E
U
Monit.addProcesses in /lib/Monit.js E
U
InteractiveSpinner in /lib/CLI/Spinner.js E
U
Monit.addProcesses in /lib/CLI/Monit.js E
U
Filter.monitoring in /lib/Interactor/Filter.js E
U
God.watch.disable in /lib/Watcher.js E
U
God.Worker.start in /lib/Worker.js E
U
God.watch.enable in /lib/Watcher.js E
U
God.Worker.stop in /lib/Worker.js E
U
module.exports in /lib/CLI/Spinner.js E
U
module.exports in /lib/Worker.js E
U
module.exports in /lib/Event.js E
U
module.exports in /lib/Watcher.js E
U
module.exports in /lib/samples/sample-conf.js E
U
module.exports in /lib/TreeKill.js E
U
Satan.printOut in /lib/Satan.js E
U
module.exports in /lib/tools/isbinaryfile.js E
U
isBinaryCheck in /lib/tools/isbinaryfile.js E
U
isValidModule in /lib/Modularizer.js E
U
Filter.status in /lib/Interactor/Filter.js E
U
deployHelper in /lib/CLI/Deploy.js E
U
Common.clone in /lib/Common.js E
U
generateSalt in /lib/Interactor/Password.js E
U
generateHash in /lib/Interactor/Password.js E
U
process.send in /lib/ProcessContainer.js E
U
moduleExist in /lib/Modularizer.js E
U
passwordSet in /lib/Interactor/Daemon.js E
U
God.notify in /lib/Event.js E
U
reconnect in /lib/Interactor/PushInteractor.js E
U
safe_push in /lib/CLI/CliUx.js E
U
splitKey in /lib/Configuration.js E
U
generate in /lib/Interactor/Password.js E
U
parseEnv in /lib/completion.js E
U
isHashed in /lib/Interactor/Password.js E
U
parseOut in /lib/completion.js E
U
getInfos in /lib/Interactor/Daemon.js E
U
destroy in /lib/Interactor/PushInteractor.js E
U
killAll in /lib/TreeKill.js E
U
killPid in /lib/TreeKill.js E
U
verify in /lib/Interactor/Password.js E
U
onTick in /lib/ProcessContainer.js E
U
onTick in /lib/ProcessContainerFork.js E
U
kill in /lib/Interactor/Daemon.js E
U
exec in /lib/tools/VersionManagement.js E

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.