• Stars
    star
    255
  • Rank 154,569 (Top 4 %)
  • Language
    Swift
  • License
    BSD 3-Clause "New...
  • Created 9 months ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An editor for macOS

Build Status Documentation Discord

Chime

An editor for macOS

Download the latest release on the website.

Goals:

  • develop modular, open source components
  • be an editor people enjoy using
  • support cool extensions

Features:

  • completions
  • command line tool
  • document/project-scoped search
  • editorconfig
  • extensions
  • file navigator
  • syntax highlighting (driven by tree-sitter and LSP)
  • structure highlighting
  • semantic symbol information
  • textual/symbolic quick open
  • UI theming

Project State

The code in this repo should be considered non-functional right now. If you want to use Chime, you can download the currently released version.

Chime used to be commercial, but is now free. It built up some pretty significant cruft over time. In particular, the core UI application architecture is just in a bad state. It is also quite complex to build. So, I've opted to re-implement that core and pull in parts as appropriate. I'll be putting an emphasis on extracting components into packages as I go. A fitting rebirth, I would say.

Contributing

It is always a good idea to discuss before taking on a significant task. That said, I have a strong bias towards enthusiasm. If you are excited about doing something, I'll do my best to get out of your way.

The project is internally documented with DocC. The docs contains details about getting started, structure, and internal systems/behaviors. A Discord server is also available for live help, but GitHub issues/discussions is preferred.

There are a few areas that would make for excellent targets though, if you really feel so inclined.

  • I'd love to expand on more universal theme support
  • The text search system is bad and I'd love to build something better
  • The view-based extension system could really use some more attention
  • I'd like to finish migrating the preferences to SwiftUI
  • Support for the Debug Adapter Protocol
  • The autocomplete result window isn't very pretty

By participating in this project you agree to abide by the Contributor Code of Conduct.

Building

Note: requires Xcode 15 and macOS 14

  • clone the repo
  • git submodule update --init --recursive
  • cp User.xcconfig.template User.xcconfig
  • update User.xcconfig with your personal information
  • build/run with Xcode

Why the submodules you ask? Chime embeds many of its extensions inside the application itself for ease of installation. However, because of limitations in how you can influence the linking process with SPM, I cannot figure out how to use SPM and also link against the included ChimeKit.framework.

Guidelines

  • SwiftUI where possible, AppKit where useful
  • using packages is a wonderful way to support open source software
  • supporting older versions of macOS is nice, not critical

Conventions

  • tabs for indentation
  • configuration in xcconfig files
  • project resources are sorted alphabetically
  • imports are sorted by alphabetically, but partitioned to system/non-system

Significant Issues

Chime is a reasonably complex project. It's bound to run into bugs in Apple frameworks, Xcode, and other systems that present a real problem to its development. This is a list of the most serious issues, which have a major impact on either the user or developer experience.

  • FB12094161: System Settings extension approval system does not appear to work
  • FB11716027: EXAppExtensionBrowserViewController duplicate apps
  • FB11748287: Static metadata for extension available in AppExtensionIdentity
  • FB13384096: Package with non-Swift target fails to build unless explicitly linked
  • Add macOS 14 (Sonoma) Runner Image

Other Notable Projects

More Repositories

1

Impact

Crash capturing library for Apple platforms
C
431
star
2

Neon

A Swift library for efficient, flexible content-based text styling
Swift
297
star
3

ConcurrencyPlus

Utilities for working with Swift Concurrency
Swift
255
star
4

SwiftTreeSitter

Swift API for the tree-sitter incremental parsing system
Swift
236
star
5

Meter

Library for interacting with MetricKit
Swift
210
star
6

OperationPlus

NSOperation's missing pieces
Swift
127
star
7

SwiftLSPClient

A Swift library for interacting with Language Server Protocol implementations
Swift
103
star
8

LanguageClient

Language Server Protocol (LSP) client for Swift
Swift
90
star
9

TextStory

Happier, more flexible NSTextStorage
Swift
86
star
10

Rearrange

Swift library for working with ranges types: NSRange, NSTextRange, Range, UITextRange, and String.Index
Swift
66
star
11

WindowTreatment

Tools for happier work with NSWindow
Swift
61
star
12

LanguageServerProtocol

Swift library for working with Language Server Protocol (LSP)
Swift
56
star
13

ChimeKit

Framework for building Chime extensions
Swift
48
star
14

TextViewPlus

Make life better with NSTextView+TextKit 1/2
Swift
42
star
15

Extendable

