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

@jaspero/jmsp-help

v1.5.4

Published

A set of plugins for [JMS](https://github.com/Jaspero/jms).

Downloads

40

Readme

JMS Plugins

A set of plugins for JMS.

Notes

A custom element intended for use on overview pages. It's a way for adding notes to any document. You would typically use it in layout.table.actions like this:

{
  "actions": [{
    "value": "it => '<jms-e-notes data-id=' + it.id + '></jms-e-notes>'"
  }]
}

or you can use the note-view element in a single instance:

{
  "instance": {
    "segments": [
      {
        "components": [{
          "selector": "note-view"
        }]
      }
    ]
  }
}

Setup

  1. Install the plugin npm i --save @jaspero/jmsp-notes
  2. Import the JMSPNotesModule in the ModuleInstanceModule in your JMS project.

Quick Edit

Adds the capability for editing documents through a dialog.

Setup

  1. Install the plugin npm i --save @jaspero/jmsp-quick-edit
  2. Import the JMSPQuickEditModule in the ModuleInstanceModule in your JMS project.
  3. For translations add the following to your transloco.config.js:
    module.exports = {
       scopedLibs: [
         {
           src: './node_modules/@jaspero/jmsp-qe',
           dist: ['./projects/cms/src/assets/i18n/']
         }
       ]
     };
    
  4. Import translations by running: transloco:extract-scoped-libs.

You can now use <jms-e-quick-edit data-id="some-id"></jms-e-quick-edit>.

It's also possible to override which segments are shown in quick edit by using metadata.quickEditSegments.

Help FlyOut

A popup for help articles. It's module based and changes dynamically based on what module the user is currently on.

Setup

  1. Install the plugin npm i --save @jaspero/jmsp-help
  2. Import the JMSPHelpModule in the DashboardModule in your JMS project. You can use JMSPHelpModule.forRoot() to configure height, width as well as top and left position.
  3. Add <jmsp-help-toggle></jmsp-help-toggle> somewhere in your project (it's mainly intended to go in the layout navigation).
  4. In order to be able to add articles through JMS you will need to install the projects module npm i --save @jaspero/jmsp-modules in setup as well and add HELP_PLUGIN_MODULE to modules.ts.
  5. For translations add the following to your transloco.config.js:
    module.exports = {
       scopedLibs: [
         {
           src: './node_modules/@jaspero/jmsp-help',
           dist: ['./projects/cms/src/assets/i18n/']
         }
       ]
     };
    
  6. Import translations by running: transloco:extract-scoped-libs.
  7. You will also need to add the following firestore index:
    {
      "collectionGroup": "help",
      "queryScope": "COLLECTION",
      "fields": [
        {
          "fieldPath": "module",
          "order": "ASCENDING"
        },
        {
          "fieldPath": "order",
          "order": "ASCENDING"
        }
      ]
    }

You can find an example implementation here.

GitHub Issues

A set of components for working with github issues.

Development

Creating a plugin

  1. Run ng g library [plugin-name] --prefix=jmsp
  2. Add @jaspero/jmsp- prefix in the projects package.json
  3. Add a release property. Example from notes plugin (remember to replace all references of "notes").
      "release": {
        "pkgRoot": "../../dist/@jaspero/jmsp-notes",
        "branch": "master",
        "verifyConditions": [
          "@semantic-release/changelog",
          "@semantic-release/npm",
          "@semantic-release/git"
        ],
        "prepare": [
          "@semantic-release/changelog",
          "@semantic-release/npm",
          "@semantic-release/git"
        ],
        "publish": [
          "@semantic-release/npm",
          [
            "@semantic-release/github",
            {
              "assets": [
                "dist/@jaspero/jmsp-notes"
              ]
            }
          ]
        ],
        "plugins": [
          "@semantic-release/commit-analyzer",
          "@semantic-release/release-notes-generator"
        ]
      }
  4. Create ng-package.prod.json. Example from notes plugin (remember to replace all references of "notes").
    {
      "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
      "dest": "../../dist/@jaspero/jmsp-notes",
      "lib": {
        "entryFile": "src/public-api.ts"
      }
    }
  5. In angular.json extend the architect.configurations.production with ng-package.prod.json
     "configurations": {
       "production": {
         "tsConfig": "projects/notes/tsconfig.lib.prod.json",
         "project": "projects/notes/ng-package.prod.json"
       }
     }
  6. Add build scripts for the library in to the root package.json
  7. Build the library and publish an initial version manually. This is required because since it's a scoped package it needs to be explicitly flagged as public. You can do this by running npm publish --access public in dist/@jaspero/[package-name].

License

MIT © Jaspero Ltd