clojure / clojure-cheatsheets Goto Github PK
View Code? Open in Web Editor NEWThis project forked from dsevilla/clojure-cheatsheets
Cheatsheets and information for Clojure/JVM and ClojureScript
Home Page: https://clojure.org/api/cheatsheet
This project forked from dsevilla/clojure-cheatsheets
Cheatsheets and information for Clojure/JVM and ClojureScript
Home Page: https://clojure.org/api/cheatsheet
* Clojure * Copyright (c) Rich Hickey. All rights reserved. * The use and distribution terms for this software are covered by the * Eclipse Public License 1.0 (https://opensource.org/license/epl-1-0/) * which can be found in the file epl-v10.html at the root of this distribution. * By using this software in any fashion, you are agreeing to be bound by * the terms of this license. * You must not remove this notice, or any other, from this software. Docs: https://clojure.org Feedback: https://ask.clojure.org Getting Started: https://clojure.org/guides/getting_started To build and run locally with Ant: One-time setup: ./antsetup.sh To build: ant local To run: java -jar clojure.jar To build locally with Maven: To build (output JARs in target/): mvn package To build without testing: mvn package -Dmaven.test.skip=true To build and install in local Maven repository: mvn install To build a standalone jar with dependencies included: mvn -Plocal -Dmaven.test.skip=true package To run with the standalone jar: java -jar clojure.jar -------------------------------------------------------------------------- This program uses the ASM bytecode engineering library which is distributed with the following notice: ASM: a very small and fast Java bytecode manipulation framework Copyright (c) 2000-2011 INRIA, France Telecom All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 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 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ------------------------------------------------------------------------- This program uses the Guava Murmur3 hash implementation which is distributed under the Apache License: Apache License Version 2.0, January 2004 https://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) 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. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS
At present, the cheatsheets don't do especially well in terms of flowing to screen width. In my efforts to make Grimoire's frontpage as clean as possible, I stumbled upon masonry.js, an MIT licensed, jquery optional plugin which allows for exactly the kind of automatic tiling I'd like to see the cheat sheet (or at least a Grimoire build) display.
Happy to do this work, just thought I'd pre-clear it.
clojure-grimoire/grimoire/issues/36
All of Clojure's syntax special characters exist in the Cheat Sheet already, but the search tool won't select them. I propose that this is a bug rather than a feature and would be happy to take a swing at it next time I'm hacking the cheatsheet.
We are in the midst of transitioning this repo into the org.clojure organization (aka Clojure contrib). All contributors should have a signed Clojure Contributor Agreement on file.
The next step in the process is to make a public offer of contribution from the contributors. You can do so by replying to this issue with a comment that says "I agree" for the following statement:
"I offer my contributions to the clojure-cheatsheets library as a Clojure contribution: https://github.com/jafingerhut/clojure-cheatsheets. All work was created wholly by these contributors and I give my permission to release this work under the Clojure Contributor Agreement."
Tagging all contributors: @jafingerhut @arrdem @fogus @bluegray @sky-glenjamin @favila
Thanks all! If you have any questions, please contact me at [email protected] or reply here.
to Collections section, probably after list and before vector. It should include the long Java-ism for creating an empty queue, and mention that there is no literal syntax for them.
It contains doc strings for the functions mentioned in the cheat sheet, which would be useful to have in its tooltip variants.
I noticed that reduced
and reduced?
, which were added in clojure 1.5, are missing from the cheatsheet.
/
gets escaped when creating the method slug and creates the following url: http://clojuredocs.org/clojure.core/_ (which is 404).
Correct url for this method is: http://clojuredocs.org/clojure.core/_fs
The pdf versions when printed on A4 / US Letter paper can be a bit hard on the eyes for some of us.
Any chance of a single-column per page version?
Tried tweaking the code, but it seems like 2-column-ness is woven in.
Created something using the freely available krop program manually (result is 8 pages), but don't relish doing this by hand again.
At any rate, thanks for maintaining the cheatsheets :)
See article here for location of the data exported as JSON, and also the output of an automated service that updates a version converted to EDN: https://metaredux.com/posts/2019/12/14/exporting-clojuredocs-as-edn.html
with example escapes for \u hex and octal escapes, plus newline, tab, space, and if the list is short enough, all of those, or a link to where you can find all of them.
List of character literals given here is complete. Checked against Clojure 1.7.0-alpha5 source code on Feb 3 2015: http://clojure.org/reader#The%20Reader--Reader%20forms
List of escapes sequences recognized inside of Clojure string literals: \b \f \t \n \r " \ \DDD (exactly 3 octal digits, with value in range \000 thru \377 inclusive) or \uHHHH. Newlines allowed in middle of string. Java allows ' escape inside of string, but Clojure does not. Java also allows octal escapes with fewer than 3 digits, but Clojure does not.
They have some additional operations not available in other implementations, plus transient versions not available in clojure.core versions.
(:key my-map) is there, but the other one is used very frequently, too.
#inst, #uuid & #js etc. - tagged liters - should add this to cheat sheet
>!! <!! >! <! - core.async channel macros - should add
Hi,
I love the cheatsheets, but noticed that clojure.core/update is missing on this page:
http://jafingerhut.github.io/cheatsheet/clojuredocs/cheatsheet-tiptip-cdocs-summary.html
I couldn't add a "see also" entry, and I get a 404 if I click on "update" in the vector section.
Alan
It is currently only in Vector/Ops section, but it clearly is intended to work on maps, too.
http://jafingerhut.github.com/ in the README.markdown give me a 404. Perhaps README.markdown should point to the new location https://jafingerhut.github.io, for those people who stumble on to https://github.com/jafingerhut/clojure-cheatsheets and try to access the embedded link http://jafingerhut.github.com/?
== is already there, and more appropriate for comparing numbers. = always returns false when comparing between integers, float/double, and BigDecimal.
Remove not= from the same section, for the same reason.
Add not= anywhere else in the cheat sheet that = is, e.g. Misc/Compare (never mind, not= is already there).
Remove == from Misc/Compare, since it more properly belongs in numbers section.
Not understanding what that's referring to. Maybe a missing dash or underscore?
Complete list of symbols supported in Clojure 1.9 that begin with ##
is here: https://github.com/clojure/clojure/blob/master/src/jvm/clojure/lang/LispReader.java#L735-L737
##Inf
##-Inf
##NaN
In "Primitives --> Numbers --> Random", add rand-nth.
They do not require vectors as arguments, but they always return vectors as return value.
After the newly updated linked to update-keys and update-vals there is a link to the Medley GitHub repo which is no longer relevant:
'Change' | assoc assoc-in dissoc merge merge-with select-keys update update-in (clojure.set/) rename-keys map-invert (1.11) (clojure.core/) update-keys update-vals GitHub: Medley |
---|
'Change' assoc assoc-in dissoc merge merge-with select-keys update update-in (clojure.set/) rename-keys map-invert (1.11) (clojure.core/) update-keys update-vals GitHub: Medley
letfn
is missing from the cheatsheet. Though, I'm not sure how commonly-used it is, so maybe the omission is intentional?
Hi. I just noticed that the function unchecked-int
and friends are not in the Cheatsheet. Should they be added?
Alan
Not terribly distinctive new content, but makes it explicit that those operations also work on sorted sets.
Seems like "Sequences --> Seq in, Seq out --> Tail-items" should contain mention of next
.
I have the impression that definterface
(not in cheatsheet) is used at least as often as gen-interface
(included in cheatsheet). definterface
can be a little bit more convenient. Unless there's a reason to promote use of gen-interface
over definterface
, maybe it would be worth including both. (Fwiw, The Joy of Clojure 2nd ed. mentions gen-interface
exactly once, and then only to refer to the entire chapter section that is devoted to definterface
.)
Go through the list of links on this page: http://clojure.org/documentation
Add links to any of those in appropriate places in cheat sheet. For example, Namespaces has at least one obvious place to link it from in sheet. Also Atoms.
There is a new predicate double?
added to Clojure 1.9. I just found out about it and it might be a good idea to add it to Clojure cheat sheet for completeness. The right place would be Primitives > Numbers > Test
list of predicates.
Probably in the Reader Macros section: https://yobriefca.se/blog/2014/05/19/the-weird-and-wonderful-characters-of-clojure/
Some text in the tables should probably not be monospaced/code. For example:
and so on. Those should be rendered in regular proportonal font.
perhaps with a link to this article:
http://blog.jayfields.com/2011/01/clojure-using-java-inner-classes.html
With briefest phrase I can think of to describe them, and a link to documentation or additional examples.
Wait until release of clojure.data.int-map library version that guarantees they are sorted.
@hypirion noted late last night that none of these appear on the cheatsheet. Could be worth adding.
For example, for atoms, delays, futures, and promises, Agent/examine.
The doc string for deref mentions @var. One normally never needs deref/@ for a var, right? Why is it there? Wow, I can't believe I didn't know this about Clojure before:
user=> (def y 7)
user=> y
7
user=> (class y)
java.lang.Long
user=> (def x (var y))
user=> x
user=> (class x)
clojure.lang.Var
user=> @x
7
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.