Merge remote-tracking branch 'origin/master' into winreadme

Conflicts: README.md
2026-04-28 03:01:47 -04:00 · 2014-05-08 18:05:41 -07:00
parent bceed13606 5b7b3501a6
commit 5165f0df88
13 changed files with 111 additions and 61 deletions
--- a/README.md
+++ b/README.md
@@ -1,14 +1,8 @@
 ![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png)

-Atom is a hackable text editor for the 21st century.
+Atom is a hackable text editor for the 21st century, built on [atom-shell](http://github.com/atom/atom-shell), and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.

-Atom is open source and built on top of [atom-shell](http://github.com/atom/atom-shell).
-
-Atom is designed to be customizable, but also usable without needing to edit a config file.
-
-Atom is modern, approachable, and hackable to the core.
-
-Visit [atom.io](http://atom.io) to learn more.
+Visit [atom.io](https://atom.io) to learn more.

 ## Installing

@@ -18,49 +12,9 @@ Atom will automatically update when a new release is available.

 ## Building

-
-### OS X Requirements
-  * OS X 10.8 or later
-  * [node.js](http://nodejs.org/download/) v0.10.x
-  * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install)
-
-  ```sh
-  git clone https://github.com/atom/atom
-  cd atom
-  script/build # Creates application at /Applications/Atom.app
-  ```
-
-### Linux Requirements
-  * Ubuntu LTS 12.04 64-bit is the recommended platform
-  * OS with 64-bit architecture
-  * [node.js](http://nodejs.org/download/) v0.10.x
-  * [npm](http://www.npmjs.org/) v1.4.x
-  * `sudo apt-get install libgnome-keyring-dev`
-  * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2
-
-  ```sh
-  git clone https://github.com/atom/atom
-  cd atom
-  script/build # Creates application at /tmp/atom-build/Atom
-  sudo script/grunt install # Installs command to /usr/local/bin/atom
-  script/grunt mkdeb # Generates a .deb package at /tmp/atom-build
-  ```
-
-### Windows Requirements
-  * Windows 7 or later
-  * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4)
-  * [node.js - 32bit](http://nodejs.org/download/) v0.10.x
-  * [Python 2.7.x](http://www.python.org/download/)
-  * [GitHub for Windows](http://windows.github.com/)
-  * Clone [atom/atom](https://github.com/atom/atom/) to `C:\Users\<user>\github\atom\`
-  * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\<user>\github\atom\node_modules\`
-    to your PATH
-  * Open the Windows GitHub shell (NOT the Standard PowerShell, the shortcut labeled 'Git Shell' - make sure you have logged in at least once to the GitHub for Windows GUI App)
-
-  ```bat
-  cd C:\Users\<user>\github\atom
-  script\build
-  ```
+* [Linux](docs/build-instructions/linux.md)
+* [OS X](docs/build-instructions/os-x.md)
+* [Windows](docs/build-instructions/windows.md)

 ## Developing
 Check out the [guides](https://atom.io/docs/latest) and the [API reference](https://atom.io/docs/api).
--- a/build/package.json
+++ b/build/package.json
@@ -27,6 +27,8 @@
    "json-front-matter": "~0.1.3",
    "legal-eagle": "~0.4.0",
    "minidump": "0.5.x",
+    "read-package-json": "1.1.8",
+    "normalize-package-data": "0.2.12",
    "rcedit": "~0.1.2",
    "request": "~2.27.0",
    "rimraf": "~2.2.2",
--- a/docs/build-instructions/linux.md
+++ b/docs/build-instructions/linux.md
@@ -0,0 +1,23 @@
+# Linux
+
+Ubuntu LTS 12.04 64-bit is the recommended platform.
+
+## Requirements
+
+  * OS with 64-bit architecture
+  * [node.js](http://nodejs.org/download/) v0.10.x
+  * [npm](http://www.npmjs.org/) v1.4.x  
+  * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev`
+  * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2
+
+## Instructions
+
+  ```sh
+  git clone https://github.com/atom/atom
+  cd atom
+  script/build # Creates application at /tmp/atom-build/Atom
+  sudo script/grunt install # Installs command to /usr/local/bin/atom
+  script/grunt mkdeb # Generates a .deb package at /tmp/atom-build
+  ```
+
+## Troubleshooting
--- a/docs/build-instructions/os-x.md
+++ b/docs/build-instructions/os-x.md
@@ -0,0 +1,17 @@
+# OS X
+
+## Requirements
+
+  * OS X 10.8 or later
+  * [node.js](http://nodejs.org/download/) v0.10.x
+  * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install)
+
+## Instructions
+
+  ```sh
+  git clone https://github.com/atom/atom
+  cd atom
+  script/build # Creates application at /Applications/Atom.app
+  ```
+
+## Troubleshooting
--- a/docs/build-instructions/windows.md
+++ b/docs/build-instructions/windows.md
@@ -0,0 +1,23 @@
+# Windows
+
+## Requirements
+
+  * Windows 7 or later
+  * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4)
+  * [node.js - 32bit](http://nodejs.org/download/) v0.10.x
+  * [Python 2.7.x](http://www.python.org/download/)
+  * [GitHub for Windows](http://windows.github.com/)
+    to your PATH
+  * Open the Windows GitHub shell (NOT the Standard PowerShell, the shortcut labeled 'Git Shell' - make sure you have logged in at least once to the GitHub for Windows GUI App)
+  * `$env:Path = $env:Path + ";C:\path\to\atom\repo\node_modules"`
+
+## Instructions
+
+  ```bat
+  cd C:\Users\<user>\github
+  git clone https://github.com/atom/atom/
+  cd atom
+  script\build
+  ```
+
+## Troubleshooting
--- a/keymaps/win32.cson
+++ b/keymaps/win32.cson
@@ -33,6 +33,7 @@
  'pageup': 'core:page-up'
  'pagedown': 'core:page-down'
  'backspace': 'core:backspace'
+  'shift-backspace': 'core:backspace'
  'ctrl-tab': 'pane:show-next-item'
  'ctrl-shift-tab': 'pane:show-previous-item'
  'ctrl-shift-up': 'core:move-up'
--- a/package.json
+++ b/package.json
@@ -21,7 +21,7 @@
  "dependencies": {
    "async": "0.2.6",
    "atom-keymap": "^0.19.0",
-    "bootstrap": "git://github.com/atom/bootstrap.git#6af81906189f1747fd6c93479e3d998ebe041372",
+    "bootstrap": "git+https://github.com/atom/bootstrap.git#6af81906189f1747fd6c93479e3d998ebe041372",
    "clear-cut": "0.4.0",
    "coffee-script": "1.7.0",
    "coffeestack": "0.7.0",
@@ -41,7 +41,7 @@
    "nslog": "0.5.0",
    "oniguruma": "^1.0.6",
    "optimist": "0.4.0",
-    "pathwatcher": "^1.2.3",
+    "pathwatcher": "^1.2.4",
    "property-accessors": "^1",
    "q": "^1.0.1",
    "random-words": "0.0.1",
@@ -50,13 +50,13 @@
    "runas": "^0.5",
    "scandal": "0.15.2",
    "scoped-property-store": "^0.9.0",
-    "scrollbar-style": "^0.3.0",
+    "scrollbar-style": "^0.4.0",
    "season": "^1.0.2",
    "semver": "1.1.4",
    "serializable": "^1",
    "space-pen": "3.1.1",
    "temp": "0.5.0",
-    "text-buffer": "^2.2.0",
+    "text-buffer": "^2.2.2",
    "theorist": "^1",
    "underscore-plus": "^1.2.1",
    "vm-compatibility-layer": "0.1.0"
--- a/spec/editor-spec.coffee
+++ b/spec/editor-spec.coffee
@@ -2594,6 +2594,10 @@ describe "Editor", ->
        atom.workspace.open('sample-with-tabs.coffee', softTabs: true).then (editor) ->
          expect(editor.getSoftTabs()).toBeFalsy()

+      waitsForPromise ->
+        atom.workspace.open('sample-with-tabs-and-initial-comment.js', softTabs: true).then (editor) ->
+          expect(editor.getSoftTabs()).toBeFalsy()
+
      waitsForPromise ->
        atom.workspace.open(null, softTabs: false).then (editor) ->
          expect(editor.getSoftTabs()).toBeFalsy()
--- a/spec/fixtures/sample-with-tabs-and-initial-comment.js
+++ b/spec/fixtures/sample-with-tabs-and-initial-comment.js
@@ -0,0 +1,8 @@
+/**
+ * Look, this is a comment. Don't go making assumtions that I want soft tabs
+ * because this block comment has leading spaces, Geez.
+ */
+
+if (beNice) {
+	console.log('Thank you for being nice.');
+}
--- a/src/atom.coffee
+++ b/src/atom.coffee
@@ -39,7 +39,7 @@ class Atom extends Model
  # Public: Load or create the Atom environment in the given mode.
  #
  # - mode: Pass 'editor' or 'spec' depending on the kind of environment you
-  #         want to build.
+  #   want to build.
  #
  # Returns an Atom instance, fully initialized
  @loadOrCreate: (mode) ->
@@ -479,6 +479,8 @@ class Atom extends Model
    @getCurrentWindow().isFullScreen()

  # Public: Get the version of the Atom application.
+  #
+  # Returns the version text {String}.
  getVersion: ->
    @constructor.getVersion()

@@ -488,7 +490,7 @@ class Atom extends Model

  # Public: Get the directory path to Atom's configuration area.
  #
-  # Returns the absolute path to ~/.atom
+  # Returns the absolute path to `~/.atom`.
  getConfigDirPath: ->
    @constructor.getConfigDirPath()

--- a/src/editor.coffee
+++ b/src/editor.coffee
@@ -160,7 +160,7 @@ class Editor extends Model

    @displayBuffer ?= new DisplayBuffer({buffer, tabLength, softWrap})
    @buffer = @displayBuffer.buffer
-    @softTabs = @buffer.usesSoftTabs() ? @softTabs ? atom.config.get('editor.softTabs') ? true
+    @softTabs = @usesSoftTabs() ? @softTabs ? atom.config.get('editor.softTabs') ? true

    for marker in @findMarkers(@getSelectionMarkerAttributes())
      marker.setAttributes(preserveFolds: true)
@@ -317,6 +317,19 @@ class Editor extends Model
  # Public: Set the on-screen length of tab characters.
  setTabLength: (tabLength) -> @displayBuffer.setTabLength(tabLength)

+  # Public: Determine if the buffer uses hard or soft tabs.
+  #
+  # Returns `true` if the first non-comment line with leading whitespace starts
+  # with a space character. Returns `false` if it starts with a hard tab (`\t`).
+  #
+  # Returns a {Boolean},
+  usesSoftTabs: ->
+    for bufferRow in [0..@buffer.getLastRow()]
+      continue if @displayBuffer.tokenizedBuffer.lineForScreenRow(bufferRow).isComment()
+      if match = @buffer.lineForRow(bufferRow).match(/^\s/)
+        return match[0][0] != '\t'
+    undefined
+
  # Public: Clip the given {Point} to a valid position in the buffer.
  #
  # If the given {Point} describes a position that is actually reachable by the
@@ -563,7 +576,7 @@ class Editor extends Model

  bufferRowForScreenRow: (row) -> @displayBuffer.bufferRowForScreenRow(row)

-  # Public: Get the syntactic scopes for the most the given position in buffer
+  # Public: Get the syntactic scopes for the given position in buffer
  # coordinates.
  #
  # For example, if called with a position inside the parameter list of an
--- a/src/package-manager.coffee
+++ b/src/package-manager.coffee
@@ -43,7 +43,10 @@ class PackageManager

  # Public: Get the path to the apm command
  getApmPath: ->
-    @apmPath ?= path.resolve(__dirname, '..', 'apm', 'node_modules', 'atom-package-manager', 'bin', 'apm')
+    commandName = 'apm'
+    if process.platform == 'win32'
+      commandName += '.cmd'
+    @apmPath ?= path.resolve(__dirname, '..', 'apm', 'node_modules', 'atom-package-manager', 'bin', commandName)

  # Public: Get the paths being used to look for packages.
  #
--- a/src/workspace-view.coffee
+++ b/src/workspace-view.coffee
@@ -64,7 +64,7 @@ class WorkspaceView extends View
  @version: 4

  @configDefaults:
-    ignoredNames: [".git", ".svn", ".DS_Store", "Thumbs.db"]
+    ignoredNames: [".git", ".hg", ".svn", ".DS_Store", "Thumbs.db"]
    excludeVcsIgnoredPaths: true
    disabledPackages: []
    themes: ['atom-dark-ui', 'atom-dark-syntax']