npmpackage.info

Gathering detailed insights and metrics for vue-script-tsc

Other packages similar to vue-script-tsc

vue-demi-with-tsc

0.0.5

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

Gathering detailed insights and metrics for vue-script-tsc

vue-script-tsc

A lightning fast TypeScript type checker for Vue SFC Script tags

1.3.1

BSD-3-Clause

TypeScript

19.80 kB

59,790 2.5

Installations

npm install vue-script-tsc

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.12.0

NPM Version

8.19.3 Score

64.7

Supply Chain

98.8

Quality

75.5

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

0

Total

4

Closed

0

Merged

4

Issues

Open

0

Total

6

Closed

6

Releases

v1.3.1

Published on 28 Nov 2022

v1.3.0

Published on 08 Oct 2021

v1.2.0

Published on 01 Oct 2021

v1.1.0

Published on 31 May 2021

v1.0.2

Published on 28 May 2021

v1.0.1

Published on 28 May 2021

View all 7 releases

Contributors

Unable to fetch Contributors

View all 3 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (87.47%)

JavaScript (11.43%)

Shell (1.11%)

Developer

policyfly

Download Statistics

Total Downloads

59,790

Last Day

Last Week

396

Last Month

2,311

Last Year

29,221

GitHub Statistics

7 Stars

36 Commits

1 Watching

1 Branches

3 Contributors

Maintainers

Package Meta Information

Latest Version

1.3.1

Package Id

vue-script-tsc@1.3.1

Unpacked Size

19.80 kB

Size

7.30 kB

File Count

NPM Version

8.19.3

Node Version

18.12.0

Total Downloads

Cumulative downloads

Total Downloads

59,790

Last day

-91.7%

Compared to previous day

Last week

-28.9%

396

Compared to previous week

Last month

-0.9%

2,311

Compared to previous month

Last year

46.3%

29,221

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Vue Script TSC

⚡️ A lightning fast TypeScript type checker for Vue SFC Script tags ⚡️

Features

Type Checks the <script> tags of .vue files + any related .ts files
Can be run in a CLI without requiring a build tool (such as webpack)
Uses your local TypeScript version
Respects files/include/exclude as specified in your tsconfig.json
Supports incremental builds
Simple, lightweight & fast

Prerequisites

Node ^12.0.0
TypeScript ^3.0.0

Usage

To get started, install vue-script-tsc.

1yarn add -D vue-script-tsc

CLI

You can run vue-script-tsc as a script in package.json, either by itself or as part of a build process:

1// package.json
2"scripts": {
3  "tsc": "vue-script-tsc --root .",
4  "build": "vue-script-tsc --root . && vue-cli-service build"
5}

Or on the command line:

1# Command line
2yarn vue-script-tsc --root .

Programmatic

You can call vue-script-tsc within your own script.

1const { tsc } = require('vue-script-tsc');
2
3tsc({
4  root: process.cwd()
5})
6  .then(() => {
7    console.log('Type Check Complete')
8  })
9  .catch((err) => {
10    console.error(err)
11    process.exit(1)
12  })

Arguments

You can specify some arguments with either usage. For CLI arguments prepend with a --, for example --root src. For programmatic pass an options object with these as keys.

Option	Default	Description
`root`	Current Directory	The relative path to the directory to be treated as the root (where your `tsconfig.json` file exists)
`tsconfig`	`tsconfig.json`	The name of your `tsconfig.json` file (*)

(*) It is recommended you use a dedicated tsconfig.json for vue-script-tsc. If you use incremental builds you should specify a different compilerOptions.tsBuildInfoFile.

Comparisons

vue-tsc

Can also type check the Template within SFCs
Only supports Vue3
Currently does not provide an option to skip Template type checking
Supports <script setup> (which vue-script-tsc does not)

Webpack (vue-cli)

Only checks whilst running a development server or after a build
Requires compiling the entire app before type checking
Does not type check the Template (same as vue-script-tsc)
On a real life project took >240s compared to vue-script-tsc which took ~30s

Technical Details

Type checking SFC (.vue) files, especially in Vue2, can be a painful process. The main problem is that the SFC layout means that it has to be preprocessed into TypeScript first, including converting the Template into a render function that can be type checked.

However the bulk of the logic is in the <script> tag, which in itself is just TypeScript. So if we ignore everything else except that then the only preprocessing we need is to remove everything except what is in that tag. This is essentially how vue-script-tsc works. We create a custom compiler host which extracts only the <script> tag from .vue files.

The only other caveat is that TypeScript will refuse to check a file that does not have an extension it recognises. So we trick it into processing them by appending .ts whenever referring to a .vue file, which we then remove when actually trying to access the file.

License

Please see LICENSE.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to vue-script-tsc

Other packages similar to vue-script-tsc

vue-script-tsc

Installations

Developer Guide

Yes

CommonJS

18.12.0

8.19.3

Score

Pull Requests

0

4

0

4

Issues

0

6

6

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

policyfly

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

59,790

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Vue Script TSC

Features

Prerequisites

Usage

CLI

Programmatic

Arguments

Comparisons

vue-tsc

Webpack (vue-cli)

Technical Details

License

10

10

10

0

0

0

0

0

0

0

0

0

0

2.5

/10