Skip to content

Commit e511957

Browse files
danielbayleydanielbayley
committed
WIP: Add Integrations section to docs
1 parent 659f1b3 commit e511957

File tree

3 files changed

+114
-3
lines changed

3 files changed

+114
-3
lines changed

‎docs/v2/index.html

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -993,6 +993,71 @@ <h4>Quickstart</h4>
993993

994994
</section>
995995
</section>
996+
<section id="integrations">
997+
<h2><a href="https://github.com/jashkenas/coffeescript/wiki#tools">Integrations</a></h2>
998+
<p>It is important for any tool to play nice in the vast JavaScript ecosystem, and CoffeeScript 2 gets on well with many popular projects.</p>
999+
<ul>
1000+
<li><a href="http://js2.coffee">js2coffee</a></li>
1001+
</ul>
1002+
<h3><a href="https://github.com/jashkenas/coffeescript/wiki/Linters-and-Formatting">Linters and Formatting</a></h3>
1003+
<ul>
1004+
<li>
1005+
<p><a href="https://prettier.io">Prettier</a> with <a href="https://github.com/helixbass/prettier-plugin-coffeescript">prettier-plugin-coffeescript</a></p>
1006+
</li>
1007+
<li>
1008+
<p><a href="https://eslint.org">ESLint</a> with <a href="https://github.com/helixbass/eslint-plugin-coffee">eslint-plugin-coffee</a></p>
1009+
</li>
1010+
<li>
1011+
<p><a href="http://coffeelint.org">CoffeeLint</a></p>
1012+
</li>
1013+
</ul>
1014+
<h3><a href="https://github.com/jashkenas/coffeescript/wiki/Build-tools">Build Tools</a></h3>
1015+
<ul>
1016+
<li>
1017+
<p><a href="https://webpack.js.org">Webpack</a> with <a href="https://github.com/webpack-contrib/coffee-loader">coffee-loader</a></p>
1018+
</li>
1019+
<li>
1020+
<p><a href="https://rollupjs.org">Rollup</a> with <a href="https://github.com/lautis/rollup-plugin-coffee-script">rollup-plugin-coffee-script</a></p>
1021+
</li>
1022+
<li>
1023+
<p><a href="https://parceljs.org">Parcel</a> with <a href="https://github.com/parcel-bundler/parcel/tree/v2/packages/transformers/coffeescript">transformer-coffeescript</a></p>
1024+
</li>
1025+
<li>
1026+
<p><a href="http://browserify.org">Browserify</a> with <a href="https://github.com/jnordberg/coffeeify">coffeeify</a></p>
1027+
</li>
1028+
<li>
1029+
<p><a href="https://gulpjs.com">Gulp</a> with <a href="https://github.com/gulp-community/gulp-coffee">gulp-coffee</a></p>
1030+
</li>
1031+
<li>
1032+
<p><a href="https://gruntjs.com">Grunt</a> with <a href="https://github.com/gruntjs/grunt-contrib-coffee">grunt-contrib-coffee</a></p>
1033+
</li>
1034+
</ul>
1035+
<h3><a href="https://github.com/jashkenas/coffeescript/wiki/Frameworks-and-Testing">Frameworks and Testing</a></h3>
1036+
<ul>
1037+
<li>
1038+
<p><a href="https://jestjs.io">Jest</a> testing with <a href="https://github.com/danielbayley/jest-preset-coffeescript">jest-preset-coffeescript</a></p>
1039+
</li>
1040+
<li>
1041+
<p><a href="https://meteor.com">Meteor</a> with <a href="https://atmospherejs.com/meteor/coffeescript-compiler">coffeescript-compiler</a></p>
1042+
</li>
1043+
<li>
1044+
<p><a href="https://emberjs.com">Ember</a> with <a href="https://github.com/kimroen/ember-cli-coffeescript">ember-cli-coffeescript</a></p>
1045+
</li>
1046+
</ul>
1047+
<h3><a href="https://github.com/jashkenas/coffeescript/wiki/Text-editor-plugins">Text Editor Plugins</a></h3>
1048+
<ul>
1049+
<li>
1050+
<p><a href="https://atom.io">Atom</a> <a href="https://atom.io/packages/search?q=coffeescript">packages</a></p>
1051+
</li>
1052+
<li>
1053+
<p><a href="https://code.visualstudio.com">VSCode</a> <a href="https://marketplace.visualstudio.com/search?target=VSCode&amp;term=coffeescript">extensions</a></p>
1054+
</li>
1055+
<li>
1056+
<p><a href="https://sublimetext.com">Sublime Text</a> <a href="https://packagecontrol.io/search/coffeescript">packages</a></p>
1057+
</li>
1058+
</ul>
1059+
1060+
</section>
9961061
<section id="language">
9971062
<h2>Language Reference</h2>
9981063
<p><em>This reference is structured so that it can be read from top to bottom, if you like. Later sections use ideas and syntax previously introduced. Familiarity with JavaScript is assumed. In all of the following examples, the source CoffeeScript is provided on the left, and the direct compilation into JavaScript is on the right.</em></p>
@@ -1489,7 +1554,7 @@ <h2>Lexical Scoping and Variable Safety</h2>
14891554
<span class="cm-keyword">return</span> <span class="cm-variable">outer</span> <span class="cm-operator">=</span> <span class="cm-number">10</span>;
14901555
};
14911556

