Speare
Version 1.2.22

Speare is an ultra lightweight code editor and small IDE that has a designedly graphical user operation interface smoothly support editing multiple files that written with different programming languages simultaneously. It was originally developed to provide a native scripting language debugging environment that seamlessly integrated with C and C++. You can use the free version to debug C and C++ project. Speare Pro is the advanced version that has IDE features especially scripting language debugging environment supported. It supports debugging applications that written with C, C++, Ruby, Lua, Python, PHP and Perl. The most important feature of Speare is that it support extend the debuggers by yourself and directly switch between any version of self-compiled scripting language interpreters.

It's free!




If you can't open the link above, please launch App Store and found Speare by searching.

Code editor and IDE on macOS

Terminal based on text editors such as GNU Emacs and Vim, although they are very cool, but their limitations are also obvious, the elephant in the room. TextMate is my favourite code editor long years ago and until today, but it still lack some features. As a programmer, so many IDE and text editors I've used in the past years, such as the bulky cargos, Visual Studio Code, Atom, Android Studio, Eclipse, ActiveState Komodo, ZeroBraneStudio, Xcode, and some light cargos, e.g. Textadept, CotEditor and TextMate. I never like the bulky cargos, e.g. desktop applications that built with NodeJS, React and Electron, Eclipse and Java or .NET and C# based big stuffs. Speare code editor is a small, free and friendly code editor which implements the most important missing features in common code editors, e.g. bookmark and fast locate code lines between multiple files, code block live parsing etc.

They make software as big as possible, as complex as possible, but I believe in the opposite philosophy.

No. Code Editor Size No. IDE Size
1Speare 1.2.19 4.6MB 6 Visual Studio Code (bare system) 1.36.1 211MB
2TextEdit 1.13 5.6MB 7 ActiveState Komodo 11.1 334MB
3TextMate 1.5.7 23.3MB 8Atom 1.38.2 558MB
4Textadept 10.4 35MB 9 ZeroBraneStudio 2019 612MB
5CotEditor 3.3 47MB 10 Android Studio 3.1 1.37GB
11 Eclipse IDE 4.12 400MB~5GB
12 Xcode 10.0 12GB

Why not big software?

Waste time to maintain, wast big storage, waste power, waste time to upload, download. It's waste people's life! Every desktop developer should known one thing, the embedded system developers sometime even fighting for one byte of storage in some situation. They never think about memory and storage like embedded system developers, so more and more big monster there. In today's software industry, Unix philosophy has been throw away completely!

Screenshot




Features

  1. Well designed user operation interface. Intuitive and simple.
  2. Fast search and replace in different searching scope, current document, opened files and entire project.
  3. High performance of managing large amount of files and big files. Multiple distributed folder management by simple project file.
  4. Smoothly edit multiple files that written in different programming languages simultaneously. Supports almost all common programming languages syntax highlighting and parsing, quickly switch between files and projects.
  5. Word autocomplete, sensitivity of keywords when typing, live parsing symbol definition for suggested words list.
  6. Jump to definition and fast locate code lines between editing files by symbol index, bookmark or searching.
  7. Unlimited go back and forward, automatically remember the sequence of current editing locations of file and files.
  8. Keeping entire state after quit, the opened files, selection of each file and the cursor location.
  9. Customisation of fonts and colours for the text editor.
  10. Run Javascript code and preview html or markdown files in builtin web browser instantly.
  11. Ultra lightweight.

Other Builtin Features:
a. C and C++ debugging with LLDB.
b. Binary file automatically detection.
c. Text encodings automatically detection when open file and convert to UTF-8 by default.
d. Code block selection by double clicking the begin symbol of code block.
e. Preview all kinds of files, image, pdf, office documents, audio and video etc.

File Organisation

1. Add File or Folder in Workspace

a. Drag file or folder from Finder into Treeview directly.
b. Click "+" symbol on the bottom of Treeview.
c. Create temporary document:
Click menu: File → New
Click "+" symbol on the top of tabs view.
d. Click menu: File → Open Recent.

2. Remove File or Folder from Workspace

a. Click "-" symbol on the bottom of Treeview.
b. Use "Command key + D" shortcut to do the deleting.
c. Click menu: File → Delete.
Note: Delete operation supports multiple item selection.

SPP File

