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

ros-typescript-generator

v1.9.0

Published

A CLI for generating typescript interfaces from ros messages and services

Downloads

14,081

Readme

Ros Typescript Generator

CircleCI

A CLI for generating typescript interfaces and enums from ros msg files.

Features

  • [x] ROS1 and ROS2 support
  • [x] Generate ts types from ROS msgs
  • [x] Generate ts enums from ROS msgs
  • [x] Configurable type prefix, eg) IRosType or Ros (config: {"typePrefix": "IRosType"})
  • [x] TypeScript namespaces for ROS packages (config: {"useNamespaces": true})
  • [x] Works with custom .msg, .srv and .action files
  • [x] No runtime dependencies
  • [x] Smart enum support (config: {"smartEnums": true})
# example_msgs/example.msg
uint8 STATUS_DISABLED = 0 
uint8 STATUS_ENABLED = 1

uint8 OTHER_THING_1 = 1
uint8 OTHER_THING_2 = 2

uint8 status
uint8 other
uint8 more

Becomes

export interface ExampleMsgsExample {
  status: ExampleMsgsExampleStatus;
  other: ExampleMsgsExampleOther;
  more: number;
}

export enum ExampleMsgsExampleStatus {
  DISABLED = 0,
  ENABLED = 1,
}

export enum ExampleMsgsExampleOther {
  THING_1 = 1,
  THING_2 = 2,
}

Comparison to rclnodejs / rostsd-gen

Unlike rostsd-gen, this ONLY generates ts types and enums. This means the output does not include any nodejs dependencies. In fact, it has no runtime dependencies at all. It uses interfaces rather than classes 🙂. This makes it good option for any frontend project.

Usage

  • Add a ros-ts-generator-config.json file to your project root. For example:
{
  "output": "./generated/ros_msgs.ts",
  "rosVersion": 2, // 1 or 2
  "input": [
    {
      "namespace": "std_msgs",
      "path": "/opt/ros/iron/share/std_msgs"
    },
    {
      "namespace": "geometry_msgs",
      "path": "/opt/ros/iron/share/geometry_msgs"
    },
    // Add any other messages including your own custom messages.
  ],
  "typePrefix": "IRosType"
}
  • Run npx ros-typescript-generator --config ros-ts-generator-config.json
  • Done!

Examples

Credit

Credit goes to foxglove for their foxglove/rosmsg library.