cable_ready

v5.0.5

CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. For more information about how to use this package see README

Latest version published 6 months ago

License: MIT

NPM

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
5.0.5	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.5.0	\|	01/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.4.6	\|	12/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.3.0	\|	07/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.2.0	\|	06/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (8,505)

GitHub Stars: 756
Forks: 70
Contributors: -

Direct Usage Popularity

The npm package cable_ready receives a total of 8,505 downloads a week. As such, we scored cable_ready popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package cable_ready, we found that it has been starred 756 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 0
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 5
Open PR: 9
Last Release: 6 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of cable_ready based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that cable_ready demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 1 Direct
Versions: 51
Install Size: 178 kB
Dist-tags: 1
# of Files: 42
Maintainers: 3
TS Typings: No

cable_ready has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use cable_ready?

To help you get started, we've collected the most common ways that cable_ready is being used within popular public projects.

leastbad / optimism / lib / templates / optimism_channel.js View on Github

received (data) {
    if (data.cableReady)
      CableReady.perform(data.operations, {
        emitMissingElementWarnings: false
      })
  }
})

View more ways to use cable_ready

Welcome to CableReady 👋

CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. It establishes a standard for interacting with the client via ActionCable web sockets. No need for custom JavaScript.

Please read the official ActionCable docs to learn more about ActionCable before proceeding.

📚 Docs

💙 Community

Discord - primary support channel

🚀 Install

Rubygem

bundle add cable_ready

JavaScript

There are a few ways to install the CableReady JavaScript client, depending on your application setup.

ESBuild / Webpacker

yarn add cable_ready

Import maps:

# config/importmap.rb

# ...

pin 'cable_ready', to: 'cable_ready.js', preload: true

Rails Asset pipeline (Sprockets):



&lt;%= javascript_include_tag "cable_ready.umd.js", "data-turbo-track": "reload" %&gt;

Checkout the documentation to continue!

🙏 Contributing

Code of Conduct

Everyone interacting with CableReady is expected to follow the Code of Conduct

Coding Standards

This project uses Standard and prettier-standard to minimize bike shedding related to code formatting.

Please run ./bin/standardize prior submitting pull requests.

📦 Releasing

Make sure that you run yarn and bundle to pick up the latest.
Bump version number at lib/cable_ready/version.rb. Pre-release versions use .preN
Run rake build and yarn build
Commit and push changes to GitHub
Run rake release
Run yarn publish --no-git-tag-version
Yarn will prompt you for the new version. Pre-release versions use -preN
Commit and push changes to GitHub
Create a new release on GitHub (here) and generate the changelog for the stable release for it

📝 License

CableReady is released under the MIT License.

cable_ready dependencies

morphdom

cable_ready development dependencies

@open-wc/testing @rollup/plugin-json @rollup/plugin-node-resolve @rollup/plugin-terser @web/dev-server-esbuild @web/dev-server-rollup @web/test-runner prettier-standard rollup sinon vite vitepress vitepress-plugin-search

FAQs

What is cable_ready?

CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes fro... Visit Snyk Advisor to see a full health score report for cable_ready, including popularity, security, maintenance & community analysis.

Is cable_ready popular?

The npm package cable_ready receives a total of 8,505 weekly downloads. As such, cable_ready popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cable_ready well maintained?

We found that cable_ready demonstrated a healthy version release cadence and project activity. It has a community of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is cable_ready safe to use?

The npm package cable_ready was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 02:44 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP