compile-vue-sfc
Advanced tools
A utility function to compile a Vue SFC file into JavaScript and TypeScript definitions.
A utility function for compiling a Vue SFC into a JavaScript file and an optional TypeScript declarations file.
npm install compile-vue-sfc
TypeScript definitions are generated with vue-tsc. However, TypeScript unfortunately doesn't support specifying individual files for compilation in combination with a tsconfig.json file. Thus, in order to work around this limitation, a temporary tsconfig.json file needs to be created specifying the .vue file explicitly within an extra includes property. But, creating a temporary tsconfig.json on disk is slow and error-prone, so instead, we call a wrapper script which overrides fs.readFileSync to provide a "virtual" tsconfig.json file with the appropriate before it invokes vue-tsc.
Unfortunately, for an unknown reason, whenever multiple .vue files are specified, vue-tsc encounters an infinite loop and never exits. Thus, each Vue SFC needs to be compiled separately (if there is a solution to this, please let me know!)
In addition, since TypeScript doesn't provide a way to export declarations via standard out, we also have to monkey-patch fs.writeSync to save the declaration output to a temporary variable before outputting it from our wrapper script.
FAQs
A utility function to compile a Vue SFC file into JavaScript and TypeScript definitions.
The npm package compile-vue-sfc receives a total of 857 weekly downloads. As such, compile-vue-sfc popularity was classified as not popular.
We found that compile-vue-sfc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.
Security News
Maintainers back GitHub’s npm security overhaul but raise concerns about CI/CD workflows, enterprise support, and token management.
Product
Socket Firewall is a free tool that blocks malicious packages at install time, giving developers proactive protection against rising supply chain attacks.