Merge branch 'master' into one-keystroke-cljs-eval

Author: cldwalker

.travis.yml

@@ -0,0 +1,11 @@
+language: clojure
+script:
+- cd runner && lein test
+jdk:
+- oraclejdk8
+notifications:
+  irc: "chat.freenode.net#lighttable"
+  email:
+  - gabriel.horner@gmail.com
+  - mrundberget@hotmail.com
+  - kenny.evitt@gmail.com

CHANGELOG.md

@@ -1,6 +1,29 @@
 #Changes
 
-##0.0.14
+## 0.1.3
+
+* Remove fs and cheshire dependencies
+* Fix stacking for doseq
+* Use normal versions of tools.reader and cljs.analyzer instead of forks
+
+## 0.1.2
+
+* ADDED: cljc syntax highlighting
+
+## 0.1.1
+
+* FIX: Inline results stacking
+
+## 0.1.0
+
+* ADDED: Refresh connection command
+* FIX: Reeval of clojurescript namespace
+* FIX: Clojure client description to avoid confusing clojurescript users
+* Remove old behavior and pomegranate dependency for lein-light-nrepl
+* ADDED: clojurescript docs
+* Switch to semver versioning
+
+## 0.0.14
 
 * FIX: jump to source for jars and relative paths in clj/cljs
 * FIX: Clear instarepl results with "Clear inline results"

CONTRIBUTING.md

