GitHub - skorotkiewicz/cadence: $$hi Small marker tracking for source files. · GitHub
/" data-turbo-transient="true" />
Skip to content
Search or jump to...
Search code, repositories, users, issues, pull requests...
-->
Search
Clear
Search syntax tips
Provide feedback
--><br>We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel
Submit feedback
Saved searches
Use saved searches to filter your results more quickly
-->
Name
Query
To see all available qualifiers, see our documentation.
Cancel
Create saved search
Sign in
/;ref_cta:Sign up;ref_loc:header logged out"}"<br>Sign up
Appearance settings
Resetting focus
You signed in with another tab or window. Reload to refresh your session.<br>You signed out in another tab or window. Reload to refresh your session.<br>You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
skorotkiewicz
cadence
Public
Notifications<br>You must be signed in to change notification settings
Fork
Star
main
BranchesTags
Go to file
CodeOpen more actions menu
Folders and files<br>NameNameLast commit message<br>Last commit date<br>Latest commit
History<br>17 Commits<br>17 Commits
src
src
tests
tests
.gitignore
.gitignore
Cargo.lock
Cargo.lock
Cargo.toml
Cargo.toml
README.md
README.md
justfile
justfile
test.sh
test.sh
View all files
Repository files navigation
Cadence
Small marker tracking for source files.
Cadence turns comments like this:
// $$todo handle empty input
into stable, checkable items:
// $$todo:1:open handle empty input
and mirrors them to Markdown in .cadence/items/todo.md.
Install
cargo install --path .
Quick Start
cadence init
Add markers to any source file:
// $$todo handle empty input<br>// $$fixme avoid duplicate work<br>// $$hack remove temporary branch
The prefix comes from .cadence/config.yml.
Stage files or directories and commit them to Cadence:
cadence add src/main.rs<br># or: cadence add src<br>cadence commit
Cadence assigns IDs in the source file and writes Markdown checklists:
- [ ] $$todo:1:open - src/main.rs:1:4 - handle empty input
Check an item in .cadence/items/*.md, then run:
cadence commit
The source marker status changes from open to done.
Add notes below any Markdown item; Cadence keeps them with that item:
- [x] $$todo:3:done - src/main.rs:8:4 - final flux<br>Happy<br>Spring<br>Break!<br>- [~] $$todo:4:in-progress - src/main.rs:12:4 - more daleks!
Customize checklist markers in .cadence/schemas.yml:
todo:<br>statuses: ["open:[ ]", "done:[x]", "in-progress:[~]"]
Commands
# stage a file or directory<br>cadence commit # sync source markers and Markdown<br>cadence reset # clear staged files">cadence init # create .cadence/<br>cadence add path> # stage a file or directory<br>cadence commit # sync source markers and Markdown<br>cadence reset # clear staged files
cadence add stages directory contents recursively. .cadence/ and its contents are never staged.
Files
.md # generated checklist">.cadence/<br>config.yml # marker prefix<br>schemas.yml # default marker types<br>db.json # tracked items<br>staged.json # staged files<br>items/<br>.md # generated checklist
About
$$hi Small marker tracking for source files.
Topics
markdown
rust
tracking
mark
Resources
Readme
Uh oh!
There was an error while loading. Please reload this page.
Activity
Stars
stars
Watchers
watching
Forks
forks
Report repository
Contributors
Uh oh!
There was an error while loading. Please reload this page.
Languages
Rust<br>97.3%
Just<br>2.1%
Shell<br>0.6%
You can’t perform that action at this time.