@k4a_l/dirtreeist 0.1.8 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +59 -42
  2. package/dist/index.cjs +1 -1
  3. package/dist/modules/convert.js +2 -2
  4. package/dist/modules/convert.js.map +1 -1
  5. package/dist/modules/options.js +1 -1
  6. package/package.json +3 -2
package/README.md CHANGED
@@ -1,10 +1,36 @@
1
1
  # DirTreeist
2
2
 
3
- マークダウンのリスト構造や DirTree 構造からディレクトリ構成図を作成します。
3
+ Create a directory Structure Diagram from a markdown lists.
4
4
 
5
- ## Demo
5
+ ## Installation
6
6
 
7
- ### ディレクトリ構成図例
7
+ #### tarn
8
+
9
+ ```shell
10
+ yarn add @k4a_l/dirtreeist
11
+ ```
12
+
13
+ ### npm
14
+
15
+ ```shell
16
+ npm install @k4a_l/dirtreeist
17
+ ```
18
+
19
+ ## Example
20
+
21
+ ### Input
22
+
23
+ ```markdown
24
+ - /components
25
+ - App.tsx
26
+ - App.css
27
+ - config.json
28
+ - /utils
29
+ - converter.ts
30
+ - parser.ts
31
+ ```
32
+
33
+ ### Output
8
34
 
9
35
  ```text
10
36
  ├─/components
@@ -16,20 +42,9 @@
16
42
  └─parser.ts
17
43
  ```
18
44
 
19
- ## DirTree 構造
20
-
21
- ```ts
22
- type DirNode = {
23
- name: string
24
- children: DirNode[]
25
- }
26
-
27
- type DirTree = DirNode[]
28
- ```
45
+ ## How to use
29
46
 
30
- ## 使い方
31
-
32
- ### TypeScript Module
47
+ ### TypeScript
33
48
 
34
49
  ```ts
35
50
  const markdown = `
@@ -65,7 +80,20 @@ const outputs = dirTrees.map((dirTree) => convert(dirTree, options)) // DirTree[
65
80
  console.log(outputs)
66
81
  ```
67
82
 
68
- #### オプション
83
+ ### Type
84
+
85
+ #### Structure
86
+
87
+ ```ts
88
+ type DirNode = {
89
+ name: string
90
+ children: DirNode[]
91
+ }
92
+
93
+ type DirTree = DirNode[]
94
+ ```
95
+
96
+ #### Options
69
97
 
70
98
  ```ts
