Socket
Socket
Sign inDemoInstall

dir-text

Package Overview
Dependencies
0
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    dir-text

Express the file directory structure in text


Version published
Maintainers
1
Install size
11.4 kB
Created

Readme

Source

dir-text

Express the file directory structure in text like this

example
├── app
│   ├── controller
│   │   └── home.js
│   └── router.js
├── config
│   └── config.default.js
└── package.json

use

  const { dirText } = require('dir-text');

  // use default options
  dirText();

  // use custom ignores directories
  dirText(undefined, undefined, ['node_modules', '.git']);

  // use custom base path
  dirText('./');

  // use custom output file path
  dirText(undefined, 'output.md');

TypeScript

You can use TypeScript from version 0.0.3

checkList

  • readme
  • TypeScript
  • test
  • doc

Keywords

FAQs

Last updated on 07 Feb 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc