Skip to content

JAS-lzn/jam

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jam

A tasty utility to find your tasty methods, just like Mom used to make

jam-jars

The goal of this utility is to help developers auto-generate documentation for thier code, spesifically, document when different methods were added to a code base, the properties of that method, and also document any changes to those methods.

This is accomplished by cloning the repo, and reading all the source code. Jam will read thru the source code and look for the tell-tale signs of methods (fn, function, ()=>{}, etc) and extract the method's name, arguments, return type, etc from that. Jam will then note what commit the method was added in, and generate some markdown to later be injected into a readme or docs site. Jam will then check the diffs between commits on the main branch of the repo, looking for new methods, and changes to the already existing ones.

About

a tasty utility to find your tasty methods

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages