docs: improve documentation (#213)

wellwelwel · Apr 26, 2024 · fa9372a · fa9372a
1 parent c12f069
commit fa9372a
Show file tree

Hide file tree

Showing 11 changed files with 26 additions and 60 deletions.
diff --git a/.c8rc → .nycrc b/.c8rc → .nycrc
diff --git a/README.md b/README.md
@@ -111,8 +111,8 @@ bun add -d poku
 </td>
 <td width="400">
 
-```ts
-import { poku } from 'npm:poku';
+```bash
+deno add npm:poku
 ```
 
 </td>
@@ -124,7 +124,7 @@ import { poku } from 'npm:poku';
 <table>
 <tr>
 <td>
-<em><code>test/file.test.js</code></em>
+<em><code>test/file.test.mjs</code></em>
 </td>
 </tr>
 <tr>
@@ -140,7 +140,8 @@ assert(true, 'Poku will describe it 🐷');
 </tr>
 </table>
 
-> Note that these examples use [**ESM**](https://poku.io/docs/examples/cjs-esm), but you can use [**CJS**](https://poku.io/docs/examples/cjs-esm) as well.
+- Change from `.mjs` to `.js` by defining `"type": "module"` in your _package.json_.
+- Note that these examples use [**ESM**](https://poku.io/docs/examples/cjs-esm), but you can use [**CJS**](https://poku.io/docs/examples/cjs-esm) as well.
 
 ### Run it 🚀
 

diff --git a/website/docs/documentation/assert/index.mdx b/website/docs/documentation/assert/index.mdx
@@ -25,24 +25,10 @@ It supports both [**Bun**][bun-version-url] and [**Deno**][deno-version-url].
 
 _But only if you want to, of course._
 
-<Tabs>
-  <TabItem default value='Node.js, TypeScript (Node.js) and Bun'>
-
-    ```diff
-    - import assert from 'node:assert';
-    + import { assert } from 'poku';
-    ```
-
-  </TabItem>
-  <TabItem value='Deno'>
-
-    ```diff
-    - import assert from 'node:assert';
-    + import { assert } from 'npm:poku';
-    ```
-
-  </TabItem>
-</Tabs>
+```diff
+- import assert from 'node:assert';
++ import { assert } from 'poku';
+```
 
 ```ts
 assert(true, "It's true 🧪");

diff --git a/website/docs/documentation/helpers/before-after-each/in-code.mdx b/website/docs/documentation/helpers/before-after-each/in-code.mdx
@@ -86,7 +86,7 @@ Since `test` is completely optional on **Poku**, you can use `beforeEach`, `afte
 
 :::info
 
-- Although `beforeEach` and `afterEach` accepts local variables changes, it's strongly encouraged ([_you can use a mock instead_](/docs/category/mock)).
+- Although `beforeEach` and `afterEach` accepts local variables changes, it's discouraged ([_you can use a mock instead_](/docs/category/mock)).
 
 See why (_note the `immediate` option_):
 
@@ -206,7 +206,7 @@ You can overwriting both `beforeEach` and `afterEach` by declaring them again an
 
 :::info
 
-- Although `beforeEach` and `afterEach` accepts local variables changes, it's strongly encouraged ([_you can use a mock instead_](/docs/category/mock)).
+- Although `beforeEach` and `afterEach` accepts local variables changes, it's discouraged ([_you can use a mock instead_](/docs/category/mock)).
 
 See why (_note the `immediate` option_):
 

diff --git a/website/docs/documentation/startScript.mdx b/website/docs/documentation/startScript.mdx
@@ -87,7 +87,7 @@ By defining a timeout, you avert indefinite processes that conclude neither in s
 You don't necessarily have to end your service running in the background as the last line of the test, if it's no longer used.
 
 ```ts
-import { startScript } from 'poku'; // 'npm:poku' for Deno
+import { startScript } from 'poku';
 
 const server = await startScript('start', {
   /**

diff --git a/website/docs/documentation/startService.mdx b/website/docs/documentation/startService.mdx
@@ -66,7 +66,7 @@ By defining a timeout, you avert indefinite processes that conclude neither in s
 You don't necessarily have to end your service running in the background as the last line of the test, if it's no longer used.
 
 ```ts
-import { startService } from 'poku'; // 'npm:poku' for Deno
+import { startService } from 'poku';
 
 const server = await startService('server.js', {
   /**

diff --git a/website/docs/examples/local-server.mdx b/website/docs/examples/local-server.mdx
@@ -67,7 +67,7 @@ And now, test it:
   <TabItem default value='test/server.test.js'>
 
 ```js
-import { assert, startService } from 'poku'; // 'npm:poku' for Deno
+import { assert, startService } from 'poku';
 
 const server = await startService('server.js', {
   // Wait for the "ready" console output

diff --git a/website/docs/index.mdx b/website/docs/index.mdx
@@ -129,14 +129,8 @@ bun add -d poku
   </TabItem>
   <TabItem  value='Deno'>
 
-```ts
-import { poku } from 'npm:poku';
-```
-
-You can also use **Poku** with [**esm.sh**](https://esm.sh):
-
-```ts
-import { poku } from 'https://esm.sh/poku';
+```bash
+deno add npm:poku
 ```
 
   </TabItem>
@@ -145,27 +139,19 @@ import { poku } from 'https://esm.sh/poku';
 ### **Test it** 🔬
 
 <Tabs>
-  <TabItem default value='test/file.test.js'>
+  <TabItem default value='test/file.test.mjs'>
 
 ```ts
 import { assert } from 'poku';
 
-assert(true, 'Poku will describe it 🐷');
-```
-
-  </TabItem>
-  <TabItem default value='test/file.test.ts (Deno)'>
-
-```ts
-import { assert } from 'npm:poku';
-
 assert(true, 'Poku will describe it 🐷');
 ```
 
   </TabItem>
 </Tabs>
 
-> Note that these examples use [**ESM**](/docs/examples/cjs-esm), but you can use [**CJS**](/docs/examples/cjs-esm) as well.
+- Change from `.mjs` to `.js` by defining `"type": "module"` in your _package.json_.
+- Note that these examples use [**ESM**](/docs/examples/cjs-esm), but you can use [**CJS**](/docs/examples/cjs-esm) as well.
 
 ### **Run it** 🚀
 

diff --git a/website/docs/overview.mdx b/website/docs/overview.mdx
@@ -26,8 +26,7 @@ import ASSERT_NODE from '@site/static/img/assert-node.png';
 > Compatible with **Node.js**, **Bun** and **Deno**.
 
 ```ts
-import { assert } from 'poku'; // Node and Bun
-import { assert } from 'npm:poku'; // Deno
+import { assert } from 'poku';
 
 const actual = '1';
 

diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/index.mdx b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/index.mdx
@@ -128,14 +128,8 @@ bun add -d poku
   </TabItem>
   <TabItem  value='Deno'>
 
-```ts
-import { poku } from 'npm:poku';
-```
-
-Você também pode usar o **Poku** via [**esm.sh**](https://esm.sh):
-
-```ts
-import { poku } from 'https://esm.sh/poku';
+```bash
+deno add npm:poku
 ```
 
   </TabItem>
@@ -144,7 +138,7 @@ import { poku } from 'https://esm.sh/poku';
 ### **Teste** 🔬
 
 <Tabs>
-  <TabItem default value='test/file.test.js'>
+  <TabItem default value='test/file.test.mjs'>
 
 ```ts
 import { assert } from 'poku';
@@ -155,7 +149,8 @@ assert(true, 'Poku irá descrever isso 🐷');
   </TabItem>
 </Tabs>
 
-> Note que os exemplos são baseados em [**ESM**](/docs/examples/cjs-esm), mas você pode usar [**CJS**](/docs/examples/cjs-esm) normalmente.
+- Troque a extensão de `.mjs` para `.js` ao definir `"type": "module"` em seu _package.json_.
+- Note que os exemplos são baseados em [**ESM**](/docs/examples/cjs-esm), mas você pode usar [**CJS**](/docs/examples/cjs-esm) normalmente.
 
 ### **Execute** 🚀
 

diff --git a/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/overview.mdx b/website/i18n/pt-BR/docusaurus-plugin-content-docs/current/overview.mdx
@@ -26,8 +26,7 @@ O **Poku** também inclui o método `assert`, mantendo tudo como sempre foi, mas
 > Compatível com **Node.js**, **Bun** e **Deno**.
 
 ```ts
-import { assert } from 'poku'; // Node e Bun
-import { assert } from 'npm:poku'; // Deno
+import { assert } from 'poku';
 
 const actual = '1';