shvetsgroup / comments-exporter
A console script that exports source code comments to csv files and vise versa. Supports most types of comments, both single and multi-line.
Installs: 10
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.0
- league/csv: ^8.2
- symfony/console: ^3.2
- symfony/finder: ^3.2
Requires (Dev)
- phpunit/phpunit: ^6.1
This package is auto-updated.
Last update: 2024-12-23 08:15:00 UTC
README
Comments exporter is a console script that can export code comments from multiple source files to a csv file. This file can be used to perform bulk proofreading and editing over code comments. After that, comments can be imported back with the same script.
Script supports all types of C-like comments, such as:
// This one. /* This one. */ /** * And this one. */
Installation
Requirements:
- PHP7
- Composer
Comments exporter is installed as a global Composer package. You need to have Composer installed in your system and have the composer global tools added to your PATH.
composer global require shvetsgroup/comments-exporter
Updates
composer global update shvetsgroup/comments-exporter
Usage
-
Export comments:
comments-exporter export /path/to/project /path/to/csv-file.csv
-
Do something with the
csv-file.csv
contents. Do not add new rows, just edit thecomment
column. -
Import comments back:
comments-exporter import /path/to/csv-file.csv /path/to/project
Type comments-exporter --help
to read about full list of supported parameters.