Atom

Represents a project that's opened in Atom.

An instance of this class is always available as the atom.project global.

Invoke the given callback when the project paths change.

callback(projectPaths)

Function to be called after the project paths change.

projectPaths

An Array of String project paths.

Returns a Disposable on which .dispose() can be called to unsubscribe.

Invoke the given callback when a text buffer is added to the project.

callback(buffer)

Function to be called when a text buffer is added.

buffer

A TextBuffer item.

Returns a Disposable on which .dispose() can be called to unsubscribe.

Invoke the given callback with all current and future text buffers in the project.

callback(buffer)

Function to be called with current and future text buffers.

buffer

A TextBuffer item.

Returns a Disposable on which .dispose() can be called to unsubscribe.

Invoke a callback when a filesystem change occurs within any open project path.

const disposable = atom.project.onDidChangeFiles(events => {
  for (const event of events) {
    // "created", "modified", "deleted", or "renamed" 
    console.log(`Event action: ${event.type}`)
 
    // absolute path to the filesystem entry that was touched 
    console.log(`Event path: ${event.path}`)
 
    if (event.type === 'renamed') {
      console.log(`.. renamed from: ${event.oldPath}`)
    }
  }
}
 
disposable.dispose()

To watch paths outside of open projects, use the watchPaths function instead; see PathWatcher.

When writing tests against functionality that uses this method, be sure to wait for the Promise returned by {getWatcherPromise()} before manipulating the filesystem to ensure that the watcher is receiving events.

callback(events)

Function to be called with batches of filesystem events reported by the operating system.

events

An Array of objects that describe a batch of filesystem events.

action

String describing the filesystem action that occurred. One of "created", "modified", "deleted", or "renamed".

path

String containing the absolute path to the filesystem entry that was acted upon.

oldPath

For rename events, String containing the filesystem entry's former absolute path.

Returns a Disposable to manage this event subscription.

Get an Array of GitRepositorys associated with the project's directories.

This method will be removed in 2.0 because it does synchronous I/O. Prefer the following, which evaluates to a Promise that resolves to an Array of Repository objects:

Promise.all(atom.project.getDirectories().map(
    atom.project.repositoryForDirectory.bind(atom.project)))

Get the repository for a given directory asynchronously.

directory

Directory for which to get a Repository.

Returns a Promise that resolves with either:

Repository if a repository can be created for the given directory
null if no repository can be created for the given directory.

Get an Array of Strings containing the paths of the project's directories.

Set the paths of the project's directories.

projectPaths

Array of String paths.

Add a path to the project's list of root paths

projectPath

String The path to the directory to add.

Access a Promise that resolves when the filesystem watcher associated with a project root directory is ready to begin receiving events.

This is especially useful in test cases, where it's important to know that the watcher is ready before manipulating the filesystem to produce events.

projectPath

String One of the project's root directories.

Returns a Promise that resolves with the PathWatcher associated with this project root once it has initialized and is ready to start sending events. The Promise will reject with an error instead if projectPath is not currently a root directory.

remove a path from the project's list of root paths.

projectPath

String The path to remove.

Get an Array of Directorys associated with this project.

Get the path to the project directory that contains the given path, and the relative path from that project directory to the given path.

fullPath

String An absolute path.

Returns an Array with two elements:

projectPath The String path to the project directory that contains the given path, or null if none is found.
relativePath String The relative path from the project directory to the given path.

Determines whether the given path (real or symbolic) is inside the project's directory.

This method does not actually check if the path exists, it just checks their locations relative to each other.

Basic operation

# Project's root directory is /foo/bar 
project.contains('/foo/bar/baz')        # => true 
project.contains('/usr/lib/baz')        # => false

Existence of the path is not required

# Project's root directory is /foo/bar 
fs.existsSync('/foo/bar/baz')           # => false 
project.contains('/foo/bar/baz')        # => true

pathToCheck

String path

Returns whether the path is inside the project's root directory.

Project extended

Event Subscription

::onDidChangePaths(callback)

::onDidAddBuffer(callback)

::observeBuffers(callback)

::onDidChangeFiles(callback)

Accessing the git repository

::getRepositories()

::repositoryForDirectory(directory)

Managing Paths

::getPaths()

::setPaths(projectPaths)

::addPath(projectPath)

::getWatcherPromise(projectPath)

::removePath(projectPath)

::getDirectories()

::relativizePath(fullPath)

::contains(pathToCheck)