{"id":19009110,"url":"https://github.com/gamtiq/jsdoc-file","last_synced_at":"2025-06-30T23:06:46.147Z","repository":{"id":49204383,"uuid":"259449302","full_name":"gamtiq/jsdoc-file","owner":"gamtiq","description":"JSDoc plugin to create files inside directory of generated documentation (e.g. .nojekyll etc)","archived":false,"fork":false,"pushed_at":"2021-06-23T18:31:53.000Z","size":175,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-15T05:41:59.348Z","etag":null,"topics":["content","create","directory","documentation","empty","file","jsdoc","nojekyll","plugin","write"],"latest_commit_sha":null,"homepage":null,"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/gamtiq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2020-04-27T20:46:51.000Z","updated_at":"2023-02-07T14:07:36.000Z","dependencies_parsed_at":"2022-08-29T21:12:05.550Z","dependency_job_id":null,"html_url":"https://github.com/gamtiq/jsdoc-file","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/gamtiq/jsdoc-file","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Fjsdoc-file","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Fjsdoc-file/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Fjsdoc-file/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Fjsdoc-file/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gamtiq","download_url":"https://codeload.github.com/gamtiq/jsdoc-file/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Fjsdoc-file/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260999071,"owners_count":23095240,"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":["content","create","directory","documentation","empty","file","jsdoc","nojekyll","plugin","write"],"created_at":"2024-11-08T19:06:37.518Z","updated_at":"2025-06-30T23:06:45.886Z","avatar_url":"https://github.com/gamtiq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jsdoc-file \u003ca name=\"start\"\u003e\u003c/a\u003e\n\n[JSDoc](https://jsdoc.app/) plugin to create files inside directory of generated documentation (e.g. `.nojekyll` etc).\n\n## Table of contents\n\n* [Installation](#install)\n* [Usage](#usage)\n* [Examples](#examples)\n* [Related projects](#related)\n* [Contributing](#contributing)\n* [License](#license)\n\n## Installation \u003ca name=\"install\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\n    npm install jsdoc-file --save-dev\n\nThis plugin requires the following:\n* JSDoc version \u003e= 3.2.1\n\n## Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\n1. Add plugin into `plugins` array of a [JSDoc configuration file](https://jsdoc.app/about-configuring-jsdoc.html#configuring-plugins):\n\n```json\n{\n    ...\n    \"plugins\": [\n        ...\n        \"jsdoc-file\"\n    ],\n    ...\n}\n```\n\n2. Specify files that should be created as value of `opts.fileSet` field in the [JSDoc configuration file](https://jsdoc.app/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file):\n\n```json\n{\n    \"opts\": {\n        ...\n        \"fileSet\": {\n            \".nojekyll\": \"\",\n            \"LICENSE-MIT\": \"Copyright (c) ...\"\n        }\n    },\n    ...\n}\n```\n\nYou can specify one or several files and provide content for them.  \nIf a file does already exist in documentation directory the file will be overwritten.  \nIt is possible to set file path that includes subdirectories inside documentation directory (necessary subdirectories will be automatically created).  \nYou can skip creation of a file by setting `false`/`null` value for the file.  \nIf you set an object or an array as a value for a file the corresponding JSON will be written into the file.  \nSee examples below.\n\n## Examples \u003ca name=\"examples\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\nIn the following examples `\"opts\": {...}` is omitted for brevity.\n\nCreate one empty file:\n```json\n\"fileSet\": \".nojekyll\"\n```\nor\n```json\n\"fileSet\":  {\n    \".nojekyll\": \"\"\n}\n```\nor\n```json\n\"fileSet\":  {\n    \".nojekyll\": true\n}\n```\n\nCreate several files at once:\n```json\n\"fileSet\":  {\n    \".nojekyll\": true,\n    \"LICENSE\": \"Some license data here\",\n    \"very/important/file.txt\": \"very important data\",\n    \"config.json\": {\n        \"a\": 2,\n        \"topics\": [\"home\", \"docs\"],\n        \"url\": \"http://some.server.net\"\n    }\n}\n```\n\nSkip creating some files by setting `false`/`null` value for them:\n```json\n\"fileSet\":  {\n    \".nojekyll\": false,\n    \"a.txt\": \"content\",\n    \"some/dir/file.md\": null\n}\n```\n\n## Related projects \u003ca name=\"related\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\n* [makef](https://github.com/gamtiq/makef) - a utility to create files inside specified directory.\n* [typedoc-light-theme](https://github.com/gamtiq/typedoc-light-theme) - [TypeDoc](https://typedoc.org/) theme that adds some useful options (header links, custom style and script, ability to create files etc).\n\n## Contributing \u003ca name=\"contributing\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\nIn lieu of a formal styleguide, take care to maintain the existing coding style.\nAdd unit tests for any new or changed functionality.\nLint and test your code.\n\n## License \u003ca name=\"license\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\nCopyright (c) 2020-2021 Denis Sikuler  \nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamtiq%2Fjsdoc-file","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgamtiq%2Fjsdoc-file","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamtiq%2Fjsdoc-file/lists"}