A set of utilities for more pleasant work with ExtensionKit
Swift
42
star
16

TextFormation

Rules system for live typing completions
Swift
42
star
17

Wells

A lightweight diagnostics report submission system
Swift
39
star
18

OAuthenticator

OAuth 2.0 request authentication
Swift
39
star
19

ProcessService

Host an executable within an XPC service
Swift
39
star
20

UITestingPlus

Utilities for working with XCUI testing
Swift
38
star
21

NicerTouchBar

Utilities for a more pleasant NSTouchBar development experience
Swift
34
star
22

TextViewBenchmark

A suite of performance tests for macOS text views
Swift
32
star
23

KeyCodes

AppKit Carbon key codes to UIKey-compatible enums
Swift
31
star
24

MeterReporter

Lightweight MetricKit-based diagnostics reporting
Swift
31
star
25

Flexer

Lexing library for Swift
Swift
30
star
26

AsyncXPCConnection

Concurrency support for NSXPCConnection
Swift
30
star
27

JSONRPC

Swift library for JSON-RPC
Swift
24
star
28

ProcessEnv

Capture the shell environment of a Foundation app
Swift
24
star
29

ContainedDocument

Nested NSDocuments
Swift
24
star
30

Dusk

Micro-framework to aid in supporting Dark Mode on macOS
Swift
21
star
31

Glyph

Make life with TextKit better
Swift
21
star
32

ScrollViewPlus

A more pleasant NSScrollView experience
Swift
15
star
33

Welp

Tooling for macOS help books
Swift
15
star
34

XPCConnectionSession

Backwards-compatible implementation of XPCSession
Swift
13
star
35

EditorConfig

A Swift library for working with .editorconfig files
Swift
12
star
36

GlobPattern

Swift package to parse and evaluate glob patterns
Swift
12
star
37

Background

Background Tasks and Networking
Swift
12
star
38

Outline

Lazy SwiftUI wrapper for NSOutlineView
Swift
10
star
39

ImpactMeterAdapter

Impact crash reports as a Meter diagnostic source
Swift
10
star
40

Gramophone

Swift library for working with Extended Backus–Naur Form (EBNF) notation and grammars.
Swift
10
star
41

ViewPlus

Make working with NSView more pleasant
Swift
10
star
42

UnifiedLoggingPlus

Micro-framework for making OSLog more pleasant
Swift
10
star
43

CoreSymbolication

Headers and package for CoreSymbolication
Swift
10
star
44

LanguageServer

Language Server Protocol server infrastructure for Swift
Swift
9
star
45

SwiftCoreSymbolication

Swift wrappers for CoreSymbolication
Swift
9
star
46

chime-swift

A Chime extension for Swift
Swift
9
star
47

DebugAdapterProtocol

Swift library for working with Debug Adapter Protocol (DAP)
Swift
7
star
48

Textbook

Easier NSTextView and SwiftUI
Swift
7
star
49

paddleapi

Go implementation of the Paddle API
Go
6
star
50

SourceView

A TextKit 2 `NSTextView` subclass built specifically to work with source code
Swift
6
star
51

MetricKitViewer

A really simple app for viewing MetricKit payloads
Swift
5
star
52

Ligature

Text selection, grouping, indentation, and manipulation in Swift
Swift
5
star
53

chime-ruby

A Chime extension for Ruby
Swift
4
star
54

ThemePark

A Swift library for working with syntax highlighting/IDE themes
Swift
4
star
55

chime-rust

A Chime extension for Rust
Swift
4
star
56

STTextView-Plugin-TextFormation

Source Code Typing Completions
Swift
4
star
57

RelativeCollections

Swift collection types that support efficient storage of order-relative values.
Swift
4
star
58

Lowlight

A simple syntax processing system that prioritizes latency over correctness
Swift
4
star
59

gogsym

Go library for reading GSYM files
Go
3
star
60

chime-markdown

A Chime extension for Markdown
3
star
61

LanguageServerScripts

A collection of standardized scripts for managing LSP language servers with a Swift API
Shell
3
star
62

chime-elixir

A Chime extension for Elixir
Swift
2
star
63

binarycursor

Go binary data reader
Go
2
star
64

chime-python

A Chime extension for Rust
Swift
2
star
65

chime-go

A Chime extension for Go
Swift
1
star
66

chime-clojure

A Chime extension for Clojure
Swift
1
star
67

marpa-xcframework

XCFramework wrapper for libmarpa
C
1
star
68

Borderline

System for working with text line numbers in Swift
Swift
1
star