{"id":38519834,"url":"https://github.com/fedecalendino/vscode-fsdocs","last_synced_at":"2026-01-17T06:37:48.623Z","repository":{"id":44414559,"uuid":"511686787","full_name":"fedecalendino/vscode-fsdocs","owner":"fedecalendino","description":"This VSCode Extension will allow you decorate different items of your project's file structure with labels and descriptions to document their contents.","archived":false,"fork":false,"pushed_at":"2023-03-09T17:50:40.000Z","size":3756,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-13T15:45:52.254Z","etag":null,"topics":["documentation","file-structure","vscode"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=fedecalendino.fsdocs","language":"TypeScript","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/fedecalendino.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-07T22:06:12.000Z","updated_at":"2024-12-24T20:09:44.000Z","dependencies_parsed_at":"2022-08-28T08:03:52.836Z","dependency_job_id":null,"html_url":"https://github.com/fedecalendino/vscode-fsdocs","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/fedecalendino/vscode-fsdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedecalendino%2Fvscode-fsdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedecalendino%2Fvscode-fsdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedecalendino%2Fvscode-fsdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedecalendino%2Fvscode-fsdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fedecalendino","download_url":"https://codeload.github.com/fedecalendino/vscode-fsdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fedecalendino%2Fvscode-fsdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28502680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T04:31:57.058Z","status":"ssl_error","status_checked_at":"2026-01-17T04:31:45.816Z","response_time":85,"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":["documentation","file-structure","vscode"],"created_at":"2026-01-17T06:37:48.562Z","updated_at":"2026-01-17T06:37:48.615Z","avatar_url":"https://github.com/fedecalendino.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# File Structure Docs\n\nThis [VSCode](https://code.visualstudio.com/) [Extension](https://marketplace.visualstudio.com/VSCode) will \nallow you decorate different items of your project's file structure with labels and descriptions to document their contents.\n\n![screenshot showing the activity bar](https://raw.githubusercontent.com/fedecalendino/vscode-fsdocs/main/images/sidebar.png)\n\n\n\n## usage\n\nTo work this extension needs a file name `fsdocs.config.json`, at the root of your project, with the following structure:\n\n```json\n{\n  \"info\" : {\n    \"about\": \"This file is meant to be used with the FSDocs VSCode extension\",\n    \"url\": \"https://marketplace.visualstudio.com/items?itemName=fedecalendino.fsdocs\"\n  },\n\n  \"authors\": [\n    \"You \u003cyou@example.com\u003e\"\n  ],\n\n  \"ignore\": [\n    \".git\",\n    \".vscode\"\n  ],\n  \n  \"environments\": {\n    \"dev\": \"🟢\",\n    \"prod\": \"🔴\"\n  },\n\n  \"types\": {\n    \"config-file\": \"📄️\",\n    \"package\": \"📦️\",\n    \"provider\": \"☁️️\"\n  },\n\n  \"items\": {\n    \"src\": {\n      \"__label__\": \"source code\",\n\n      \"59237813-c25f-44cb-942f-9c571214bfed\": {\n        \"__label__\": \"MAIN PROVIDER\",\n        \"__environment__\": \"dev\",\n        \"__type__\": \"provider\",\n\n        \"9eec0c6b-e0af-4c71-939a-15223a51e2a4\": {\n          \"__label__\": \"PKG 123\",\n          \"__description__\": \"Here is more info about this provider.\",\n          \"__type__\": \"package\",\n          \"__environment__\": \"dev\"\n        }\n      },\n      \"db509caa-57a2-4e46-b445-dd8555d66b63\": {\n        \"__label__\": \"PKG 456\",\n        \"__type__\": \"package\",\n        \"__environment__\": \"dev\"\n      }\n    },\n    \"old.py\": {\n      \"__label__\": \"oldie\",\n      \"__description__\": \"here is more documentation for you\",\n      \"__environment__\": \"prod\"\n    }\n  }\n}\n```\n\n![screenshot showing the configuration file and the result in the extension activity view](https://raw.githubusercontent.com/fedecalendino/vscode-fsdocs/main/images/screenshot.png)\n\n\n### info\n\nSimple information about the file, so users can know about its use and the extenstion.\n\n\n### authors\n\nList of people that have made changes to the configuration file.\n\n\n### ignore\n\nList of files and folders that should not be analyzed by the extension.\n\n\n### enviroments / types\n\nThese contain different indicators to show right next to the label of an item.\n\n\n### items\n\nCollection of identifiers to be used to match with the names of the files and folders in the project. \n\n* **`__label__`**: label of the item associated with the identifier.\n* **`__description__` (optional)**: description that will be shown in the tooltip of the item, to see it hover your mouse on top of it.\n* **`__environment__` (optional)**: environment in which the item runs.\n    * it will look for an indicator within the **environments** section.\n* **`__type__` (optional)**: type of the item.\n    * it will look for an indicator within the **types** section.\n\n\n\n## actions\n\n![screenshot showing the available actions](https://raw.githubusercontent.com/fedecalendino/vscode-fsdocs/main/images/actions.png)\n\n\n### Menu bar\n\n* **Open config file**: will open the config file, if it doesn't exist one from a template will be created.\n* **Refresh**: will reload the tree.\n* **Search (beta)**: allows you to locate an item by search for the input text in the label/descriptions provided in the config file.\n* **Collapse all**: will collapse all folders in the tree.\n\n\n### Context menu\n\n* **Copy label**: will add the label of the item to the clipboard (if available).\n* **Copy name**: will add the name of the item to the clipboard.\n* **Copy path**: will add the absolute path of the item to the clipboard.\n\n\n### Item actions\n\n* **Reveal in editor**: will reveal the selected item in VSCode's default editor.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedecalendino%2Fvscode-fsdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffedecalendino%2Fvscode-fsdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedecalendino%2Fvscode-fsdocs/lists"}