Skip to content

Commit efd6bb1

Browse files
committed
add CommonJS to js-deps table.
1 parent 6800e11 commit efd6bb1

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

docs/UsersGuide.html

+15-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="generator" content="Asciidoctor 1.5.6.1">
7+
<meta name="generator" content="Asciidoctor 1.5.6.2">
88
<meta name="author" content="Thomas Heller and Tony Kay">
99
<title>Shadow CLJS User&#8217;s Guide</title>
1010
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
@@ -4020,50 +4020,61 @@ <h4 id="_using_npm_packages"><a class="anchor" href="#_using_npm_packages"></a><
40204020
<table class="tableblock frame-all grid-all spread">
40214021
<caption class="title">Table 1. ES6 Import to CLJS Require</caption>
40224022
<colgroup>
4023-
<col style="width: 50%;">
4024-
<col style="width: 50%;">
4023+
<col style="width: 33.3333%;">
4024+
<col style="width: 33.3333%;">
4025+
<col style="width: 33.3334%;">
40254026
</colgroup>
40264027
<thead>
40274028
<tr>
40284029
<th class="tableblock halign-left valign-top">ES6 Import</th>
4030+
<th class="tableblock halign-left valign-top">CommonJS Require</th>
40294031
<th class="tableblock halign-left valign-top">CLJS Require</th>
40304032
</tr>
40314033
</thead>
40324034
<tbody>
40334035
<tr>
40344036
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport from "module-name";</code></p></td>
4037+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const defaultExport = require("module-name").default;</code></p></td>
40354038
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :default defaultExport])</code></p></td>
40364039
</tr>
40374040
<tr>
40384041
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import * as name from "module-name";</code></p></td>
4042+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const name = require("module-name");</code></p></td>
40394043
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :as name])</code></p></td>
40404044
</tr>
40414045
<tr>
40424046
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export } from "module-name";</code></p></td>
4047+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export } = require("module-name");</code></p></td>
40434048
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export)])</code></p></td>
40444049
</tr>
40454050
<tr>
40464051
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export as alias } from "module-name";</code></p></td>
4052+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export : alias } = require("module-name");</code></p></td>
40474053
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :rename {export alias}])</code></p></td>
40484054
</tr>
40494055
<tr>
40504056
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export1 , export2 } from "module-name";</code></p></td>
4057+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export1 , export2 } = require("module-name");</code></p></td>
40514058
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export1 export2)])</code></p></td>
40524059
</tr>
40534060
<tr>
40544061
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export1 , export2 as alias2 , [&#8230;&#8203;] } from "module-name";</code></p></td>
4062+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export1 , export2 : alias2 , [&#8230;&#8203;] } = require("module-name");</code></p></td>
40554063
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export1) :rename {export2 alias2}])</code></p></td>
40564064
</tr>
40574065
<tr>
40584066
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport, { export [ , [&#8230;&#8203;] ] } from "module-name";</code></p></td>
4067+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { default : defaultExport , export2 [ , [&#8230;&#8203;] ] } = require("module-name");</code></p></td>
40594068
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export) :default defaultExport])</code></p></td>
40604069
</tr>
40614070
<tr>
40624071
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport, * as name from "module-name";</code></p></td>
4072+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const name = require("module-name"), defaultExport = name.default;</code></p></td>
40634073
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :as name :default defaultExport])</code></p></td>
40644074
</tr>
40654075
<tr>
40664076
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import "module-name";</code></p></td>
4077+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>require("module-name");</code></p></td>
40674078
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name"])</code></p></td>
40684079
</tr>
40694080
</tbody>
@@ -4927,7 +4938,7 @@ <h3 id="_patching_libraries"><a class="anchor" href="#_patching_libraries"></a><
49274938
<div id="footer">
49284939
<div id="footer-text">
49294940
Version 1.0<br>
4930-
Last updated 2018-03-22 15:31:17 STD
4941+
Last updated 2018-04-11 23:13:16 EDT
49314942
</div>
49324943
</div>
49334944
</body>

docs/js-deps.adoc

+10-1
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,42 @@ The following table can be used for translation:
3232

3333
.ES6 Import to CLJS Require
3434
|===
35-
|ES6 Import|CLJS Require
35+
|ES6 Import|CommonJS Require|CLJS Require
3636

3737
|`import defaultExport from "module-name";`
38+
|`const defaultExport = require("module-name").default;`
3839
|`(:require ["module-name" :default defaultExport])`
3940

4041
|`import * as name from "module-name";`
42+
|`const name = require("module-name");`
4143
|`(:require ["module-name" :as name])`
4244

4345
|`import { export } from "module-name";`
46+
|`const { export } = require("module-name");`
4447
|`(:require ["module-name" :refer (export)])`
4548

4649
|`import { export as alias } from "module-name";`
50+
|`const { export : alias } = require("module-name");`
4751
|`(:require ["module-name" :rename {export alias}])`
4852

4953
|`import { export1 , export2 } from "module-name";`
54+
|`const { export1 , export2 } = require("module-name");`
5055
|`(:require ["module-name" :refer (export1 export2)])`
5156

5257
|`import { export1 , export2 as alias2 , [...] } from "module-name";`
58+
|`const { export1 , export2 : alias2 , [...] } = require("module-name");`
5359
|`(:require ["module-name" :refer (export1) :rename {export2 alias2}])`
5460

5561
|`import defaultExport, { export [ , [...] ] } from "module-name";`
62+
|`const { default : defaultExport , export2 [ , [...] ] } = require("module-name");`
5663
|`(:require ["module-name" :refer (export) :default defaultExport])`
5764

5865
|`import defaultExport, * as name from "module-name";`
66+
|`const name = require("module-name"), defaultExport = name.default;`
5967
|`(:require ["module-name" :as name :default defaultExport])`
6068

6169
|`import "module-name";`
70+
|`require("module-name");`
6271
|`(:require ["module-name"])`
6372
|===
6473

0 commit comments

Comments
 (0)