Hammerspoon/hammerspoon

CFPreferences

Open

#1441 opened on May 30, 2017

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Objective-C (15,415 stars) (688 forks)batch import
extension suggestionhelp wanted

Description

In researching #1437 it seems that a fair number of macOS system components work by setting preference values with CFPreferences API calls and NSDistributedNotification messages. We already support the latter, and adding the former doesn't look like it would be a huge amount of work.

Contributor guide

Tech stack
objective c
Domain
desktop
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with macOS preferences systemBasic Objective C knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding support for CFPreferences API calls to Hammerspoon, similar to existing NSDistributedNotification support. Start by examining how the NSDistributedNotification module is implemented in the codebase, likely in an Objective C class. Then research CFPreferences API documentation (Apple docs) and plan how to expose it as a Lua module. Check comments in issue #1441 for any proposed design. The implementation should be relatively isolated, possibly in a new file or extension of existing preferences module.