npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@marko/type-check

v1.2.5

Published

A CLI to type check Marko projects

Downloads

903

Readme

Marko Type Check (@marko/type-check)

A CLI for running type checks on .marko, .ts, and .js files.

Installation

npm install --save-dev @marko/type-check

Usage

Use the marko-type-check or mtc command followed by options to run type checks on your project files:

marko-type-check [options]

# or with the shorthand
mtc [options]

Options

| Option | Alias | Description | Default Value | | ---------------- | ----- | ---------------------------------------------------------------------- | ---------------------------------- | | --project | -p | Path to the tsconfig or jsconfig file | ./tsconfig.json or ./jsconfig.json | | --display | -d | Set the display type for error output. Choices: codeframe or condensed | codeframe | | --help | -h | Display the help text | | | --version | -v | Display the CLI version, Marko version, and TypeScript version | |

Examples

Run type check with the default tsconfig.json file:

marko-type-check

Run type check with a custom jsconfig.json file and condensed error output:

mtc -p ./jsconfig.json -d condensed

FAQ

What files are emitted?

Outputs files are similar to the tsc cli in build mode. Meaning .js and .d.ts files will be output (depending on your project config). Beyond that .marko files with their types stripped and an associated .d.marko file will be output that serve a similar purpose to the .js and .d.ts files.

What is a .d.marko file?

A .d.marko files is similar to a .d.ts file. All script content in the file will be processed as if the Marko script-lang was typescript and the Marko-VSCode plugin and this CLI will both prefer loading a .d.marko over an adjacent .marko file. The .d.marko files output by this tool will strip out any runtime code such that only type information is in the .d.marko output.

Does this replace tsc?

Yes this replaces tsc since in order to provide proper type checking for .marko files the .ts and .js files must be processed as well.

Contributing

Contributions are welcome! Please read our Contributing Guidelines for more information on how to contribute.

License

This project is licensed under the MIT License.