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

@eflexsystems/ember-cli-new-version

v4.1.0-1

Published

A convention based update notification for Ember. With this addon, you can detect a new version and notify the user to refresh the page

Downloads

80

Readme

ember-cli-new-version

Build Status

A convention-based version update notifier. Use it to notify users already on the page that a new version has been deployed.

Compatibility

  • Ember.js v3.20 or above
  • Ember CLI v3.20 or above
  • Node.js v12 or above

Usage

  1. Add this add-on as you would any other:
> ember install ember-cli-new-version
  1. Add a version file to your app, eg: ./public/VERSION.txt
1.0.0
  1. Include the component in your view:
<NewVersionNotifier/>

voila!

Configuration

To setup, you should first configure the service through config/environment:

module.exports = function (environment) {
  var ENV = {
    newVersion: {
      currentVersion: null,
      versionFileName: 'VERSION.txt',
      updateInterval: 60000,
      firstCheckInterval: 0,
      enableInTests: false,
      enableInDev: false,
      maxCountInTesting: 10,    
    },
  };
};

  • currentVersion - The current version of the app if not using [Automatic VERSION file creation][#Automatic VERSION file creation] default: null
  • versionFileName - the name of the file on the server to check default: /VERSION.txt
  • updateInterval - the amount of time, in milliseconds, to wait between version checks default: 60000
  • firstCheckInterval - the amount of time, in milliseconds, to wait before the first version check is run after booting the application default: 0
  • enableInTests - Should the version checking run in test environments? default: false
  • enableInDev - Should the version checking run in the dev environments? default: false
  • maxCountInTesting - How many times to check for a new version in tests. default: 10

Automatic Version File Creation

If no VERSION.txt file exists it will be automatically generated during the build process with the value of currentVersion or the version from package.json.

Supports ember-cli-app-version

Since version 4.0.0 this addons will use the version string provided by ember-cli-app-version if no currentVersion is configured.

All you have to do is install ember-cli-app-version.

Then an update is triggered based on full version strings with build metadata such as 1.0.0-beta-2-e1dffe1.

Notifier Configuration and Interface


  • updateMessage - the message to show to users when update has been detected. There are two tokens allowed in this string: {newVersion} and {oldVersion} which will replaced with their respective values. eg. (and default). "This application has been updated from version {oldVersion} to {newVersion}. Please save any work, then refresh browser to see changes."
  • showReload - true shows a reload button the user can click to refresh. false hides the button. default: true
  • reloadButtonText - Sets the text for the default reload button. default: "Reload"
<NewVersionNotifier
  @updateMessage="A new version was released: {newVersion}"
  @showReload={{true}}
/>

Custom Notification

By default the notification is styled as a Bootstrap Alert. If you want custom layouts or to use a different framework, then you can define your own markup for the notification.

<NewVersionNotifier as |version lastVersion reload close|>
  <div class="custom-notification">
    Reload to update to the new version ({{version}}) of this application
    <button type="button" {{on "click" reload}}>Reload</button>
    <button type="button" {{on "click" close}}>Close</button>
  </div>
</NewVersionNotifier>

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.