Limitations and SecurityΒΆ
As of now this tool should be able to support code below 10k lines (html, tests, js, css, backend) but may have scrolling issues for the generated 100 pages. The best way to use this in projects is to write the first 1000 lines and then import all the files into 1 cog file.
Syntax highlighting while editing but the browser can make up for the loss here.
Debugging code is a bit tricky as there is no line number information. Perhaps it could be generated automatically.
If you are not careful snippets can capture variable scope. Sometimes this is exactly what you want, so you can document the variables captured.
Security could be an issue as arbitrary commands are executed in the docs.
If you want to have multiple cog files and want to share code between them use normal python imports to store the code. If you want to share snippets across cog files, you can use the same approach but it will break to psychological ordering. To preserve the ordering what you can do is export the snippets as pickle files and reuse them in any other cog file by loading the pickle files, that way each corresponding cog file will have a corresponding pickle file serialized.
Like installing and running any unknown code, there are risks involved. As this project can create and delete files, safe-rm is used for deleting files as a precaution. If you want complete safety then use containers to isolate the code.