Socket
Socket
Sign inDemoInstall

@tkskto/vue-component-analyzer

Package Overview
Dependencies
9
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tkskto/vue-component-analyzer

Analyze dependency tree for Vue.js SFC (Single File Component)


Version published
Maintainers
1
Weekly downloads
118
decreased by-41.29%

Weekly downloads

Readme

Source

vue-component-analyzer

This tool can Analyze dependency tree for Vue.js SFC (Single File Component). You can see GitHub Pages for a demo.

Also, you can see Props of Component.

or you can see simple text pattern.

Why?

When you try to change the behavior of components, it is hard to know where the component is used.

When you join a new big project using Vue.js, it is hard to understand dependencies.

installation and usage

You can install vue-component-analyzer using npm:

npm install @tkskto/vue-component-analyzer --save-dev

Then put command on npm scripts.

"scripts": {
  "vca": "vca --dir pages"
}

Or you can use npm exec(after npm install):

npm exec vca -- --dir .

CLI Options

  • --dir : analyze target directory. default is src. node_modules will be ignored by default.
  • --silent : running without almost logs.
  • -f or --format : report type. choose one from [browser | json | html]. default is browser.
  • -o or --out : output directory. JSON or HTML file will output here.
  • -p or --port : select a port number for the local server.

API

vue-component-analyzer is also available as an API from v0.6.1.

This API is intended to be used for testing.

import {getImportDeclarationTree} from '@tkskto/vue-component-analyzer';

const jsonOfTree = getImportDeclarationTree('entryFile.vue');

See index.d.ts for details of types.

(lastModifiedTime can be noise. If you don't need it remove explicitly.)

License

MIT License.

Keywords

FAQs

Last updated on 19 Apr 2023

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