Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 1.97 KB

README.md

File metadata and controls

38 lines (31 loc) · 1.97 KB
Raw

comment_collector_cli

This cli collects the comments from your project files

work in progress 🚧

Aug 15 : New updation

Added the support for single-line & multiline comments in following languages:
C, C++, Java, Dart, JavaScript, TypeScript, Kotlin, Golang, CSS, Python, Ruby, R, Perl.

Aug 18:

  1. Added feature for extracting the line number of the comments from the source flie(s) ( using the flag -ln )
  2. Added the support for single-line as well as multi-line documentation comments in python
  3. Added the support for removing the comment characters from the outfile ( using the flag -rc )

Aug 21:

Fixed forgotten case. Extraction of comment from a line of code eg:

def main(): #This is the main fuction
  print(something)

New version supports the extract of theline "#This is the main function" Issue reported by Ananthu B

Sept 7:

The binary can run in any directory.
cltr finds the location of working directory and work with the sourcecode files in the subdirectories.

bug:

regex also matches single-line comment character ( // ) in a string. The rest of the line including the comment character is extracted from the file.
Go through the file:
outfile.md src/data.go - line.no.37
check here

Sept 21:

When using '.' in the command cltr run -s . to indicate the whole files in the directory, there was this issue of the path separator.The windows and Linux-Unix uses different file separators. The code that handles the whole files in the working directory was written using a Linux Machine (Fedora). When the code executed in Windows (10), It prints the whole file location.

It is corrected using passing os.PathSeparator instead of the hardcoding the path separator character for each operating systems.