https://github.com/forivall/atom-deprecation-notice

https://github.com/forivall/atom-deprecation-notice

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/forivall/atom-deprecation-notice
• Owner: forivall
• Created: 2019-10-20T23:16:46.000Z (about 5 years ago)
• Default Branch: latest
• Last Pushed: 2024-08-29T16:56:28.000Z (4 months ago)
• Last Synced: 2024-10-28T13:16:33.904Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 265 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Deprecation Notice for Atom editor packages

===

This is a simple utility to display a deprecation notice for your package to the user to indicate that your package is deprecated. Used by [`remember-folds`](https://github.com/forivall/atom-remember-folds).

## Usage

For packages without any code, create an index.js with the following:

```js

module.exports = require('atom-deprecation-notice');

```

For packages with existing code, add the following to your `activate` function:

```js

  require('atom-deprecation-notice')();

```

or

```ts

import showDeprecationNotice from 'atom-deprecation-notice';

// ... in activate()

  showDeprecationNotice();

```

## Related things

* [depd](https://github.com/dougwilson/nodejs-depd)