{"id":35109594,"url":"https://github.com/umaarov/file-path-inserter","last_synced_at":"2026-04-26T17:31:23.820Z","repository":{"id":261552211,"uuid":"852590958","full_name":"umaarov/file-path-inserter","owner":"umaarov","description":"Automatically inserts file paths as comments at the top of your code files. Supports multiple file types and integrates with VSCode.","archived":false,"fork":false,"pushed_at":"2024-09-05T05:21:25.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-21T05:42:36.821Z","etag":null,"topics":["automation","file-management","nodejs","opensource","programming","vscode"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/umaarov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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-09-05T04:32:00.000Z","updated_at":"2025-09-04T10:13:05.000Z","dependencies_parsed_at":"2024-11-07T06:41:57.242Z","dependency_job_id":"ffed1aaa-b704-4c6e-a663-928e4209a56a","html_url":"https://github.com/umaarov/file-path-inserter","commit_stats":null,"previous_names":["urverse-uz/file-path-inserter","umaarov/file-path-inserter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/umaarov/file-path-inserter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umaarov%2Ffile-path-inserter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umaarov%2Ffile-path-inserter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umaarov%2Ffile-path-inserter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umaarov%2Ffile-path-inserter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umaarov","download_url":"https://codeload.github.com/umaarov/file-path-inserter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umaarov%2Ffile-path-inserter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32307010,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T17:23:19.671Z","status":"ssl_error","status_checked_at":"2026-04-26T17:23:19.195Z","response_time":129,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["automation","file-management","nodejs","opensource","programming","vscode"],"created_at":"2025-12-27T19:24:23.288Z","updated_at":"2026-04-26T17:31:23.814Z","avatar_url":"https://github.com/umaarov.png","language":"JavaScript","readme":"# File Path Inserter\n\n**File Path Inserter** is a tool designed to automatically insert the file path as a comment at the top of your code files. This tool supports multiple file types and can be easily integrated into your development environment with a customizable keybinding.\n\n## Features\n\n- **Supports Multiple File Types**: Detects file types and uses appropriate comment syntax.\n- **Customizable Keybinding**: Easily configure keybindings in VSCode.\n- **No Additional Project Configuration Required**: Simple setup and usage across all projects.\n\n## Supported Languages and Tools\n\nThe File Path Inserter supports the following languages and tools:\n\n- **JavaScript (.js)**\n- **TypeScript (.ts)**\n- **C++ (.cpp)**\n- **Java (.java)**\n- **C# (.cs)**\n- **Go (.go)**\n- **PHP (.php)** - Note: Special handling for PHP files with `\u003c?php` tag.\n- **Python (.py)**\n- **Shell (.sh)**\n- **Ruby (.rb)**\n- **Perl (.pl)**\n- **YAML (.yml, .yaml)**\n- **Environment Files (.env)**\n- **TOML (.toml)**\n- **HTML (.html)**\n- **XML (.xml)**\n- **CSS (.css)**\n- **SCSS (.scss)**\n\n## Installation\n\n### Prerequisites\n\n- **Node.js**: Ensure Node.js is installed on your system. You can download it from [Node.js official website](https://nodejs.org/).\n\n### Setup Instructions\n\n1. **Clone the Repository**\n\n   Open a terminal and run:\n\n   ```sh\n   git clone https://github.com/umaarov/file-path-inserter.git\n   cd file-path-inserter\n   ```\n2.  **Place the Script**\n    * Save the `insertFilePath.js` script to a directory of your choice. For example:\n    * Windows: `C:/scripts/insertFilePath.js`\n    * macOS/Linux: `/usr/local/bin/insertFilePath.js`\n3.  **Configure Keybinding in VSCode**\n    * Open VSCode.\n    * Go to `File \u003e Preferences \u003e Keyboard Shortcuts`.\n    * Click on the `{}` icon at the top right to open `keybindings.json`.\n    * Add the following keybinding configuration:\n    * ```sh\n      [\n        {\n          \"key\": \"ctrl+alt+i\",\n          \"command\": \"workbench.action.terminal.sendSequence\",\n          \"args\": {\n            \"text\": \"node C:/scripts/insertFilePath.js ${file}\\u000D\"\n           },\n          \"when\": \"editorTextFocus\"\n        }\n      ]]\n    * Adjust the path (`C:/scripts/insertFilePath.js`) to where you saved the script.\n\n## Usage\n1. **Open a File** in VSCode.\n2. **Press the Keybinding**: `Ctrl+Alt+I` (or the keybinding you configured).\n3. **Verify the File**: The file path should be inserted as a comment at the top of the file.\n\n### Example Output\nFor a JavaScript file, the comment will look like this:\n``` sh\n// C:/path/to/your/file.js\n```\nFor a PHP file, if the file starts with `\u003c?php`, the comment will be:\n``` sh\n\u003c!-- C:/path/to/your/file.php --\u003e\n```\n## Contributing\nWe welcome contributions! If you’d like to contribute, please:\n1. **Fork the Repository**: Click the \"Fork\" button on GitHub.\n2. **Create a New Branch**: For your changes, run:\n   ```sh\n   git checkout -b your-branch-name\n   ```\n3. **Make Your Changes**: Edit files and test your changes.\n4. **Submit a Pull Request**: Push your branch to your forked repository and open a pull request.\n\n### License\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n### Contact\nFor any questions or support, please contact hs.umarov21@gmail.com.\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumaarov%2Ffile-path-inserter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumaarov%2Ffile-path-inserter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumaarov%2Ffile-path-inserter/lists"}