https://github.com/plantain-00/code-structure

A CLI tool to generate code structure for javascript or typescript source code.
https://github.com/plantain-00/code-structure

Last synced: 2 months ago
JSON representation

A CLI tool to generate code structure for javascript or typescript source code.

• Host: GitHub
• URL: https://github.com/plantain-00/code-structure
• Owner: plantain-00
• License: mit
• Created: 2017-09-12T11:55:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-04T23:14:56.000Z (over 2 years ago)
• Last Synced: 2024-11-24T17:38:03.775Z (3 months ago)
• Language: TypeScript
• Homepage: https://plantain-00.github.io/code-structure/demo/result.html
• Size: 6.83 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# code-structure

[![Dependency Status](https://david-dm.org/plantain-00/code-structure.svg)](https://david-dm.org/plantain-00/code-structure)

[![devDependency Status](https://david-dm.org/plantain-00/code-structure/dev-status.svg)](https://david-dm.org/plantain-00/code-structure#info=devDependencies)

[![Build Status: Windows](https://ci.appveyor.com/api/projects/status/github/plantain-00/code-structure?branch=master&svg=true)](https://ci.appveyor.com/project/plantain-00/code-structure/branch/master)

![Github CI](https://github.com/plantain-00/code-structure/workflows/Github%20CI/badge.svg)

[![npm version](https://badge.fury.io/js/code-structure.svg)](https://badge.fury.io/js/code-structure)

[![Downloads](https://img.shields.io/npm/dm/code-structure.svg)](https://www.npmjs.com/package/code-structure)

[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Fcode-structure%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/code-structure)

A CLI tool to generate code structure for typescript.

## install

`yarn global add code-structure`

## usage

run `code-structure "*.ts" foo.html`

or `code-structure "*.ts" -o foo.html --exclude bar.ts`

then open the generated html file in the browser.

## options

key | description

--- | ---

-o | generated html file

-e,--exclude | excluded files

-h,--help | Print this message.

-v,--version | Print the version