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

@atscm/transformer-help

v0.1.0

Published

A transformer that generates help for displays and scripts

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

lhechenbergerlhechenberger

Keywords

atscmtransformtransformergeneratehelpexample

Readme

@atscm/transformer-help

This module is still under development

A transformer that generates help for displays and scripts.

screenshot

Usage

This module is not yet published! You'll have to install it manually in the meantime: Install from source with npm i --save-dev github:atscm/transformer-help, then run npm install and npm run build inside it's directory.

  • Install the package with npm: npm i --save-dev @atscm/transformer-help.
  • Add it to your Atviseproject's transformers. (See ./example/Atviseproject.js for an example).
  • Run atscm push to generate help documents

Note that this will override any custom help documents.

How it works

atscm creates a json file for every display and script describing the parameters available. This transformer reads this information when running atscm push and creates an HTML help file for every node pushed.

Possible improvements

  • [ ] Add a custom description from a markdown file (e.g. src/AGENT/DISPLAYS/Main.display/help.md) to the generated help document.
  • [ ] Support multiple languages
  • [ ] Wrap the code to provide type-safe access to parameters. (Currently, when a parameter with name "test" is set to be a number, webMI.query.test is equal to "13" instead of 13)
  • [ ] Any ideas/thoughts? -> Create an issue