@@ -1 +1 @@
-Like with Clojure and most other big OSS projects, we have a [Contributor's Agreement](https://docs.google.com/a/kodowa.com/forms/d/1ME_PT6qLKUcALUEz1h1yerLF7vP_Rnohpb9RvMLDALg/viewform) that you have to agree to before we can merge. It's a simple adaptation of Twitter's own Contributor's Agreement and just says that by signing this you can't take the code back from us or sue us into oblivion for using it later.
+See [LightTable's main CONTRIBUTING page](https://github.com/LightTable/LightTable/blob/master/CONTRIBUTING.md).

LICENSE.md

@@ -1,180 +1,22 @@
-# Eclipse Public License - v 1.0
-
-THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
-
-## 1. DEFINITIONS
-
-"Contribution" means:
-
-<ol type="a">
-  <li>in the case of the initial Contributor, the initial code and documentation distributed under
-  this Agreement, and</li>
-
-  <li>in the case of each subsequent Contributor:
-  <ol type="i">
-    <li>changes to the Program, and</li>
-
-    <li>additions to the Program;</li>
-    where such changes and/or additions to the Program originate from and are distributed by that
-    particular Contributor. A Contribution 'originates' from a Contributor if it was added to the
-    Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions
-    do not include additions to the Program which: (i) are separate modules of software distributed
-    in conjunction with the Program under their own license agreement, and (ii) are not derivative
-    works of the Program.</li>
-</ol>
-
-"Contributor" means any person or entity that distributes the Program.
-
-"Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
-
-"Program" means the Contributions distributed in accordance with this Agreement.
-
-"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
-
-## 2. GRANT OF RIGHTS
-
-<ol type="a">
-  <li>Subject to the terms of this Agreement, each Contributor hereby grants Recipient a
-  non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works
-  of, publicly display, publicly perform, distribute and sublicense the Contribution of such
-  Contributor, if any, and such derivative works, in source code and object code form.</li>
-
-  <li>Subject to the terms of this Agreement, each Contributor hereby grants Recipient a
-  non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell,
-  offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in
-  source code and object code form. This patent license shall apply to the combination of the
-  Contribution and the Program if, at the time the Contribution is added by the Contributor, such
-  addition of the Contribution causes such combination to be covered by the Licensed Patents. The
-  patent license shall not apply to any other combinations which include the Contribution. No
-  hardware per se is licensed hereunder.
-
-  <li>Recipient understands that although each Contributor grants the licenses to its Contributions
-  set forth herein, no assurances are provided by any Contributor that the Program does not infringe
-  the patent or other intellectual property rights of any other entity. Each Contributor disclaims
-  any liability to Recipient for claims brought by any other entity based on infringement of
-  intellectual property rights or otherwise. As a condition to exercising the rights and licenses
-  granted hereunder, each Recipient hereby assumes sole responsibility to secure any other
-  intellectual property rights needed, if any. For example, if a third party patent license is
-  required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire
-  that license before distributing the Program.</li>
-
-  <li>Each Contributor represents that to its knowledge it has sufficient copyright rights in its
-  Contribution, if any, to grant the copyright license set forth in this Agreement.</li>
-</ol>
-
-## 3. REQUIREMENTS
-
-A Contributor may choose to distribute the Program in object code form under its own license
-agreement, provided that:
-
-<ol type="a">
-  <li>it complies with the terms and conditions of this Agreement; and</li>
-  <li>its license agreement:
-  <ol type="i">
-    <li>effectively disclaims on behalf of all Contributors all warranties and conditions, express
-  and implied, including warranties or conditions of title and non-infringement, and implied
-  warranties or conditions of merchantability and fitness for a particular purpose;</li>
-
-    <li>effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
-iii) states that any provisions which differ from this Agreement are offered by that Contributor
-alone and not by any other party; and</li>
-
-    <li>effectively excludes on behalf of all Contributors all liability for damages, including
-    direct, indirect, special, incidental and consequential damages, such as lost profits;</li>
-
-    <li>states that source code for the Program is available from such Contributor, and informs
-    licensees how to obtain it in a reasonable manner on or through a medium customarily used for
-    software exchange.</li></li>
-  </ol>
-</ol>
-
-<ol type="a">
-  <li>it must be made available under this Agreement; and</li>
-  <li>a copy of this Agreement must be included with each copy of the Program.
-</ol>
-
-Contributors may not remove or alter any copyright notices contained within the Program.
-
-## 4. COMMERCIAL DISTRIBUTION
-
-Commercial distributors of software may accept certain responsibilities with respect to end users,
-business partners and the like. While this license is intended to facilitate the commercial use of
-the Program, the Contributor who includes the Program in a commercial product offering should do so
-in a manner which does not create potential liability for other Contributors. Therefore, if a
-Contributor includes the Program in a commercial product offering, such Contributor ("Commercial
-Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified
-Contributor") against any losses, damages and costs (collectively "Losses") arising from claims,
-lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the
-extent caused by the acts or omissions of such Commercial Contributor in connection with its
-distribution of the Program in a commercial product offering. The obligations in this section do not
-apply to any claims or Losses relating to any actual or alleged intellectual property
-infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the
-Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control,
-and cooperate with the Commercial Contributor in, the defense and any related settlement
-negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
-
-For example, a Contributor might include the Program in a commercial product offering, Product
-X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes
-performance claims, or offers warranties related to Product X, those performance claims and
-warranties are such Commercial Contributor's responsibility alone. Under this section, the
-Commercial Contributor would have to defend claims against the other Contributors related to those
-performance claims and warranties, and if a court requires any other Contributor to pay any damages
-as a result, the Commercial Contributor must pay those damages.
-
-## 5. NO WARRANTY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
-LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR
-A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of
-using and distributing the Program and assumes all risks associated with its exercise of rights
-under this Agreement , including but not limited to the risks and costs of program errors,
-compliance with applicable laws, damage to or loss of data, programs or equipment, and
-unavailability or interruption of operations.
-
-## 6. DISCLAIMER OF LIABILITY
-
-EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE
-ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
-##7. GENERAL
-
-If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not
-affect the validity or enforceability of the remainder of the terms of this Agreement, and without
-further action by the parties hereto, such provision shall be reformed to the minimum extent
-necessary to make such provision valid and enforceable.
-
-If Recipient institutes patent litigation against any entity (including a cross-claim or
-counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program
-with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights
-granted under Section 2(b) shall terminate as of the date such litigation is filed.
-
-All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the
-material terms or conditions of this Agreement and does not cure such failure in a reasonable period
-of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement
-terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably
-practicable. However, Recipient's obligations under this Agreement and any licenses granted by
-Recipient relating to the Program shall continue and survive.
-
-Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid
-inconsistency the Agreement is copyrighted and may only be modified in the following manner. The
-Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement
-from time to time. No one other than the Agreement Steward has the right to modify this
-Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may
-assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new
-version of the Agreement will be given a distinguishing version number. The Program (including
-Contributions) may always be distributed subject to the version of the Agreement under which it was
-received. In addition, after a new version of the Agreement is published, Contributor may elect to
-distribute the Program (including its Contributions) under the new version. Except as expressly
-stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual
-property of any Contributor under this Agreement, whether expressly, by implication, estoppel or
-otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
-
-This Agreement is governed by the laws of the State of New York and the intellectual property laws
-of the United States of America. No party to this Agreement will bring a legal action under this
-Agreement more than one year after the cause of action arose. Each party waives its rights to a jury
-trial in any resulting litigation.
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2014 Kodowa, Inc. & Light Table contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -2,28 +2,84 @@
 
 The official Clojure language plugin for Light Table.
 
+## Supported Clojure versions
+
+This plugin requires projects Clojure 1.5.1 and higher. Starting with 0.2.0 this plugin will only be maintained for projects with Clojure 1.7.0 and higher.
+
+## Supported ClojureScript versions
+
+This plugin works for projects on recent versions of ClojureScript e.g. 1.7.X. For projects with ClojureScript versions 0.0-2341 and higher, Clojure 1.7.0 is required.
+
+## First ClojureScript Repl
+
+Welcome first time ClojureScript users! Please see [David Nolen's tutorial](https://github.com/swannodette/lt-cljs-tutorial) to get familiar with ClojureScript and comfortable with LightTable's repl. Note while doing that tutorial you were in a namespace. A namespace is necessary for a LightTable repl. Once you have finished the tutorial, create your own ClojureScript project with `lein new mies my-project` and eval there. If you want to add dependencies to your project, read the [below section](#clojurescript-eval) as that requires a different type of LightTable connection.
+
+## Cljc eval
+
+By default, \*.cljc files are identified as Clojure files. Thus when you eval, it will eval as a
+Clojure file. If you'd like to eval as a ClojureScript file, run the command `Editor: Set current
+editor syntax`, select `ClojureScript` and then eval.
 
 ## ClojureScript Eval
 
-There are 3 ways to eval ClojureScript, 2 of which use your ClojureScript javascript. To add one of these connections, run the command `Connect: Add Connection`. The 3 connections to choose from:
+There are 3 options to eval ClojureScript, 2 of which use your ClojureScript javascript. To add one of these connections, run the command `Connect: Add Connection`. The 3 connections to choose from:
 
 1. `Light Table UI` - Connect to the LightTable js process. Great for a headless mode, writing plugins and to try out ClojureScript features. Note, you use the ClojureScript version that comes with LightTable.
 
-2. `Browser` - Connect to a web page that has the compiled ClojureScript sourced. You must navigate the internal browser to that web page. Recommended for ease of use.
+2. `Browser` - Connect to a web page that has the compiled ClojureScript sourced e.g. `file:///path/to/index.html`. You must navigate the internal browser to that web page. Recommended for ease of use.
+
+3. `Browser (External)` - Connect to a web page that has the compiled ClojureScript sourced e.g. `file:///path/to/index.html`. In addition to navigating the external browser, you must copy the script tag into that web page. Requires more setup than the internal browser but gives you the freedom to use any browser.
+
+Note that for Browser options, compiled ClojureScript cannot be compiled with `:advanced` `:optimizations` mode.
+
+## ClojureScript Workflows
+
+For ClojureScript projects:
+
+Your project is connected to a browser. Recompile cljs outside of LT with project's cljs compile tool e.g. `lein cljsbuild auto`.
+Most changes can be evaled. However, if adding project dependencies or requires to ns, use the `:client.refresh-connection` command
+to refresh the browser page. To automate this on-save, add this to `user.behaviors`:
 
-3. `Browser (External)` - Connect to a web page that has the compiled ClojureScript sourced. In addition to navigating the external browser, you must copy the script tag into that web page. Requires more setup than the internal browser but gives you the freedom to use any browser.
+```clojurescript
+:editor.clojurescript [(:lt.objs.editor.file/on-save :client.refresh-connection)]
+```
 
+For LightTable plugins:
 
-## For Commiters
+Your project is connected to `LightTable UI`. When you save any plugin cljs file, compiled js is generated and saved. Any change
+can be eval-ed.
 
+## Connect to remote nREPL
+
+When you eval a Clojure project, Light Table automatically starts an nREPL server and connects to it. If you'd prefer to start an nREPL server,
+open the `Connections` panel, press `Add Connection` button and select the `Clojure (remote nREPL)` client. Make sure your project.clj
+has the following `:dependencies` and `:repl-options`:
+
+```clojure
+(defproject lttest "0.1.0-SNAPSHOT"
+  :description "FIXME: write description"
+  :dependencies [[org.clojure/clojure "1.6.0"]
+                 [lein-light-nrepl "X.X.X"]]
+  :repl-options {:nrepl-middleware [lighttable.nrepl.handler/lighttable-ops]})
+```
+
+For projects using Clojure >= 1.5.1 and < 1.7.0, `X.X.X` refers to `0.1.3`, an older unmaintained version.
+For projects using Clojure >= 1.7.0, `X.X.X` refers to the latest version of `lein-light-nrepl`:
+
+[![Clojars Project](http://clojars.org/lein-light-nrepl/latest-version.svg)](http://clojars.org/lein-light-nrepl)
+
+## License
+
+Distributed under the MIT License, see license.md for the full text.
+
+## For Committers
+
+* Project layout
+  * runner/: Contains uberjar to inject our nREPL middleware into a project and then start a repl
+  * lein-light-nrepl/: Contains nREPL middleware that needs to be deployed to Clojars when changed
+  * src/ and everything else: Normal LightTable plugin
 * When releasing a new plugin version and lein-light-nrepl has changed:
   * Bump lein-light-nrepl and lein-light in runner/.
-  * Update the uberjar with `lein uberjar` in `runner/target/lein-light-standalone.jar`.
+  * Update the uberjar with `lein uberjar` in `runner` to produce `runner/target/lein-light-standalone.jar`.
   * Release the new version of lein-light-nrepl to [clojars](https://clojars.org/lein-light-nrepl)
 * No process for upgrading `clojure-mode.js` until [this issue](https://github.com/LightTable/Clojure/issues/26) is addressed.
-
-###License
-
-Copyright (C) 2013 Kodowa Inc.
-
-Distributed under the EPL, see license.md for the full text.

build.sh

@@ -1,8 +1,6 @@
 #!/bin/sh
-find . -name '*.DS_Store' -type f -delete
 cd runner
 lein uberjar
-lein install
 cd ../lein-light-nrepl
 lein install
 echo " --- Done!"