71
99
  type Options = {
@@ -76,28 +104,13 @@ type Options = {
76
104
  }
77
105
  ```
78
106
 
79
- ### CLI
80
-
81
- ```shell
82
- dirTreeist <inputFile> [...options]
83
- ```
84
-
85
- #### オプション
86
-
87
- ```test
88
- -t, --treeType ['normal'|'bold'|'ascii']
89
- -e, --empty [boolean]
90
- -space, --spaceBeforeName [boolean]
91
- -size, --spaceSize [number]
92
- ```
93
-
94
- ### オプションの説明
107
+ ### Description of options
95
108
 
96
109
  #### treeType
97
110
 
98
- デフォルト値:normal
111
+ default:`normal`
99
112
 
100
- normal
113
+ ##### normal
101
114
 
102
115
  ```
103
116
  │
@@ -106,7 +119,7 @@ normal
106
119
  └─
107
120
  ```
108
121
 
109
- bold
122
+ ##### bold
110
123
 
111
124
  ```
112
125
  ┃
@@ -115,7 +128,7 @@ bold
115
128
  ┗━
116
129
  ```
117
130
 
118
- ascii
131
+ ##### ascii
119
132
 
120
133
  ```
121
134
  |
@@ -126,7 +139,9 @@ ascii
126
139
 
127
140
  #### emptyLineBeforeUpperHierarchy : boolean
128
141
 
129
- デフォルト値:false
142
+ default:`false`
143
+
144
+ ##### true
130
145
 
131
146
  ```text
132
147
  (true)
@@ -142,10 +157,11 @@ ascii
142
157
 
143
158
  #### spaceBeforeName : boolean
144
159
 
145
- デフォルト値:false
160
+ default: `false`
161
+
162
+ ##### true
146
163
 
147
164
  ```text
148
- (true)
149
165
  ├─ /components
150
166
  │ ├─ App.tsx
151
167
  │ └─ App.css
@@ -157,10 +173,11 @@ ascii
157
173
 
158
174
  #### spaceSize : number
159
175
 
160
- デフォルト値:2
176
+ default:`2`
177
+
178
+ ##### 4
161
179
 
162
180
  ```text
163
- (4)
164
181
  ├──/components
165
182
  │ ├──App.tsx
166
183
  │ └──App.css
package/dist/index.cjs CHANGED
@@ -9892,7 +9892,7 @@ const reduce = (dirTree, options, prefix, hie, isLastGroup) => {
9892
9892
  // 現在
9893
9893
  const currentPrefix = prefix +
9894
9894
  symbol +
9895
- new Array(options.spaceSize / 2)
9895
+ new Array(Math.floor(options.spaceSize / 2))
9896
9896
  .fill(symbolSet.horizontal)
9897
9897
  .reduce((prev, cur) => prev + cur, '');
9898
9898
  const currentLine = `${currentPrefix}${options.spaceBeforeName ? ' ' : ''}${dirNode.name}`;
package/dist/modules/convert.js CHANGED
@@ -1,4 +1,4 @@
1
- import { symbolSets, defaultOptions } from 'constants/constant';
1
+ import { symbolSets, defaultOptions } from '../constants/constant';
2
2
  import { buildOption } from './options';
3
3
  const makeSymbol = (symbolSet, isLast) => {
4
4
  if (isLast)
@@ -15,7 +15,7 @@ const reduce = (dirTree, options, prefix, hie, isLastGroup) => {
15
15
  // 現在
16
16
  const currentPrefix = prefix +
17
17
  symbol +
18
- new Array(options.spaceSize / 2)
18
+ new Array(Math.floor(options.spaceSize / 2))
19
19
  .fill(symbolSet.horizontal)
20
20
  .reduce((prev, cur) => prev + cur, '');
21
21
  const currentLine = `${currentPrefix}${options.spaceBeforeName ? ' ' : ''}${dirNode.name}`;
package/dist/modules/convert.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"convert.js","sourceRoot":"","sources":["../../src/modules/convert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,MAAM,UAAU,GAAG,CAAC,SAAoB,EAAE,MAAe,EAAU,EAAE;IACnE,IAAI,MAAM;QAAE,OAAO,SAAS,CAAC,GAAG,CAAA;IAChC,OAAO,SAAS,CAAC,QAAQ,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CACb,OAAgB,EAChB,OAAoB,EACpB,MAAc,EACd,GAAW,EACX,WAAoB,EACZ,EAAE;IACV,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE;QACrC,KAAK;QACL,MAAM,MAAM,GAAG,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;QACjD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAE5C,KAAK;QACL,MAAM,aAAa,GACjB,MAAM;YACN,MAAM;YACN,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC;iBAC7B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;iBAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC,CAAA;QAE1C,MAAM,WAAW,GAAG,GAAG,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GACvE,OAAO,CAAC,IACV,EAAE,CAAA;QAEF,IAAI;QACJ,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;aACxC,IAAI,CAAC,GAAG,CAAC;aACT,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACpB,OAAO,IAAI,GAAG,GAAG,CAAA;QACnB,CAAC,EAAE,EAAE,CAAC,CAAA;QACR,MAAM,aAAa,GAAG,MAAM,CAC1B,OAAO,CAAC,QAAQ,EAChB,OAAO,EACP,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,MAAM,EACjE,GAAG,GAAG,CAAC,EACP,WAAW,IAAI,MAAM,CACtB,CAAA;QAED,KAAK;QACL,MAAM;YACJ,WAAW;gBACX,IAAI;gBACJ,aAAa;gBACb,CAAC,OAAO,CAAC,yBAAyB,IAAI,MAAM,IAAI,CAAC,CAAC,WAAW,IAAI,GAAG,IAAI,CAAC,CAAC;oBACxE,CAAC,CAAC,GAAG,SAAS,CAAC,QAAQ,IAAI;oBAC3B,CAAC,CAAC,EAAE,CAAC,CAAA;IACX,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAE,OAAiB,EAAU,EAAE;IAC9D,OAAO,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAA;AAC5E,CAAC,CAAA;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}
1
+ {"version":3,"file":"convert.js","sourceRoot":"","sources":["../../src/modules/convert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,MAAM,UAAU,GAAG,CAAC,SAAoB,EAAE,MAAe,EAAU,EAAE;IACnE,IAAI,MAAM;QAAE,OAAO,SAAS,CAAC,GAAG,CAAA;IAChC,OAAO,SAAS,CAAC,QAAQ,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CACb,OAAgB,EAChB,OAAoB,EACpB,MAAc,EACd,GAAW,EACX,WAAoB,EACZ,EAAE;IACV,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE;QACrC,KAAK;QACL,MAAM,MAAM,GAAG,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;QACjD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAE5C,KAAK;QACL,MAAM,aAAa,GACjB,MAAM;YACN,MAAM;YACN,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;iBACzC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;iBAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC,CAAA;QAE1C,MAAM,WAAW,GAAG,GAAG,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GACvE,OAAO,CAAC,IACV,EAAE,CAAA;QAEF,IAAI;QACJ,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;aACxC,IAAI,CAAC,GAAG,CAAC;aACT,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACpB,OAAO,IAAI,GAAG,GAAG,CAAA;QACnB,CAAC,EAAE,EAAE,CAAC,CAAA;QACR,MAAM,aAAa,GAAG,MAAM,CAC1B,OAAO,CAAC,QAAQ,EAChB,OAAO,EACP,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,MAAM,EACjE,GAAG,GAAG,CAAC,EACP,WAAW,IAAI,MAAM,CACtB,CAAA;QAED,KAAK;QACL,MAAM;YACJ,WAAW;gBACX,IAAI;gBACJ,aAAa;gBACb,CAAC,OAAO,CAAC,yBAAyB,IAAI,MAAM,IAAI,CAAC,CAAC,WAAW,IAAI,GAAG,IAAI,CAAC,CAAC;oBACxE,CAAC,CAAC,GAAG,SAAS,CAAC,QAAQ,IAAI;oBAC3B,CAAC,CAAC,EAAE,CAAC,CAAA;IACX,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,CAAC,OAAgB,EAAE,OAAiB,EAAU,EAAE;IAC9D,OAAO,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAA;AAC5E,CAAC,CAAA;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}
package/dist/modules/options.js CHANGED
@@ -1,4 +1,4 @@
1
- import { defaultOptions } from 'constants/constant';
1
+ import { defaultOptions } from '../constants/constant';
2
2
  const pickOption = (option, defaultOption, key) => {
3
3
  if (option === undefined)
4
4
  return defaultOptions[key];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@k4a_l/dirtreeist",
3
- "version": "0.1.8",
3
+ "version": "0.2.2",
4
4
  "main": "dist/index.js",
5
5
  "exports": {
6
6
  "import": "./dist/index.js",
@@ -13,7 +13,7 @@
13
13
  "scripts": {
14
14
  "dev": "vite",
15
15
  "clean": "rm -rf ./dist/ ",
16
- "build:esm": "tsc",
16
+ "build:esm": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
17
17
  "build:cjs": "rollup -c rollup.config.js",
18
18
  "build": "yarn clean && yarn build:esm && yarn build:cjs",
19
19
  "test": "vitest",
@@ -35,6 +35,7 @@
35
35
  "rollup": "^2.79.0",
36
36
  "ts-jest": "^28.0.8",
37
37
  "ts-node-dev": "^2.0.0",
38
+ "tsc-alias": "^1.7.0",
38
39
  "tslib": "^2.4.0",
39
40
  "typescript": "^4.8.2",
40
41
  "vite-tsconfig-paths": "^3.5.0",