f2read
Command line interface that takes a file and produces a README.md file to explain its contents (by cduarte3)
DocBot
By Add00
f2read | DocBot | |
---|---|---|
5 | 4 | |
4 | 0 | |
- | - | |
8.3 | 7.5 | |
3 months ago | 3 months ago | |
TypeScript | JavaScript | |
GNU General Public License v3.0 only | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
f2read
Posts with mentions or reviews of f2read.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2024-11-15.
-
Lab 9 - NPM Release
Now that my project has been released as an NPM module, users can install it with the npm install -g f2read command. In order for the project to work though, users must follow the steps outlined in my README.md located here.
-
Continuous Integration and Continuous Learning
Writing tests for my partners repo was interesting as they had used a different testing framework. They had opted to use Jest where I was using Vitest while syntactically similar the functions had some slight differences. Given that they had very good test coverage out of the gate, I only opted to add some minor tests for some edge cases.
-
Lab 6 - Formatting and Linting
For auto linting and formatting in VSCode, please visit the bottom section of my CONTRIBUTIONS.md here, where I have outlined the steps to do so.
- Week 4, Lab 3
-
Learning Collaboration
A: I think an interesting issue was Issue #5, the project had excellent installation and setup steps, however there was no step to actually run the program. This has since been rectified.
DocBot
Posts with mentions or reviews of DocBot.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2024-11-10.
-
Making CI pipeline for Explainer.js
I worked on DocBot. Although the project is in JS, this project uses a different testing framework called vitest which is jest compatible. One thing I immediately noticed how fast it was compared to just jest. And the terminal output is super polished. Making working on the issue a quite enjoyable. I worked to make file.test.js test suite OS agnostic. I ran it in my WSL termial which ran fine but it did not run in cmd.exe. I immediately noticed now the expected path structure was different. Something I came across when I finished writing my tests in explainer.js last week. I use WSL by default but I rememebered not everyone has it so I ran it in cmd.exe and I had the same issue for the tests I wrote in FilePathResolver.test.js so I had to fix it. So, it is easy to overlook running the terminal in different os when using the default setup vscode terminal. So after some trial and error I fixed it and made my PR.
-
Another Week Another Feature
This week I implemented TOML support for DocBot made by @add00_3. First time hearing about TOML and kind of surprised this exists(we already have YAML). Implementation was pretty simple since the code was written in JavaScript and the code was very easy to read. Although it did take a minute to figure out how to run the tool since I had to run the ollama model locally in order to run the tool. I had ollama installed previously but I had to install the default model that was defined. After that I implemented the feature which was pretty simple. Only "issue" I had was for this tool output flag is null by default and TOML doesn't support null so I had to add additional logic to handle this case. Aside from that it was pretty easy. Moreover, I just updated the logic to use initialized variable instead of using attributes from args directly. Surprisingly, there was no changes requested so I got it merged on the first try!
-
Learning Collaboration
A: I think the worse issue was Issue #2, When I had originally published my tool I had forgotten to make an easy way to use it on the command line. Quite an obvious mistake I’m glad my groupmate found. Another bad one was Issue #4, where the program would still try to process a file even if the file did not exist.
-
Week 2
In my partner's code, I found issues such as the package.json file requiring a start script. It was missing and the program was unable to be run with a default or start named script. https://github.com/Add00/DocBot/issues/2
What are some alternatives?
When comparing f2read and DocBot you can also consider the following projects:
ESLint - Find and fix problems in your JavaScript code.
explainer.js - CLI tool to process files and output the code blocks along with explanation
prettier - Prettier is an opinionated code formatter.
www.yaml.org - The yaml.org website
starter-workflows - Accelerating new GitHub Actions workflows
vitest - Next generation testing framework powered by Vite.