https://github.com/azu/korefile

File System API for Local/GitHub.
https://github.com/azu/korefile

api browser filesystem fs github node octokit

Last synced: 26 days ago
JSON representation

File System API for Local/GitHub.

• Host: GitHub
• URL: https://github.com/azu/korefile
• Owner: azu
• License: mit
• Created: 2019-06-02T02:21:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-14T03:01:47.000Z (11 months ago)
• Last Synced: 2024-08-21T02:54:53.206Z (27 days ago)
• Topics: api, browser, filesystem, fs, github, node, octokit
• Language: TypeScript
• Homepage:
• Size: 107 KB
• Stars: 31
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# korefile [![Actions Status: test](https://github.com/azu/korefile/workflows/test/badge.svg)](https://github.com/azu/korefile/actions?query=workflow%3A"test")

 

> korefile: コレ・ファイル

 

File System API for Local/GitHub.

## Features

- Write/Read/Delete API for Local/GitHub

- Pluggable adaptor

## Install

Install with [npm](https://www.npmjs.com/):

    npm install korefile

## Usage

Korefile apply [KoreFileAdaptor](./src/KoreFileAdaptor.ts) implementation. 

### FsAdaptor

Read/Write/Delete for local file system.

It wraps `fs` module.

```js

import {createKoreFile, createFsAdaptor} from "korefile";

const koreFile = createKoreFile({ 

    adaptor: createFsAdaptor()

});

(async () => { 

    // write

    await koreFile.writeFile("/path/to/file", "content");

    // read

    const content = await koreFile.readFile("/path/to/file");

    // delete

    await koreFile.deleteFile("/path/to/file");

})()

```

### GitHubAdaptor

Read/Write/Delete for GitHub repository.

It wrap [octokit/rest.js](https://github.com/octokit/rest.js/).

Require [GitHub Auth Token](https://github.com/settings/tokens/new).

```js

import {createKoreFile, createGitHubAdaptor} from "korefile";

const koreFile = createKoreFile({

    adaptor: createGitHubAdaptor({

        owner: "azu",

        repo: "korefile",

        ref: "heads/test",

        token: process.env.GH_TOKEN

    })

});

(async () => { 

    // file path should be relative

    const testFilePath = "file.test";

    // write

    await koreFile.writeFile(testFilePath, input);

    // read

    const content = await koreFile.readFile(testFilePath);

    // delete

    await koreFile.deleteFile(testFilePath);

})();

```

## UseCase

- [asocial-bookmark](https://github.com/azu/asocial-bookmark)

- [github-funding-yml-updater](https://github.com/azu/github-funding-yml-updater)

## Changelog

See [Releases page](https://github.com/azu/korefile/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/azu/korefile/issues).

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)

- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu