azu / github-project-todo-md

A Tool that sync between GitHub Project Board <-> Todo Markdown text.

github-project-todo-md

A library that sync between GitHub Project Board <-> Markdown Todo text.

Example

This library convert https://github.com/azu/github-project-todo-md/projects/1 to following:

## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [x] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)

Install

Install with npm:

npm install github-project-todo-md

Usage

GitHub Project Board → Markdown

import { fetchProjectBoard, toMarkdown } from "github-project-todo-md";
const json = await fetchProjectBoard({
    owner: "azu",
    repo: "github-project-todo-md",
    projectNumber: 1,
    token: GITHUB_TOKEN
});
const markdown = toMarkdown(json);
assert.strictEqual(
    markdown,
    `## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [x] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)
`
);

Markdown → GitHub Project Board

Sync Markdown's task status to GitHub Project Board's issue and pull request.

import { syncToProject } from "github-project-todo-md";
const CODE = `## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [ ] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)
`;
await syncToProject(CODE, {
    owner: "azu",
    repo: "github-project-todo-md",
    projectNumber: 1,
    token: TOKEN
});

Options

• includesNote: boolean
  • Default: false

If you want to include notes card for syncing, set includesNote to true.

- [ ] title
  - body
    text

→

title

- body
  text

Current Limitation append a node to first column

• Append card to correct column · Issue #11 · azu/github-project-todo-md

User's or Organization's project

User or Organization level project is supported.

You need to pass specific value to owner option.

• User: owner: "users"
• Organization: owner: "orgs"

import { syncToProject } from "github-project-todo-md";
const CODE = `## To do

- [ ] [TODO ISSUE](https://github.com/azu/github-project-todo-md/issues/4)


## In progress

- [ ] [PROGRESS ISSUE](https://github.com/azu/github-project-todo-md/issues/3)


## Done

- [ ] [DONE ISSUE](https://github.com/azu/github-project-todo-md/issues/5)
`;
await syncToProject(CODE, {
    owner: "users",
    repo: "azu", // user name
    projectNumber: 1,
    token: TOKEN
});

UseCase

Inkdrop note <-> GitHub Project

• https://github.com/azu/inkdrop-github-project-todo-md

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

• azu: GitHub, Twitter

License

MIT © azu

github-project-todo-md's Issues

use markdown-function

https://github.com/azu/markdown-function

DONE ISSUE

FOR TESTING

Item mapping

add mapping option.

It aims to support https://github.com/azu/missue cross reference issue.

PROGRESS ISSUE

Interoperability with similar todo in markdown projects?

Hey @azu,

There's a few other projects also working with tasks in markdown. We're starting a small effort hoping to achieve interoperability between them, to have something of a todo.txt like format for markdown.

Would it be crazy to include your project in this effort?

TODO ISSUE

FOR TESTING

GitHub Project board to Markdown

Convert Project board → Markdown

Sync Markdown to GitHub Project

Reverse of #1

Reflect Markdown status to GitHub Project board and Issue.

Append card to correct column

github-project-todo-md/src/markdown-to-project.ts

Line 200 in ad6e1bc

columnId: project.columns[0].id, // FIXME: only insert first column…