{"id":17472730,"url":"https://github.com/shinnn/prepare-write","last_synced_at":"2025-03-28T08:10:26.986Z","repository":{"id":57329841,"uuid":"92392717","full_name":"shinnn/prepare-write","owner":"shinnn","description":"Prepare for writing a file to the given path – create ancestor directories and verify no directory exists in the path","archived":false,"fork":false,"pushed_at":"2019-06-26T19:15:38.000Z","size":150,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-03T01:35:17.045Z","etag":null,"topics":["check","filesystem","javascript","mkdir","mkdirp","nodejs","prepare","promise","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":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinnn.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":"2017-05-25T10:32:05.000Z","updated_at":"2024-07-01T19:25:20.000Z","dependencies_parsed_at":"2022-09-10T13:51:27.582Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/prepare-write","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fprepare-write","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fprepare-write/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fprepare-write/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fprepare-write/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/prepare-write/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245991582,"owners_count":20706129,"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":["check","filesystem","javascript","mkdir","mkdirp","nodejs","prepare","promise","write"],"created_at":"2024-10-18T17:34:57.485Z","updated_at":"2025-03-28T08:10:26.946Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","readme":"# prepare-write\n\n[![npm version](https://img.shields.io/npm/v/prepare-write.svg)](https://www.npmjs.com/package/prepare-write)\n[![Build Status](https://travis-ci.com/shinnn/prepare-write.svg?branch=master)](https://travis-ci.com/shinnn/prepare-write)\n[![Coverage Status](https://img.shields.io/coveralls/shinnn/prepare-write.svg)](https://coveralls.io/github/shinnn/prepare-write?branch=master)\n\nPrepare for writing a file to the given path – create ancestor directories and verify no directory exists in the path\n\n```javascript\nconst {existsSync} = require('fs');\nconst prepareWrite = require('prepare-write');\n\n(async () =\u003e {\n  existsSync('dir0'); //=\u003e false\n\n  await prepareWrite('dir0/dir1/dir2/file.txt');\n\n  existsSync('dir0'); //=\u003e true\n  existsSync('dir0/dir1'); //=\u003e true\n  existsSync('dir0/dir1/dir2'); //=\u003e true\n  existsSync('dir0/dir1dir2/file.txt'); //=\u003e false\n})();\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).\n\n```\nnpm install prepare-write\n```\n\n## API\n\n```javascript\nconst prepareWrite = require('prepare-write');\n```\n\n### prepareWrite(*path*)\n\n*path*: `string` (directory path)  \nReturn: `Promise\u003cstring | null\u003e`\n\nIt ensures you can soon write a file to the given path by:\n\n1. Creating ancestor directories if they don't exist\n2. Checking if no directory already exists in the path\n\n```javascript\n(async () =\u003e {\n  // a directory /foo doesn't exist\n\n  await prepareWrite('/foo/bar/baz');\n\n  // a directory /foo/bar now exists\n\n  await prepareWrite('/foo/bar');\n  // Error: Tried to create a file as /foo/bar, but a directory with the same name already exists.\n})();\n```\n\n## License\n\n[ISC License](./LICENSE) © 2017 - 2019 Watanabe Shinnosuke\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fprepare-write","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Fprepare-write","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fprepare-write/lists"}