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

@hulu/splitshot

v1.2.0

Published

Generates rough TypeScript declarations from CoffeeScript sources

Downloads

214

Readme

@hulu/splitshot

A NodeJS module that generates rough TypeScript declarations from CoffeeScript sources

Installation

To run it from the command line:

$ npm install -g @hulu/splitshot

or to run it from JavaScript:

$ npm install --save @hulu/splitshot

Usage

CLI

The splitshot CLI command accepts the path to a .coffee file as its only argument and prints (to stdout) the TypeScript declaration for the provided .coffee file. You'll likely want to redirect stdout to a file like so:

$ splitshot path/to/SingleOrigin.coffee > path/to/SingleOrigin.d.ts

From JavaScript

const splitshot = require("@hulu/splitshot");
const fs = require("fs");

const pathToCoffee = "path/to/SingleOrigin.coffee";

fs.readFile(pathToCoffee, (err, data) => {
  if (err) { throw err };
  const declarations = splitshot.generateDeclarations(data, pathToCoffee);

  // do stuff with those declarations!
});

Optional adjustments to tsconfig.json

By default, TypeScript only looks for .d.ts files next to the file being required, e.g.

import foo = require("./foo");

results in a path search for ./foo.d.ts or ./foo.ts at compile-time. This makes integration with CoffeeScript sources initially very simple: just put the .d.ts files next to the corresponding .coffee file. This quickly gets very messy -- especially for large CoffeeScript projects. To keep the generated .d.ts files in a separate directory, use the rootDirs compiler option to add an additional types source:

{
    "compilerOptions": {
        "module": "commonjs",
        "moduleResolution": "node",
        "target": "es3",
        "outDir": "bin/typescript/",
        // check ./src and ./bin/types/src for type declarations
        "rootDirs": [
            "./src",
            "./bin/types/src/"
        ]
    },
    "include": [
        "core/**/*.ts"
    ]
}

Just be sure to mirror the directory structure in ./src so the lookup paths match! @hulu/gulp-splitshot (coming soon) handles directory structure matching, so consider using it for projects that build with gulp.