project-directory-tree

Generate a directory structure for the project

Usage no npm install needed!

<script type="module">
  import projectDirectoryTree from 'https://cdn.skypack.dev/project-directory-tree';
</script>

README

Generate a directory structure for the project

usage

npm i project-directory-tree -D

在项目的根目录下创建一个 generator.js

// ./genetator.js
const projecttree = require("project-directory-tree");
const p = new projecttree({ maxDepth: 3 });
p.readDir();

then

node genetator.js

在项目的根目录下将会生成一个 projectTree.txt。可能会是下面这个样子。

// projectTree.txt demo

options

// ./genetator.js
const projecttree = require("project-directory-tree");
const p = new projecttree(options?);
p.readDir();

options 可以是下面的属性：

property type default description
ignoreFiles string[] ['node_modules'] 要忽略的目录或文件
maxDepth number 1 生成树结构的最大深度
defaultPath string path.join(process.argv[1], "../") 项目的路径
ROOT_PATH string path.join(process.argv[1], "../projectTree.txt") 保存 projectTree.txt 的路径