SPP File is the abbreviation of "Speare Project Plist" file, it is the project file type of Speare that has an .spp file extension and be used to index distributed file and folder together.

  1. Create SPP File
    Click menu: File → Save as Speare Project file. This operation will store the root path of the nodes in the left side Treeview as a .spp file.

  2. Open SPP File
    Directly dragging the .spp file into Treeview, or select menu "File" → "Open", will load all indexed file and folder stored in the .spp file into the left side Treeview (Workspace Explorer).

Working with SPP files is not necessarily required but it will be more convenient when packaging the distributed paths of file and folder together as .spp files in most usage scenarios.

Search and Replace

  1. Search Current Document:
    a. Use shortcut key "Control + F" to do the searching just like in TextEdit.
    b. Click search button on the toolbar and on the prompt dialog select "Current".

  2. Search Opened Files:
    Click search button on the toolbar and on the prompt dialog select "In Tabs".

  3. Search Entire Project Folders:
    Click search button on the toolbar and on the prompt dialog select "In Project".

  4. Searching by Index:

    a. Click symbol button on the toolbar and select items that parsed by the build-in syntax parsers.

    b. Click breakpoint button on the toolbar and select items that placed as bookmark or breakpoint.
  5. Searching items in left side Treeview:
    Input the item name (or prefix or suffix, or contained word) in the search field which located in the bottom of the left side Treeview and then enter "Return" key, click up and down arrow right side of the search field to iterate items.

Brief & History: each search result has brief of the source line and all be classified, and the history of search words remembered automatically, click the down arrow of the search field will allow to select the searched items in history.

Tab Selection and Dragging

Speare use tabs to manage multiple opened files on the right side, continuously click on the leftmost or rightmost tab can quickly scroll tabs to left side or right side so that opened files can be quickly switched. Dragging special tabs together will also can help simultaneously editing multiple files.

File Rename and Save

1. File Rename
Click the item in the left side Treeview and input a new file name just like in Finder, and then click the left side icon to end editing.

2. File Save
Speare can save file automatically whenever it be edited but the temporary "Untitled files" will be asked to save when quit the app or load a .spp file, because load a .spp file will empty current Treeview.
In addition, Speare will change the icon colour of the item in the left side Treeview to indicate that it has been edited whenever it be edited, and will restore to default state when click the "Save" or "Save All" button on the toolbar.

Jump To Definition

Ensure the keyword selected and then right click one of the popped menu items. Speare provides all location where the symbol defined including header file and implement file.

Bookmark & Breakpoint

1. Add: click the line number.
2. Toggle: click on the marker, its colour will changed to dark or light, dark colour means breakpoint in debug mode.
3. Delete: right click on the marker → on the prompt menu, select "Remove".

Show in Finder

Right click the item in the left side Treeview (Workspace Explorer) and then click the prompt menu.

Back and Forward

Just click the "Back" or "Forward" button on the toolbar to switch different edited location in a same file or switch between the files that was being editing.

File OverWrite

When you overwrite a file in Finder, Speare will ask you to reload it, you should save this file manually if you click "Cancel".
Note: click right side tab will select the left side corresponding file node automatically when the Treeview refreshed.

Colour Picker

Right click current editing file → select "Colour Picker" on the prompt menu, then a HTML colour will be inserted when pick a colour.

Customise Font and Colour

Click menu item "Preferences" and then set font and colour of editor background etc.

Markdown & HTML

1. Preview: select menu "View" → "Preview", see html or markdown file rendered in builtin web browser instantly.
2. Close Preview: select menu "View" → "Close Preview", close the opened builtin web browser.
3. Save Markdown: select menu "View" → "Save Markdown", save the generated html to local file, Speare has a builtin converter that can convert markdown to html instantly.

Note: a. supported file extensions: .htm, .html, .md, .mdown, .markdown.
b. click any file item in the left side Treeview will also close preview automatically.

Lite Mode

Click siding button on toolbar and click menu "View → Hide Toolbar" then the app can be changed to an TextEdit-like editor.

Debug Mode

Speare Pro seamlessly support debugging C, C++, Ruby, mruby, Lua, Python, PHP and Perl script, more info see here: → Speare debugger architecture.

File and Folder Filter

1. Click menu: View → Don't Show Hidden Files. Hide or display all hidden files.

2. Speare code editor uses a file named as ".speareignore" to hidden directory and file that you don't want it displayed in the left side Treeview (Workspace Explorer).

# 1. exclude directories by folder name (must end with /).
dist/
build/
.git/
.svn/
.hg/
CVS/
.deps/
.libs/
...

