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

cdscribe

v1.0.3

Published

"Cdscribe is a tool that allows you to annotate source code files. The tool retrieve the annotations using a search pattern"

Downloads

3

Readme

Cdscribe

Cdscribe is a tool for making and retrieving source-code annotations in a simple way.

Text files contain annotations and can be written using any standard text editor. The tools retrieve the annotations using a search pattern.

It's a great solution for annotating third-party libraries. When it is not possible to insert comments in the code that can be replaced/deleted by the next version.

Installation

Install cdscribe

npm install -g cdscribe

remember to give the necessary permissions

Create the folder to store the .cdscribe files

cdscribe --init

Documentation

When you start cdscribe, a new folder called Cdscribe should have appeared in the root of your project - this is where the annotation files will be stored

project
| README.md
│ package.json 
| index.js
│   
└───Src
│ │ Controllers
│ │ Services
│   
└───Cdscribe
    │ index.js.cdscribe

You should add all your commented files inside this folder and add the extension .cdscribe to them

index.js -> index.js.cdscribe

ps: cdscribe must be run in the root of the project

Example file

//index.js.cdscribe

@About 
This is the project's main file, it imports the {ValidityMath, ComplexMath} functions from the utils.js file. 

one of its functions is to start server.js and open the API endpoints

It also makes use of the external library {math.js} 

@CalculateTotalPrice
function calculateTotalPrice(items, prices)

This function takes two arguments: items (an array of objects representing items)
and prices (an object with keys representing item names and values representing their corresponding prices). 
It calculates the total price of all the items in the items array by multiplying the quantity of each item by its price and adding up the results. 

Use Cases

cdscribe

Return the complete annotations file

cdscribe index.js 

Return some specific @Blade from the file

// Return the @about description
cdscribe index.js @About

// Return the description of @CalculateTotalPrice
cdscribe index.js @CalculateTotalPrice

About

cdscribe is a javascript tool that was developed in three days, and was mostly inspired by a tool available on https://suckless.org/.

The tool is called Kelp and can be found here: https://kelp.sourceforge.net/

There have been several mentions of this library, such as the expression @blade