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

generator-shimo-ts

v4.2.1

Published

A minimal Yeoman Generator for creating NodeJS modules using TypeScript

Downloads

3

Readme

TypeScript NodeJS Generator

Build Status npm version

Bonjour! I'm a minimal Yeoman generator for creating NodeJS packages using TypeScript. I let you quickly setup a project with latest available tools and best practices.

I use:

You want to know if you can change any of these? Of course, why not? It is your package after all. I simply get down to business of generating, no questions asked and then quiety get out of the way!

Usage

Install generator-shimo-ts globally.

$npm i -g generator-shimo-ts

Create a new directory and cd into it.

$mkdir my-new-project && cd $_

Run the generator.

$yo node-typescript

You can choose to use mocha as your test framework using command - $yo node-typescript --mocha

You can choose to use ava as your test framework using command - $yo node-typescript --ava

Generate a new class and test file.

$yo node-typescript:classlib MyNewClass [--mocha | --ava]

Highlights of the latest release

  • I use latest version of TypeScript.

  • I use yarn in place of npm if it's available.

  • I use jest which is a "batteries-included" testing framework with coverage built-in (optionally mocha or ava). You write tests in TypeScript itself.

  • I use prettier integrated with tslint to provide no-fuss code formatting and linting.

  • I need no global dependencies. Every dependency such as TypeScript and tslint is installed as local dev dependency allowing you to freely use different versions of these for different packages.

    Integration with VS Code

  • I configure build, clean, lint, coverage, format and test tasks that you can run using Run Task option.

  • You can directly run currently open source file using task Run current file. I use ts-node to provide this functionality.

  • You can debug currently open source file using Debug file launch configuration. You can also debug currently open test file using Debug test launch configuration without the need of compiling it first. Here is the preview -

    TypeScript debugging in VS Code

License

MIT