@k4a_l/dirtreeist 0.1.0

package/.eslint.js

@@ -0,0 +1,16 @@
+module.exports = {
+  root: true, // .eslintrc.jsがプロジェクトのルートに配置させているか（指定がないと上位階層へ設定ファイルを探索される）
+  parser: "@typescript-eslint/parser", // ESLintにTypeScriptを理解させる
+  parserOptions: {},
+  plugins: [
+    "@typescript-eslint", // ESLintのTypeScriptプラグインのルールを適用できる様にする（/eslint-pluginは省略可）
+  ],
+  extends: [
+    "eslint:recommended", // ESLintのJavaScriptルールセットを適用
+    "plugin:@typescript-eslint/eslint-recommended", // eslint:recommendedに含まれるルールを型チェックでカバーできるものは無効化
+    "plugin:@typescript-eslint/recommended", // 型チェックが不要なルールを適用
+    "plugin:@typescript-eslint/recommended-requiring-type-checking", // 型チェックが必要なルールを適用
+    "prettier",
+    "prettier/@typescript-eslint", // eslint-config-prettierがv8.0.0以上の場合不要です
+  ],
+};

package/README.md

@@ -0,0 +1,122 @@
+# DirTreeist
+
+マークダウンのリスト構造や DirTree 構造からディレクトリ構成図を作成します。
+
+## Demo
+
+### ディレクトリ構成図例
+
+```text
+├──components
+│   ├──App.tsx
+│   └──App.css
+├──config.json
+└──utils
+    └──converter.ts
+```
+
+## DirTree 構造
+
+```ts
+type DirNode = {
+  name: string;
+  children: DirNode[];
+};
+
+type DirTree = DirNode[];
+```
+
+## 使い方
+
+### TypeScript Module
+
+```ts
+import { parser, converter, OptionType } from "dirTreeist";
+
+const markdownList = `
+- components
+    - App.tsx
+    - App.css
+- config.json
+- utils
+    - converter.ts
+`;
+
+const dirTree = parser(markdownList); // markdown => DirTree
+
+const options: OptionType = {};
+const output = converter(dirtree, options); // DirTree => output(like Demo)
+```
+
+#### オプション
+
+```ts
+type OptionType = {
+  treeType?: 1 | 2 | 3;
+  emptyBeforeUpperHierarche?: boolean;
+  spaceBeforeName?: boolean;
+  spaceSize?: boolean;
+};
+```
+
+### CLI
+
+```shell
+dirTreeist <inputFile> [...options]
+```
+
+#### オプション
+
+```test
+-t, --treeType [1|2|3]
+-e, --empty [boolean]
+-space, --spaceBeforeName [boolean]
+-size, --spaceSize [number]
+```
+
+### オプションの説明
+
+#### emptyLineBeforeUpperHierarchy : boolean
+
+デフォルト値:false
+
+```text
+(true)
+├──components
+│   ├──App.tsx
+│   └──App.css
+│
+├──config.json
+└──utils
+    └──converter.ts
+```
+
+#### spaceBeforeName : boolean
+
+デフォルト値:false
+
+```text
+(true)
+├── components
+│   ├── App.tsx
+│   └── App.css
+│
+├── config.json
+└── utils
+    └── converter.ts
+```
+
+#### spaceSize : number
+
+デフォルト値:2
+
+```text
+(4)
+├──── components
+│    ├── App.tsx
+│    └── App.css
+│
+├──── config.json
+└──── utils
+     └── converter.ts
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+console.log("hello world");
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC"}

package/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  roots: ["<rootDir>/src"],
+  testMatch: ["**/__tests__/**/*.+(ts|tsx|js)", "**/?(*.)+(spec|test).+(ts|tsx|js)"],
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest",
+  },
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@k4a_l/dirtreeist",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "kasahala",
+  "license": "MIT",
+  "scripts": {
+    "dev": "ts-node-dev --respawn src/index.ts",
+    "build": "tsc",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.36.2",
+    "@typescript-eslint/parser": "^5.36.2",
+    "eslint": "^8.23.0",
+    "eslint-config-prettier": "^8.5.0",
+    "jest": "^29.0.2",
+    "prettier": "^2.7.1",
+    "ts-jest": "^28.0.8",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^4.8.2"
+  }
+}

package/tests/convert.test.js

@@ -0,0 +1 @@
+"use strict";

package/tests/parser.test.js

@@ -0,0 +1 @@
+"use strict";