azu / korefile

File System API for Local/GitHub.

korefile

korefile: コレ・ファイル

File System API for Local/GitHub.

Features

• Write/Read/Delete API for Local/GitHub
• Pluggable adaptor

Install

Install with npm:

npm install korefile

Usage

Korefile apply KoreFileAdaptor implementation.

FsAdaptor

Read/Write/Delete for local file system. It wraps fs module.

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.

Require GitHub Auth Token.

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
• github-funding-yml-updater

Changelog

See Releases page.

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.

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
• twitter/azu_re

License

MIT © azu

korefile's Issues

Support running in the browser (without NodeJS api)

Hi! Thanks for your library!

I use it in my small project and it works very well. However I had to adjust it for my use case. Here it is.

My application is an Angular app and it runs entirely in the browser. I was unable to use KoreFile initially as it makes use of some NodeJS API such as process and Buffer. It does not seem like a strict requirement though. I forked the lib and removed/replaced those apis.

It would be quite nice if you can support it on the library level via the public API, or maybe consider doing a platform-independent version that would work well both in NodeJS app and a browser (webpack bundle).

Thanks for your time.

Use `createCommitOnBranch`

A simpler API for authoring commits | GitHub Changelog

We can use createCommitOnBranch instead of Rest API.

Support rename

I've implemented the rename function using write and delete batch update.
https://github.com/jser/jser.github.io/blob/develop/actions/update-draft-pr/src/rename.ts

But, I want to get the correct way that rename a to b at once.

Use octokit/plugin-create-or-update-text-file.js:

It is official plugin.

octokit/plugin-create-or-update-text-file.js: Convenience method to create/edit/delete a text file based on its current content

• create
• update
• delete

Support multiple read/write

azu/git-commit-push-via-github-api support multiple write at once.
korefile also support multiple write.

It reduce request when write multiple files with GitHub API.

list files?

API to list files in repo would be nice.

Support read binary

current readFile does not support binary.