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

edictor

v0.4.0

Published

Modular & Self-Contained Javascript object definition and validation

Downloads

74

Readme

{ Edictor }


Documentation


Please read usage documentation at https://nitipit.github.io/edictor/


Features


  • Object definition is easy to use.
  • Provide concise APIs for validations.
  • Validation throws error.
  • Modular : Model and Field can be extends and reused as class and object in ES6.
  • Self-contained : object created from definition will validate itself when object's data changed.
  • Atomic Update : Model().update(data) will update data as all or nothingaccording to validations.
  • Tiny & Compact : ~2kB minify + gzip

Library Development


Environment

  • NodeJS

Recommended editor

  • Visual Studio Code https://code.visualstudio.com/

Setup

$ git clone [email protected]:nitipit/edictor.git
$ cd edictor
$ npm install

Run test for development process

$ npm run test-watch

The command above will run jest testing framework in watch mode.

To test individual file:

$ npx jest --watch src/edictor/field.test.ts

Build { edictor } library

npm run build

Documentation Development


Environment

  • Python
  • NodeJS

Recommended editor

  • Visual Studio Code https://code.visualstudio.com/

Generate static html (Compatible with github page)

  • Result as this page: https://nitipit.github.io/edictor/
  • Command belows will generate static html and start HTTP Server
  • Static html is generated by https://nitipit.github.io/engrave/
$ python -m venv venv
$ source venv/bin/activate
$ pip install -r require.pip
$ python docs.py
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/)

Contribution


Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request


Contact


Nitipit Nontasuwan - [email protected]

Project repository: https://github.com/nitipit/edictor
Project website: https://nitipit.github.io/edictor/