GithubHelp home page GithubHelp logo

remiscan / dependency-cruiser-ts-extension Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 225 KB

VS Code extension - Generates a dependency graph from a JavaScript or TypeScript file.

Home Page: https://marketplace.visualstudio.com/items?itemName=remiscan.dependency-cruiser-ts

License: MIT License

JavaScript 22.71% TypeScript 77.29%
dependency-graph graph imports modules vscode-extension javascript typescript

dependency-cruiser-ts-extension's Introduction

dependency-cruiser-ts

This VS Code extension uses dependency-cruiser and viz-js to generate a dependency graph from a JavaScript or TypeScript file.

Example graph

Features

  • Right-click on a JS or TS file, choose "See dependency graph", and the graph will open in a new VS Code tab.
  • Alternatively, open a JS or TS file and run the "See dependency graph" command from the command palette.
  • Click on a node in the graph to open the associated file.

Extension Settings

Dependency cruiser analysis configuration

  • dependency-cruiser-ts.analysis.enableCustomConfiguration: Looks for a .dependency-cruiser.json file at the root of your workspace folder. If one is found, it will overwrite the extension's configuration of dependency-cruiser, giving you full control of it. Learn more abour its syntax in the dependency-cruiser documentation.
  • dependency-cruiser-ts.analysis.collapsePattern: Pattern used to collapse many graph nodes into a single one. More info in the dependency-cruiser docs.
  • dependency-cruiser-ts.analysis.tsConfigPattern: Glob pattern for the file name of the tsconfig file. The extension will look for files matching this pattern in the workspace folder of the analyzed file. If multiple matching files are found, you will be prompted to pick one.

Preset rules

Some preset rules are available right in the extension. Enable them with these settings :

  • dependency-cruiser-ts.analysis.rules.noCircular: Warns you about circular dependencies, by highlighting them on the graph.
  • dependency-cruiser-ts.analysis.rules.noDev: Warns you about imported dev dependencies in your src folder, by highlighting them on the graph.

Graph visual settings

  • dependency-cruiser-ts.graph.colorScheme: Enables or disables dark mode.
  • dependency-cruiser-ts.graph.direction: Direction of the graph (left to right, top to bottom, etc.).
  • dependency-cruiser-ts.graph.lineShapes: Shape of the lines between nodes (for example whether straight or curved, whether they avoid other nodes or go though them).
  • dependency-cruiser-ts.graph.theme: Theme used to draw the graph.

dependency-cruiser-ts-extension's People

Contributors

remiscan avatar

Stargazers

Dmitry Galaktionov avatar Adam Biggs avatar

Watchers

 avatar

dependency-cruiser-ts-extension's Issues

no such file or directory

An error occurred: ENOENT: no such file or directory, chdir 'C:\Users\username\AppData\Local\Programs\Microsoft VS Code Insiders' -> '/c:/projectFolder'

vscode insiders, windows x64

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.