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

@noodle-graph/scanner

v0.0.17

Published

- [Scanning](#scanning) - [Noodle comment](#noodle-comment) - [Undeclared resources](#undeclared-resources) - [Scan output](#scan-output) - [Relationship object](#relationship-object)

Downloads

10

Readme

Scanner

Scanning

  1. Login to GitHub user.
  2. Clone repositories.
  3. Scan the files in each repository and search Noodle comments.
  4. Enrich and return the result object.

Noodle comment

A code comment that represents a relationship with another resource. It has (roughly) the following structure: noodle --{action}-> {resourceId} ({tags})

For example:

  • // noodle --requests from-> another-api-service (http,get,feature1,feature1)
  • // noodle <-receive from-- sqs-my-queue (sqs,feature2,data)
  • /* noodle --uploads to-> s3-my-bucket (s3,feature1) */
  • # noodle --publish to-> sns-topic1 (sns,feature2)
  • // noodle --> sns-topic2 (sns,feature2)
  • // noodle <-> sns-topic3

Every time the scanner finds a Noodle comment it will add the relationship to the results.

Undeclared resources

Resources that were discovered during the scan and were not listed in the scan config file.

Scan output

Here is a sample of scan output:

{
  "resources": [
    {
      "id":"some-service",
      "url":"./someService",
      "name":"Some Service",
      "tags": [
        "feature1",
        "feature2",
        "service"
      ],
      "type":"aws/ecs",
      "source":"local",
      "relationships": [
        {
          "action":"requests from",
          "resourceId":"another-service",
          "tags":[
            "feature",
            "hello"
          ],
          "url":"./someService",
          "from":false,
          "to":true
        }
      ],
      "additionalLinks": []
    },
    {
      "id":"another-service",
      "url":"./anotherService",
      "name":"Another Service",
      "tags": [
        "feature1",
        "service"
      ],
      "type":"aws/ecs",
      "source":"local",
      "relationships": [
        {
          "action":"query",
          "resourceId":"some-db",
          "tags":[
            "feature"
          ],
          "url":"./anotherService",
          "from":false,
          "to":true
        }
      ],
      "additionalLinks": []
    },
    {
      "id":"some-db",
      "name":"Some DB",
      "tags": [
        "feature1",
        "feature2",
        "service"
      ],
      "type":"aws/aurora",
      "additionalLinks": []
    }
  ]
}

Note that this is very similar to the scan config file, except the relationships field

Relationship object

| Field | Description | |-|-| | resourceId | The identifier of the related resource. | | action | The action declared in the relationship. | | tags | The tags of the relationship for filtering. | | url | The link to the exact line of the Noodle comment. | | from | Whether arrow should be in the "from" resource. | | to | Whether arrow should be in the "to" resource. |