{"id":21051431,"url":"https://github.com/aiherrera/dialog-gerunds-extractor","last_synced_at":"2025-07-06T15:38:21.551Z","repository":{"id":244899630,"uuid":"816621462","full_name":"aiherrera/dialog-gerunds-extractor","owner":"aiherrera","description":"This Node.js application extracts and highlights gerunds from a corpus of .doc, .rtf, and .docx files, while providing the option to exclude specific words.","archived":false,"fork":false,"pushed_at":"2024-06-24T22:26:58.000Z","size":34,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-06T15:08:02.997Z","etag":null,"topics":["converter","doc","docx","rtf"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aiherrera.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-18T05:23:28.000Z","updated_at":"2024-06-24T22:27:01.000Z","dependencies_parsed_at":"2024-11-19T15:57:03.507Z","dependency_job_id":null,"html_url":"https://github.com/aiherrera/dialog-gerunds-extractor","commit_stats":null,"previous_names":["aiherrera/dialog-gerunds-extractor"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiherrera%2Fdialog-gerunds-extractor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiherrera%2Fdialog-gerunds-extractor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiherrera%2Fdialog-gerunds-extractor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiherrera%2Fdialog-gerunds-extractor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aiherrera","download_url":"https://codeload.github.com/aiherrera/dialog-gerunds-extractor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243495985,"owners_count":20300022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["converter","doc","docx","rtf"],"created_at":"2024-11-19T15:56:51.449Z","updated_at":"2025-03-13T23:23:48.665Z","avatar_url":"https://github.com/aiherrera.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dialog Gerunds Extractor\n\nThis Node.js application extracts and highlights gerunds from a corpus of `.doc`, `.rtf`, and `.docx` files, while providing the option to exclude specific words.\n\n## Features\n\n- **Converts documents to .docx:** Uses LibreOffice to convert legacy `.doc` and `.rtf` files to `.docx` for consistent processing.\n- **Identifies and highlights gerunds:** Uses regular expressions and the `docx` library to highlight gerunds within the text.\n- **Exclusion list:** Allows you to specify words to be excluded from highlighting, even if they match the gerund pattern.\n\n## Requirements\n\n- **Node.js:** Version 12.20.0 or higher ([https://nodejs.org/](https://nodejs.org/))\n- **LibreOffice:** Installed and accessible from the command line (for `.doc` and `.rtf` conversion)\n\n## Installation\n\n1. **Clone the repository:**\n   ```bash\n   git clone https://github.com/your-username/dialog-gerunds-extractor.git\n   cd dialog-gerunds-extractor\n   ```\n2. **Install dependencies:**\n   ```bash\n    pnpm install\n   ```\n3. **Run the application:**\n   ```bash\n   pnpm start\n   ```\n\n## Usage\n\n1. **Corpus Directory:**\n\n   - Place all your `.doc`, `.rtf`, and `.docx` files in the `corpus` directory.\n   - Example:\n     ```\n     corpus/\n        document1.doc\n        document2.rtf\n        document3.docx\n     ```\n\n2. **Exclusion List (Optional):**\n\n   - Create a text file named `exclusion_list.txt` in the project root directory.\n   - List one excluded word per line in the file.\n   - Example (`exclusion_list.txt`):\n     ```\n     running\n     walking\n     swimming\n     ```\n\n3. **Run the Application:**\n\n   - Open your terminal or command prompt.\n   - Navigate to the project directory.\n   - Run the following command:\n\n     ```bash\n     pnpm start\n     ```\n\n## Output\n\nThe processed files with highlighted gerunds will be saved in the following directories:\n\n- **`output/converted_to_docx`:** Converted `.docx` versions of the input files (if applicable).\n- **`output/highlighted`:** Final `.docx` files with highlighted gerunds.\n\n## Contributing\n\nContributions are welcome! If you have any improvements or bug fixes, please follow these steps:\n\n1. **Fork the repository** on GitHub.\n\n2. **Create a new branch** for your feature or bug fix.\n\n3. **Make your changes** and commit them with clear messages.\n\n4. **Push your changes** to your forked repository.\n\n5. **Submit a pull request** to the main repository.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgments\n\n- [Mammoth.js](https://www.npmjs.com/package/mammoth): For converting .docx files to text.\n- [docx](https://www.npmjs.com/package/docx): For creating and manipulating .docx files.\n- [LibreOffice](https://www.libreoffice.org/): For converting .doc and .rtf files to .docx.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiherrera%2Fdialog-gerunds-extractor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiherrera%2Fdialog-gerunds-extractor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiherrera%2Fdialog-gerunds-extractor/lists"}