@k4a_l/dirtreeist 0.1.6 → 0.2.0

package/README.md

@@ -1,10 +1,20 @@
 # DirTreeist
+Create a directory Structure Diagram from a markdown lists.
 
-マークダウンのリスト構造や DirTree 構造からディレクトリ構成図を作成します。
+## Example
+### Input
 
-## Demo
+```markdown
+- /components
+  - App.tsx
+  - App.css
+- config.json
+- /utils
+  - converter.ts
+  - parser.ts
+```
 
-### ディレクトリ構成図例
+### Output
 
 ```text
 ├─/components
@@ -16,24 +26,11 @@
     └─parser.ts
 ```
 
-## DirTree 構造
-
-```ts
-type DirNode = {
-  name: string
-  children: DirNode[]
-}
-
-type DirTree = DirNode[]
-```
-
-## 使い方
+## How to use
 
-### TypeScript Module
+### TypeScript
 
 ```ts
-import { parse, convert, OptionType } from 'dirTreeist'
-
 const markdown = `
 - /components
     - App.tsx
@@ -43,16 +40,44 @@ const markdown = `
     - converter.ts
     - parser.ts
 `
+```
+
+```tsx
+import dirtreest, { Options } from '@k4a_l/dirtreeist'
+
+const options: Options = {}
+const outputs = dirtreest(markdown, options) // DirTree[] => output[]
+
+console.log(outputs)
+```
+
+or
+
+```tsx
+import { parse, convert, Options } from '@k4a_l/dirtreeist'
 
 const dirTrees = parse(markdown) // markdown => DirTree[]
 
-const options: OptionType = {}
+const options: Options = {}
 const outputs = dirTrees.map((dirTree) => convert(dirTree, options)) // DirTree[] => output[]
 
 console.log(outputs)
 ```
 
-#### オプション
+### Type
+
+#### Structure
+
+```ts
+type DirNode = {
+  name: string
+  children: DirNode[]
+}
+
+type DirTree = DirNode[]
+```
+
+#### Options
 
 ```ts
 type Options = {
@@ -63,28 +88,13 @@ type Options = {
 }
 ```
 
-### CLI
-
-```shell
-dirTreeist <inputFile> [...options]
-```
-
-#### オプション
-
-```test
--t, --treeType ['normal'|'bold'|'ascii']
--e, --empty [boolean]
--space, --spaceBeforeName [boolean]
--size, --spaceSize [number]
-```
-
-### オプションの説明
+### Description of options
 
 #### treeType
 
-デフォルト値:normal
+default:`normal`
 
-normal
+##### normal
 
 ```
 │
@@ -93,7 +103,7 @@ normal
 └─
 ```
 
-bold
+##### bold
 
 ```
 ┃
@@ -102,7 +112,7 @@ bold
 ┗━
 ```
 
-ascii
+##### ascii
 
 ```
 |
@@ -113,7 +123,9 @@ ascii
 
 #### emptyLineBeforeUpperHierarchy : boolean
 
-デフォルト値:false
+default:`false`
+
+##### true
 
 ```text
 (true)
@@ -129,10 +141,11 @@ ascii
 
 #### spaceBeforeName : boolean
 
-デフォルト値:false
+default: `false`
+
+##### true
 
 ```text
-(true)
 ├─ /components
 │  ├─ App.tsx
 │  └─ App.css
@@ -144,10 +157,11 @@ ascii
 
 #### spaceSize : number
 
-デフォルト値:2
+default:`2`
+
+##### 4
 
 ```text
-(4)
 ├──/components
 │    ├──App.tsx
 │    └──App.css

package/dist/index.cjs

@@ -9918,10 +9918,9 @@ const convert = (dirTree, options) => {
     return reduce(dirTree, buildOption(options, defaultOptions), '', 0, false);
 };
 
-const dirtreest = (markdown) => {
-    return parse(markdown).map((dirtree) => convert(dirtree));
-};
-console.log('hello');
+const dirtreest = (markdown, option) => {
+    return parse(markdown).map((dirtree) => convert(dirtree, option));
+};
 
 exports.convert = convert;
 exports["default"] = dirtreest;

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { parse } from './modules/parse';
 import { convert } from './modules/convert';
-import { DirTree } from './types/index';
-declare const dirtreest: (markdown: string) => string[];
+import { DirTree, Options } from './types/index';
+declare const dirtreest: (markdown: string, option?: Options) => string[];
 export { parse, convert };
 export default dirtreest;
-export type { DirTree };
+export type { DirTree, Options };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC,QAAA,MAAM,SAAS,aAAc,MAAM,aAElC,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;AAEzB,eAAe,SAAS,CAAA;AACxB,YAAY,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAE3C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEhD,QAAA,MAAM,SAAS,aAAc,MAAM,WAAW,OAAO,aAEpD,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;AACzB,eAAe,SAAS,CAAA;AACxB,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/dist/index.js

@@ -1,9 +1,8 @@
 import { parse } from './modules/parse';
 import { convert } from './modules/convert';
-const dirtreest = (markdown) => {
-    return parse(markdown).map((dirtree) => convert(dirtree));
+const dirtreest = (markdown, option) => {
+    return parse(markdown).map((dirtree) => convert(dirtree, option));
 };
 export { parse, convert };
 export default dirtreest;
-console.log('hello');
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAI3C,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,EAAE;IACrC,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;AAC3D,CAAC,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;AAEzB,eAAe,SAAS,CAAA;AAGxB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAI3C,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,MAAgB,EAAE,EAAE;IACvD,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;AACnE,CAAC,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAA;AACzB,eAAe,SAAS,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k4a_l/dirtreeist",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "exports": {
     "import": "./dist/index.js",