docs(example): captured that dialect is a valid argument to expect …

…to be passed
form8ion · Dec 26, 2023 · 0cbe828 · 0cbe828
1 parent 4076a64
commit 0cbe828
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 79 deletions.
diff --git a/.remarkrc.cjs b/.remarkrc.cjs
@@ -1,6 +1,6 @@
 // https://github.com/remarkjs/remark/tree/master/packages/remark-stringify#options
 exports.settings = {
-  listItemIndent: 1,
+  listItemIndent: 'one',
   emphasis: '_',
   strong: '_',
   bullet: '*',
@@ -11,4 +11,4 @@ exports.plugins = [
   '@form8ion/remark-lint-preset',
   ['remark-toc', {tight: true}],
   ['remark-usage', {heading: 'example'}]
-];
+];
diff --git a/README.md b/README.md
@@ -42,14 +42,15 @@ $ npm install @form8ion/scaffolder-scaffolder --save-prod
 #### Import
 
 ```javascript
+import {dialects} from '@form8ion/javascript-core';
 import {scaffold} from '@form8ion/scaffolder-scaffolder';
 ```
 
 #### Execute
 
 ```javascript
 (async () => {
-  await scaffold({projectRoot: process.cwd(), packageName: 'foo', tests: {integration: true}});
+  await scaffold({projectRoot: process.cwd(), packageName: 'foo', tests: {integration: true}, dialect: dialects.ESM});
 })();
 ```
 

diff --git a/example.js b/example.js
@@ -1,6 +1,7 @@
 // #### Import
 // remark-usage-ignore-next
 import stubbedFs from 'mock-fs';
+import {dialects} from '@form8ion/javascript-core';
 import {scaffold} from './lib/index.mjs';
 
 // remark-usage-ignore-next 5
@@ -13,5 +14,5 @@ stubbedFs({
 // #### Execute
 
 (async () => {
-  await scaffold({projectRoot: process.cwd(), packageName: 'foo', tests: {integration: true}});
+  await scaffold({projectRoot: process.cwd(), packageName: 'foo', tests: {integration: true}, dialect: dialects.ESM});
 })();