# 2. exclude directories by full path (must end with /).
/xxxx/xxx/xxx/data/
/xxxx/xxx/xxx/xxx/resource/
...

# 3. exclude files by specified extension.
*.o
*.lo
*.la
*.so
*.class
*.gz
*.tar
*.zip
*.7z
*.iso
*.jar
...
(must starts with *.)
# 4. exclude files by file name.
.DS_Store (already ignored by builtin function)
someFile
someOtherFile
...

# 5. exclude files by full path.
/xxxx/xxx/xxx/someFile
/xxxx/xxx/xxx/xxx/someOtherFile
...

a. Line starts with '#' is comment.
b. Each line contains a folder name, full path of folder or file name, file extension, or full path of file.

3. Create or edit .speareignore:
$ touch ~/Desktop/speareignore.txt
$ cp ~/Desktop/speareignore.txt /xxxx/xxxx/.speareignore:
Put the file in your root of source code folder.
$ cp /xxxx/xxxx/.speareignore ~/Desktop/speareignore.txt:
Edit the filter again.
$ cp ~/Desktop/speareignore.txt /xxxx/xxxx/.speareignore:
Save it back again.

Note:
a. When overwrite file or folder in Finder, they will not be asked to reload if they were set to be ignored.
b. You can directly edit file .speareignore in Speare code editor and click "Refresh" button on the bottom of the left site TreeView to reload the project folder.

Important Tips

1. Use ESC key or arrow key or 'Control+Z' to get out of suggested words list selection.
2. Please ensure all source code file and resource files have been dragged in the left side Treeview (Workspace Explorer) before start a debug session, because macOS app can't be allowed to access files outside of its sandbox.
3. When your source code file moved to another folder, you must drag the source code folder in Speare again then the debugging can correctly work.

FAQ

1. How to add syntax highlighting to support a new file type?
A: open /Applications/Speare.app/Contents/Resources/SyntaxDefinitions.plist,
carefully add the file extension name of the new file type in it, and each extension name separated by a space, e.g. syntax highlighting all .jsx:

<dict>
  <key>name</key>
  <string>JavaScript</string>
  <key>file</key>
  <string>javascript</string>
  <key>extensions</key>
  <string>js jsx</string>
</dict>

2. How to add "Open With" in Finder to support open a file type with Speare?
A: Right click the file in Finder → Get Info → Open With: Other..., find Speare.app and select, and then Click "Change All..." button.

Programming Languages and Document Types

AMPL ASM ASP AWK Ada ActionScript Active4D AnsiblePlaybook Ant Apache Applescript Asciidoc AutoIt Autoconf Automake Basic Batch Beta Bibtex C C# C++ CMake CPrePro CSS Scss CUDA Clojure Cobol CoffeeScript ColdFusion Csound Ctags D DTS DbusIntrospect Diff DosBatch PowerShell Dtd Dylan Eiffel Elixir Elm Erlang eZ Publish F-Script Falcon Flex Forth Fortran FreeFem++ Fypp GEDCOM Gdbinit Glade Go Gradle GraphViz Groovy Haskell HTML Haxe Header IDL ITcl Iniconf Inko JSP Java JavaFX JavaProperties JavaScript Json Julia Kotlin Kuin LSL LaTeX LdScript Lilypond Lisp Logtalk Lua M4 MEL Makefile Man Markdown MATLAB Maven2 MetaPost Metaslang Moose MySQL Myrddin NASL NEURON Nemerle Objective-C Octave Ocaml Ox PDF PHP Parrot Pascal Passwd Perl Perl6 Pig Plist Pod PostScript Prolog Processing Protobuf Puppet PuppetManifest Python PythonLoggingConfig QemuHX QtMoc R R/S-PLUS RHTML RSpec RelaxNG Rexx Robot Racket RpmSpec Rst Ruby mruby Rust SGML SML SQL Scala Scheme Sedona Shell Slang Smalltalk Snippets Stata SuperCollider SVG Swift SystemTap SystemdUnit TTCN Tcl Tcl/Tk Tex TorqueScript TypeScript Udo VB VB.NET VHDL Vera Verilog SystemVerilog Vim WSDL WindRes XML XSD Xquery Xslt Yacc Yaml YumRepo Zephir

Support

If your special programming language, compiler, interpreter or special document type requires Spear syntax highlighting or debugging support, please drop us a message.

Request and issue management on Github: https://github.com/chengdu/Speare.