deepal/boostnote-github-sync

✨ Sync BoostNote notes into Github Private Repo in Markdown format

boostnote-github-sync's Issues

Do not sync empty notes

When a note is created, Note title and the content is initially empty. Syncing the empty notes should not be done as it unnecessary adds useless commits to the repository

Unit tests for Watcher module

Write unit tests for Watcher module

Optimized Sync for multiple versions of the same file

Sync only the latest version of a file, if multiple versions are in the sync queue in order to prevent unnecessary commits on the repository.

Escape meta characters from file names

Certain files may contain markdown meta characters in the file name. This might lead to the file name not being properly displayed in the table of contents.

Sync raw note content to GitHub

The current implementation parses markdown content from Boostnote .cson files and syncs to GitHub. This loses the metadata (tags, storage locations etc.) on notes, hence notes cannot be synced from GitHub back to the local storage. To provide back-and-forth sync, raw files also should be synced to a separate directory in the repository.

Proper error handling

Implement a custom error scheme

Command line utility

Command line of the boostnote github sync should look like the following:

$ boostnote-github-sync configure
Your github repository name: my-boostnotes
Destination branch: [master] master
Boostnote Directories to Sync: /Users/johndoe/boostnotes,/Users/johndoe/work/boostnotes
GitHub Personal Access Token: xxxxxxxxxxxxxxxxxxx
[*] Boostnote GitHub Sync configuration saved at /Users/.boostnote-github-sync/config.json

# boostnote-github-sync start
# boostnote-github-sync stop
# boostnote-github-sync restart
# boostnote-github-sync status

Create repository automatically if not already exists

Automatically create the GitHub sync repository according to the configuration if the repository is not manually created by the user.

Display a Table of Contents in README.md

Since the notes are saved in GitHub with a unique filename (GUID), it is not possible to find the notes without opening each one. To ease the search, make the README.md a table of contents file which will list the titles of all the notes in the repository with links to each.

Implement Delete Note

Deleting note is not possible currently. This is a must-have feature.

Consistent file watching across platforms

Use chokidar (https://github.com/paulmillr/chokidar) instead of native node.js fs.watch for watching directories as fs.watch is inconsistent across platforms according to the official documentation (https://nodejs.org/docs/latest/api/fs.html#fs_caveats)

Process restart with `enumerateOnStartup` set to true causes all the notes getting synced again

If the enumerateOnStartup is set to true and process is restarted due to some issue, the entire enumeration process happens again (even for the already synced notes).

The best way to do this is:

• keep the metadata file always in-sync
• Verify the note's checksum with the metadata file's corresponding checksum for the file
• Sync only if the checksum is changed

Unit tests for Preprocessor module

Write unit tests for Preprocessor module

Delayed Sync

When a note is being edited by the user, every keystroke can trigger a file update event on the watcher. In the worse-case, this results in the creation of individual sync events per each keystroke, which is unnecessary and could event lead to Github API quota exhaustion. To prevent this, implement delayed sync in the following manner.

• Start a timer when an edit on a note has been started
• Add the updated note to the sync queue only when the timer is expired
• If a file change is detected (another update) on the same file before the timer is expired, reset the timer.

Please update the quick start

Setting up:

• Clone the repository
• Configure your github repository, personal access token and the local boostnotes directory in .env file.
• Configure other application settings in config.js file.
• Run npm install
• Run npm start to run the sync process.

---

Configuration .env file

GITHUB_TOKEN="personal access token---个人访问令牌"
GITHUB_REPO="github repository---boostnote的github库地址"
LOCAL_BOOSTNOTE_DIR="local boostnotes directory---boostnote的本地储存目录"

Configuration .env file

There is no clear description of which configuration is required

What are the necessary configuration files for config.js file？？？

Please update the quick start！

include tags and other metadata

Did you consider synchronizing all metadata from boostnote notes and snippets with markdown files? Metadata could be added to YAML front matter.

This section is invisible for most markdown renderer. Also works with BN. An example could look like:

---
createdAt: "2018-09-25T09:05:00.937Z"
updatedAt: "2019-05-23T14:05:01.657Z"
type: "MARKDOWN_NOTE"
folder: "2826e081a3ec6d795f77"
filename: blabla.cson""
title: "some title"
tags: "a, b, c"
---

Though it is being displayed on github and bitbucket (others untested). Maybe a comment section could be used, instead:

<!--
createdAt: "2018-09-25T09:05:00.937Z"
updatedAt: "2019-05-23T14:05:01.657Z"
type: "MARKDOWN_NOTE"
folder: "2826e081a3ec6d795f77"
filename: blabla.cson""
title: "some title"
tags: "a, b, c"
-->

Sync Snippet Notes in Markdown Format

Implement syncing Boostnote SNIPPET notes in markdown format.

Unit tests for Sync module

Write unit tests for Sync module

Unit tests for github module

Write unit tests for github module

Retry notes which were failed to sync

In the current implementation, boostnote-github-sync dequeues an item from the sync queue and then attempts to sync it. If the sync fails, it is never retried because the item is already dequeued from the sync queue.