1492-
<span class="cm-variable">inner</span> <span class="cm-operator">=</span> <span class="cm-variable">changeNumbers</span>();
1557+
<span class="cm-variable-2">inner</span> <span class="cm-operator">=</span> <span class="cm-variable">changeNumbers</span>();
14931558
</pre>
14941559
</div>
14951560
</div>
@@ -2460,7 +2525,7 @@ <h2>Everything is an Expression (at least, as much as possible)</h2>
24602525

24612526
<span class="cm-variable">alert</span>((<span class="cm-keyword">function</span>() {
24622527
<span class="cm-keyword">try</span> {
2463-
<span class="cm-keyword">return</span> <span class="cm-variable">nonexistent</span> <span class="cm-operator">/</span> <span class="cm-variable">void</span> <span class="cm-number">0</span>;
2528+
<span class="cm-keyword">return</span> <span class="cm-variable">nonexistent</span> <span class="cm-operator">/</span> <span class="cm-keyword">void</span> <span class="cm-number">0</span>;
24642529
} <span class="cm-keyword">catch</span> (<span class="cm-def">error1</span>) {
24652530
<span class="cm-variable">error</span> <span class="cm-operator">=</span> <span class="cm-variable-2">error1</span>;
24662531
<span class="cm-keyword">return</span> <span class="cm-string-2">`And the error is ... ${</span><span class="cm-variable">error</span><span class="cm-string-2">}`</span>;
@@ -2821,7 +2886,7 @@ <h2>The Existential Operator</h2>
28212886
</textarea>
28222887
<pre class="placeholder-code"><span class="cm-keyword">var</span> <span class="cm-def">ref</span>, <span class="cm-def">zip</span>;
28232888

2824-
<span class="cm-variable">zip</span> <span class="cm-operator">=</span> <span class="cm-keyword">typeof</span> <span class="cm-variable">lottery</span>.<span class="cm-property">drawWinner</span> <span class="cm-operator">===</span> <span class="cm-string">"function"</span> <span class="cm-operator">?</span> (<span class="cm-variable">ref</span> <span class="cm-operator">=</span> <span class="cm-variable">lottery</span>.<span class="cm-property">drawWinner</span>().<span class="cm-property">address</span>) <span class="cm-operator">!=</span> <span class="cm-atom">null</span> <span class="cm-operator">?</span> <span class="cm-variable">ref</span>.<span class="cm-property">zipcode</span> : <span class="cm-variable">void</span> <span class="cm-number">0</span> : <span class="cm-variable">void</span> <span class="cm-number">0</span>;
2889+
<span class="cm-variable">zip</span> <span class="cm-operator">=</span> <span class="cm-keyword">typeof</span> <span class="cm-variable">lottery</span>.<span class="cm-property">drawWinner</span> <span class="cm-operator">===</span> <span class="cm-string">"function"</span> <span class="cm-operator">?</span> (<span class="cm-variable">ref</span> <span class="cm-operator">=</span> <span class="cm-variable">lottery</span>.<span class="cm-property">drawWinner</span>().<span class="cm-property">address</span>) <span class="cm-operator">!=</span> <span class="cm-atom">null</span> <span class="cm-operator">?</span> <span class="cm-variable">ref</span>.<span class="cm-property">zipcode</span> : <span class="cm-keyword">void</span> <span class="cm-number">0</span> : <span class="cm-keyword">void</span> <span class="cm-number">0</span>;
28252890
</pre>
28262891
</div>
28272892
</div>

‎documentation/sections/integrations.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## [Integrations](https://github.com/jashkenas/coffeescript/wiki#tools)
2+
3+
It is important for any tool to play nice in the vast JavaScript ecosystem, and CoffeeScript 2 gets on well with many popular projects.
4+
5+
* [js2coffee](http://js2.coffee)
6+
7+
### [Linters and Formatting](https://github.com/jashkenas/coffeescript/wiki/Linters-and-Formatting)
8+
9+
* [Prettier](https://prettier.io) with [prettier-plugin-coffeescript](https://github.com/helixbass/prettier-plugin-coffeescript)
10+
11+
* [ESLint](https://eslint.org) with [eslint-plugin-coffee](https://github.com/helixbass/eslint-plugin-coffee)
12+
13+
* [CoffeeLint](http://coffeelint.org)
14+
15+
### [Build Tools](https://github.com/jashkenas/coffeescript/wiki/Build-tools)
16+
17+
* [Webpack](https://webpack.js.org) with [coffee-loader](https://github.com/webpack-contrib/coffee-loader)
18+
19+
* [Rollup](https://rollupjs.org) with [rollup-plugin-coffee-script](https://github.com/lautis/rollup-plugin-coffee-script)
20+
21+
* [Parcel](https://parceljs.org) with [transformer-coffeescript](https://github.com/parcel-bundler/parcel/tree/v2/packages/transformers/coffeescript)
22+
23+
* [Browserify](http://browserify.org) with [coffeeify](https://github.com/jnordberg/coffeeify)
24+
25+
* [Gulp](https://gulpjs.com) with [gulp-coffee](https://github.com/gulp-community/gulp-coffee)
26+
27+
* [Grunt](https://gruntjs.com) with [grunt-contrib-coffee](https://github.com/gruntjs/grunt-contrib-coffee)
28+
29+
### [Frameworks and Testing](https://github.com/jashkenas/coffeescript/wiki/Frameworks-and-Testing)
30+
31+
* [Jest](https://jestjs.io) testing with [jest-preset-coffeescript](https://github.com/danielbayley/jest-preset-coffeescript)
32+
33+
* [Meteor](https://meteor.com) with [coffeescript-compiler](https://atmospherejs.com/meteor/coffeescript-compiler)
34+
35+
* [Ember](https://emberjs.com) with [ember-cli-coffeescript](https://github.com/kimroen/ember-cli-coffeescript)
36+
37+
### [Text Editor Plugins](https://github.com/jashkenas/coffeescript/wiki/Text-editor-plugins)
38+
39+
* [Atom](https://atom.io) [packages](https://atom.io/packages/search?q=coffeescript)
40+
41+
* [VSCode](https://code.visualstudio.com) [extensions](https://marketplace.visualstudio.com/search?target=VSCode&term=coffeescript)
42+
43+
* [Sublime Text](https://sublimetext.com) [packages](https://packagecontrol.io/search/coffeescript)

‎documentation/v2/body.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
<%= htmlFor('transpilation') %>
4343
</section>
4444
</section>
45+
<section id="integrations">
46+
<%= htmlFor('integrations') %>
47+
</section>
4548
<section id="language">
4649
<%= htmlFor('language') %>
4750
<section id="functions">

0 commit comments

Comments
 (0)