Skip to content

Commit

Permalink
add CommonJS to js-deps table.
Browse files Browse the repository at this point in the history
  • Loading branch information
quangv committed Apr 12, 2018
1 parent 6800e11 commit efd6bb1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 5 deletions.
19 changes: 15 additions & 4 deletions docs/UsersGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.6.1">
<meta name="generator" content="Asciidoctor 1.5.6.2">
<meta name="author" content="Thomas Heller and Tony Kay">
<title>Shadow CLJS User&#8217;s Guide</title>
<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">
Expand Down Expand Up @@ -4020,50 +4020,61 @@ <h4 id="_using_npm_packages"><a class="anchor" href="#_using_npm_packages"></a><
<table class="tableblock frame-all grid-all spread">
<caption class="title">Table 1. ES6 Import to CLJS Require</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">ES6 Import</th>
<th class="tableblock halign-left valign-top">CommonJS Require</th>
<th class="tableblock halign-left valign-top">CLJS Require</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const defaultExport = require("module-name").default;</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :default defaultExport])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import * as name from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const name = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :as name])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export } from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export } = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export)])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export as alias } from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export : alias } = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :rename {export alias}])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export1 , export2 } from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export1 , export2 } = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export1 export2)])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import { export1 , export2 as alias2 , [&#8230;&#8203;] } from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { export1 , export2 : alias2 , [&#8230;&#8203;] } = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export1) :rename {export2 alias2}])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport, { export [ , [&#8230;&#8203;] ] } from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const { default : defaultExport , export2 [ , [&#8230;&#8203;] ] } = require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :refer (export) :default defaultExport])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import defaultExport, * as name from "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>const name = require("module-name"), defaultExport = name.default;</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name" :as name :default defaultExport])</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>import "module-name";</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>require("module-name");</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>(:require ["module-name"])</code></p></td>
</tr>
</tbody>
Expand Down Expand Up @@ -4927,7 +4938,7 @@ <h3 id="_patching_libraries"><a class="anchor" href="#_patching_libraries"></a><
<div id="footer">
<div id="footer-text">
Version 1.0<br>
Last updated 2018-03-22 15:31:17 STD
Last updated 2018-04-11 23:13:16 EDT
</div>
</div>
</body>
Expand Down
11 changes: 10 additions & 1 deletion docs/js-deps.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,42 @@ The following table can be used for translation:

.ES6 Import to CLJS Require
|===
|ES6 Import|CLJS Require
|ES6 Import|CommonJS Require|CLJS Require

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

|`import * as name from "module-name";`
|`const name = require("module-name");`
|`(:require ["module-name" :as name])`

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

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

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

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

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

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

|`import "module-name";`
|`require("module-name");`
|`(:require ["module-name"])`
|===

Expand Down

0 comments on commit efd6bb1

Please sign in to comment.