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

@iqb/validate-md-profile

v0.7.5

Published

Tooling to validate and generate documentation of metadata profile stores

Downloads

109

Readme

License: MIT npm

Install

Metadata profiles for web applications of IQB are stored in GitHub-repositories. We group metadata profiles in so-called "profile stores" to improve the handling. Every profile store resides in one GitHub repository. The entry point of the store is a config file profile-config.json in the root of the repo.

Best choice is to take one of the GitHub repositories of IQB as template (naming convention: p<nn>). You learn the parameters and files and the way to use the programming of this repo validate-md-profile: You see a package.json (nodejs-universe) and two entries:

    "scripts": {
      "validate": "validate-md-profile"
    },
    "devDependencies": {
      "@iqb/validate-md-profile": "^0.5.1"
    }

Sure the version of the package will change...

Validate

Calling the script will validate the profile-config.json in the root and all profiles listed here:

  • test the syntax of all files against the JSON schema
  • check whether the ids of profile entries are unique

Generate Documentation

To support the dialog between stakeholders during the development phase, the validate-script generates one markdown file as documentation, if a /docs-Folder is found.