mirror of
https://github.com/atom/atom.git
synced 2026-02-05 04:05:05 -05:00
108 lines
3.6 KiB
Markdown
108 lines
3.6 KiB
Markdown
# Configuration Settings
|
|
|
|
Atom loads configuration settings from the `config.cson` file in your `~/.atom`
|
|
directory, which contains CoffeeScript-style JSON:
|
|
|
|
```coffeescript
|
|
core:
|
|
hideGitIgnoredFiles: true
|
|
editor:
|
|
fontSize: 18
|
|
```
|
|
|
|
Configuration is broken into namespaces, which are defined by the config hash's
|
|
top-level keys. In addition to Atom's core components, each package may define
|
|
its own namespace.
|
|
|
|
## Configuration Glossary
|
|
|
|
- core
|
|
- disablePackages: An array of package names to disable
|
|
- hideGitIgnoredFiles: Whether files in the .gitignore should be hidden
|
|
- ignoredNames: File names to ignore across all of atom
|
|
- themes: An array of theme names to load, in cascading order
|
|
- editor
|
|
- autoIndent: Enable/disable basic auto-indent (defaults to true)
|
|
- autoIndentOnPaste: Enable/disable auto-indented pasted text (defaults to false)
|
|
- autosave: Save a file when an editor loses focus
|
|
- nonWordCharacters: A string of non-word characters to define word boundaries
|
|
- fontSize
|
|
- fontFamily
|
|
- invisibles: Specify characters that Atom renders for invisibles in this hash
|
|
- tab: Hard tab characters
|
|
- cr: Carriage return (For Microsoft-style line endings)
|
|
- eol: `\n` characters
|
|
- space: Leading and trailing space characters
|
|
- preferredLineLength: Packages such as autoflow use this (defaults to 80)
|
|
- showInvisibles: Whether to render placeholders for invisible characters (defaults to false)
|
|
- fuzzyFinder
|
|
- ignoredNames: Files to ignore *only* in the fuzzy-finder
|
|
- stripTrailingWhitespace
|
|
- singleTrailingNewline: Whether to reduce multiple newlines to one at the end of files
|
|
- wrapGuide
|
|
- columns: Array of hashes with a `pattern` and `column` key to match the
|
|
the path of the current editor to a column position.
|
|
|
|
## Reading Config Settings
|
|
|
|
If you are writing a package that you want to make configurable, you'll need to
|
|
read config settings. You can read a value from `config` with `config.get`:
|
|
|
|
```coffeescript
|
|
# read a value with `config.get`
|
|
@autosave() if config.get "editor.autosave"
|
|
```
|
|
|
|
Or you can use `observeConfig` to track changes from a view object.
|
|
|
|
```coffeescript
|
|
class MyView extends View
|
|
initialize: ->
|
|
@observeConfig 'editor.fontSize', () =>
|
|
@adjustFontSize()
|
|
```
|
|
|
|
The `observeConfig` method will call the given callback immediately with the
|
|
current value for the specified key path, and it will also call it in the future
|
|
whenever the value of that key path changes.
|
|
|
|
Subscriptions made with `observeConfig` are automatically cancelled when the
|
|
view is removed. You can cancel config subscriptions manually via the
|
|
`unobserveConfig` method.
|
|
|
|
```coffeescript
|
|
view1.unobserveConfig() # unobserve all properties
|
|
```
|
|
|
|
You can add the ability to observe config values to non-view classes by
|
|
extending their prototype with the `ConfigObserver` mixin:
|
|
|
|
```coffeescript
|
|
ConfigObserver = require 'config-observer'
|
|
_.extend MyClass.prototype, ConfigObserver
|
|
```
|
|
|
|
## Writing Config Settings
|
|
|
|
As discussed above, the config database is automatically populated from
|
|
`config.cson` when Atom is started, but you can programmatically write to it in
|
|
the following way:
|
|
|
|
```coffeescript
|
|
# basic key update
|
|
config.set("editor.autosave", true)
|
|
|
|
# if you mutate a config key, you'll need to call `config.update` to inform
|
|
# observers of the change
|
|
config.get("fuzzyFinder.ignoredPaths").push "vendor"
|
|
config.update()
|
|
```
|
|
|
|
You can also use `setDefaults`, which will assign default values for keys that
|
|
are always overridden by values assigned with `set`. Defaults are not written out
|
|
to the the `config.json` file to prevent it from becoming cluttered.
|
|
|
|
```coffeescript
|
|
config.setDefaults("editor", fontSize: 18, showInvisibles: true)
|
|
```
|