Automatic Tasks - The ~~missing feature~~ best extension for Panic's Nova editor

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is the source code for Little Green Man's Automatic Tasks extension for Panic's Nova editor (phew). It was first established to plug holes that we had in our workflow, but addresses a key feature offered by most editors, and a great extension for Nova. As the feature set grows, it becomes more obvious why Panic may leave this functionality out of Nova itself, but we'd sure appreciate support, review and PRs from them to make it the best it can be.

What does it do? In short, auto-populate the editors tasklist with tasks from your project files (Node, Composer, Maidfile and Taskfile at the moment). But also:

• Allows you to modify use of npm/yarn on a per-project basis
• Allows you to choose which features to enable (per-project also)
• Watches files to automatically update the task list on file changes

(back to top)

Built With

This project was built with the following libraries and helpers.

• TypeScript
• ESBuild

(back to top)

Getting Started

If you just want to install the extension in Nova, then load Nova, load the Extension Library (shift-cmd-2), search for "Automatic Tasks" and press install.

Otherwise, to hack on it, develop it and/or load a local copy in Nova, carry on reading.

Prerequisites

• nodejs
• yarn
• Nova

Developing the Extension

1. Clone the repo

   git clone https://github.com/little-green-man/nova-taskfinder.git

2. Install NPM packages

   yarn

3. Build the extension

   yarn watch # or yarn build

4. Activate the extension Disable the formal extension from Panic, by unchecking it in the Extension Library.

   yarn activate

   Finally, minimise the window that opens for ./build/taskfinder.novaextension, as you don't want to edit these files.
5. Edit the files in the src, run yarn build, and Nova will automatically reload the extension (from your minimised window)

(back to top)

Usage

The extension is submitted to the Panic Extension store by Little Green Man Ltd, following merged pull requests.

You just need to load Nova, load the Extension Library (shift-cmd-2), search for "Automatic Tasks" and press install.

Of course, if you fork the extension or prefer to submit your own variant, then you may do (having first modified the name, build/extension.js file, readme, changelog and more, choose Extension > Submit to the Extension Library... from Nova's menu).

(back to top)

Roadmap

• Move to TypeScript
• Build testing in
• Find a solution to #10

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature), make and test your changes
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Elliot - @elliot, or hello [at] lgm.ltd

Project Link: https://github.com/little-green-man/nova-taskfinder

(back to top)

Acknowledgments

So many thanks go to:

• Sajjaad Farzad
• Reüel van der Steege

(back to top)