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

@bufferapp/publish-sent

v1.9.25

Published

Sent Posts package

Downloads

266

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

jakubolekjakubolekdavidluhrdavidluhregomezdegomezdjacobchadwelljacobchadwellphilippemiguetphilippemiguetjosemdevjosemdevmsanromanmsanromandaisymarie128daisymarie128hamstuhamstustevenc81stevenc81bufferbotbufferbotmayauribemayauribeesclapesesclapesay8say8smickmahadymickmahadydinostheodinostheohitherejoehitherejoedacedaceerickhunerickhunkmbrisenokmbrisenokiriappeeekiriappeeecmunozgarcmunozgarpeteremilbufferpeteremilbufferarekpnarekpnabeebabeebbuffermwbuffermw

Keywords

Readme

@bufferapp/publish-example

An example UI package that implements a container, reducer and middleware.

NOTE: This package should can be used as a template for new packages.

Quick Start

Start Storybook

If you're interested in working on or observing how things look, starting with React Storybook is a great way to get going. It's setup to automatically reload as the code changes to make it easy to do rapid iteration on components.

npm start

After that copy and paste the host and port that is displayed on the console into a browser.

Developing Multiple Packages In Parallel

If you're running this for multiple packages at the same time, it's helpful to pass in the port number.

npm start -- --port 8003

Run Tests

Tests are run using Jest and UIs are tested and locked down using Jest Snapshots and React Storybook.

Standard Tests

Runs linter, then unit and snapshot tests. These tests are run using CI and are currently running on TravisCI:

https://travis-ci.com/bufferapp/buffer-publish

npm test

Watch Mode

When writing unit tests for things like middleware and the main index file, it's useful to only run the test that change so you can rapidly iterate. Jest watch mode allows you do do this with a single command:

npm run test-watch

Package Anatomy

A UI package should include all concerns related to a given feature.

example/ # root
+-- __snapshots__/
    `-- snapshot.test.js.snap # jest snapshots storage
+-- .storybook/ # React Storybook Configuration
    `-- addons.js # storybook action panel configuration
    `-- config.js # storybook main configuration
    `-- preview-head.html # configure <head> in storybook preview
+-- components/ # presentational components
    +-- LoggedIn # component that displays login state
        `-- index.jsx # implementation of the login display
        `-- story.jsx # description of all the possible configurations of the login display
`-- .babelrc # babel transpiler
`-- index.js # main package file, should export the container and top level  resources
`-- index.test.js # main package file tests
`-- middleware.js # all action side effects
`-- middleware.test.js # test action side effects
`-- package.json # npm package
`-- README.md # you are here
`-- reducer.js # describe how data changes when actions occur
`-- reducer.test.js # test the reducer!
`-- snapshot.test.js # configure jest snapshots

index.js

This is the main package file, it's default export should be the container.

Imagine another package is trying to use the package you're building. The package API should look like this:

import Example, { actions, actionTypes, middleware, reducer } from '@bufferapp/publish-example';

components/

Presentational components (pure ui) are implemented with the followign structure:

+-- components/
    +-- LoggedIn/
        `-- index.jsx
        `-- story.jsx

components/LoggedIn/index.jsx

This should export a functional and stateless component. There are some special cases where handling things like focus, hover and active states that need to be tracked.

If you need focus and or hover take a look at PseudoClassComponent to wrap the component you're building:

https://github.com/bufferapp/buffer-components/blob/master/PseudoClassComponent/index.jsx

Here's an example of how to wrap a Button:

https://github.com/bufferapp/buffer-components/blob/master/Button/index.jsx

components/LoggedIn/story.jsx

This should set the context (properties) for every configuration of the component in index.jsx. The story is used for both React Storybook as well as Jest Snapshots.