https://github.com/todotxt/language-todotxt

Syntax highlighting and utilities for todo.txt files for atom.io
https://github.com/todotxt/language-todotxt

atom atom-language atom-language-support atom-package language-todotxt todo todotxt

Last synced: about 2 months ago
JSON representation

Syntax highlighting and utilities for todo.txt files for atom.io

• Host: GitHub
• URL: https://github.com/todotxt/language-todotxt
• Owner: todotxt
• License: bsd-2-clause
• Created: 2014-09-15T18:59:42.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-01-12T16:05:55.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T09:34:45.214Z (9 months ago)
• Topics: atom, atom-language, atom-language-support, atom-package, language-todotxt, todo, todotxt
• Language: JavaScript
• Homepage:
• Size: 50.8 KB
• Stars: 28
• Watchers: 4
• Forks: 16
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# language-todotxt package

[![Todo.txt](http://todotxt.org/images/todotxt_logo_2012.png)](http://todotxt.org/)

This package adds syntax highlighting to [todo.txt](http://todotxt.org/) files

in the [Atom](https://atom.io/) text editor.

Originally [converted](http://atom.io/docs/latest/converting-a-text-mate-bundle)

from the [tmTodoTXT TextMate

bundle](https://github.com/sideshowcoder/tmTodoTXT).

[![Build Status](https://travis-ci.org/todotxt/language-todotxt.svg?branch=master)](https://travis-ci.org/todotxt/language-todotxt)

[![Build Status](https://ci.appveyor.com/api/projects/status/oepsrww0c70esa4j/branch/master?svg=true)](https://ci.appveyor.com/project/karbassi/language-todotxt/branch/master)

[![Gitter chat](https://badges.gitter.im/todotxt/language-todotxt.png)](https://gitter.im/todotxt/language-todotxt)

## License

Copyright (c) 2011, Philipp Fehre  All rights reserved.

Copyright (c) 2014, 2017, Brandon Padgett  All rights reserved.

Copyright (c) 2017, 2018 Evan Prodromou  All rights reserved.

Redistribution and use in source and binary forms, with or without modification,

are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list

of conditions and the following disclaimer. Redistributions in binary form must

reproduce the above copyright notice, this list of conditions and the following

disclaimer in the documentation and/or other materials provided with the

distribution. Neither the name of the TU München nor the names of its

contributors may be used to endorse or promote products derived from this

software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY

THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED

WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT

SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

## Code of conduct

This project has adopted a [code of conduct](https://github.com/todotxt/language-todotxt/blob/master/CODE_OF_CONDUCT.md)

in order to be welcoming to all participants.

## Commands

When you are in todo.txt mode, you have access to the following commands:

- `todotxt:add`: add a new task on the line below the current line

- `todotxt:done`: mark the task on the current line done

- `todotxt:priority-a` set the priority of the current task to A

- `todotxt:priority-b` set the priority of the current task to B

- `todotxt:priority-c` set the priority of the current task to C

- ... (same thing for D-Y)

- `todotxt:priority-z` set the priority of the current task to Z

There is also an autocompletion function when you are typing out a context or

a priority.

## Useful packages for todo.txt files

One nice thing about the todo.txt format is that it's easily managed with basic

text sorting and filtering tools. Here are some that are available for Atom:

- [sort-lines](https://github.com/atom/sort-lines). It sorts lines. Very useful

  for todo.txt.