Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-09-21 15:56:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
Mailspring/docs/publishing-a-package.md
Ben Gotow 1e8fd46342 fix(drafts): Various improvements and fixes to drafts, draft state management 
Summary:
This diff contains a few major changes:

1. Scribe is no longer used for the text editor. It's just a plain contenteditable region. The toolbar items (bold, italic, underline) still work. Scribe was causing React inconcistency issues in the following scenario:
   - View thread with draft, edit draft
   - Move to another thread
   - Move back to thread with draft
   - Move to another thread. Notice that one or more messages from thread with draft are still there.

There may be a way to fix this, but I tried for hours and there are Github Issues open on it's repository asking for React compatibility, so it may be fixed soon. For now contenteditable is working great.

2. Action.saveDraft() is no longer debounced in the DraftStore. Instead, firing that action causes the save to happen immediately, and the DraftStoreProxy has a new "DraftChangeSet" class which is responsbile for batching saves as the user interacts with the ComposerView. There are a couple big wins here:

   - In the future, we may want to be able to call Action.saveDraft() in other situations and it should behave like a normal action. We may also want to expose the DraftStoreProxy as an easy way of backing interactive draft UI.

   - Previously, when you added a contact to To/CC/BCC, this happened:

     <input> -> Action.saveDraft -> (delay!!) -> Database -> DraftStore -> DraftStoreProxy -> View Updates

Increasing the delay to something reasonable like 200msec meant there was 200msec of lag before you saw the new view state.

To fix this, I created a new class called DraftChangeSet which is responsible for accumulating changes as they're made and firing Action.saveDraft. "Adding" a change to the change set also causes the Draft provided by the DraftStoreProxy to change immediately (the changes are a temporary layer on top of the database object). This means no delay while changes are being applied. There's a better explanation in the source!

This diff includes a few minor fixes as well:

1. Draft.state is gone—use Message.object = draft instead
2. String model attributes should never be null
3. Pre-send checks that can cancel draft send
4. Put the entire curl history and task queue into feedback reports
5. Cache localIds for extra speed
6. Move us up to latest React

Test Plan: No new tests - once we lock down this new design I'll write tests for the DraftChangeSet

Reviewers: evan

Reviewed By: evan

Differential Revision: https://review.inboxapp.com/D1125
2015-02-03 16:24:31 -08:00

4.4 KiB
Raw Blame History

Publishing a Package

This guide will show you how to publish a package or theme to the atom.io package registry.

Publishing a package allows other people to install it and use it in Atom. It is a great way to share what you've made and get feedback and contributions from others.

This guide assumes your package's name is my-package but you should pick a better name.

Install apm

The apm command line utility that ships with Atom supports publishing packages to the atom.io registry.

Check that you have apm installed by running the following command in your terminal:

apm help publish

You should see a message print out with details about the apm publish command.

If you do not, launch Atom and run the Atom > Install Shell Commands menu to install the apm and atom commands.

Prepare Your Package

If you've followed the steps in the your first package doc then you should be ready to publish and you can skip to the next step.

If not, there are a few things you should check before publishing:

  • Your package.json file has name, description, and repository fields.
  • Your package.json file has a version field with a value of "0.0.0".
  • Your package.json file has an engines field that contains an entry for Atom such as: "engines": {"atom": ">=0.50.0"}.
  • Your package has a README.md file at the root.
  • Your package is in a Git repository that has been pushed to GitHub. Follow this guide if your package isn't already on GitHub.

Publish Your Package

Before you publish a package it is a good idea to check ahead of time if a package with the same name has already been published to atom.io. You can do that by visiting https://atom.io/packages/my-package to see if the package already exists. If it does, update your package's name to something that is available before proceeding.

Now let's review what the apm publish command does:

  1. Registers the package name on atom.io if it is being published for the first time.
  2. Updates the version field in the package.json file and commits it.
  3. Creates a new Git tag for the version being published.
  4. Pushes the tag and current branch up to GitHub.
  5. Updates atom.io with the new version being published.

Now run the following commands to publish your package:

cd ~/github/my-package
apm publish minor

If this is the first package you are publishing, the apm publish command may prompt you for your GitHub username and password. This is required to publish and you only need to enter this information the first time you publish. The credentials are stored securely in your keychain once you login.

🎉 Your package is now published and available on atom.io. Head on over to https://atom.io/packages/my-package to see your package's page.

With apm publish, you can bump the version and publish by using

apm publish <version-type>

where <version-type> can be major, minor and patch.

The major option to the publish command tells apm to increment the first digit of the version before publishing so the published version will be 1.0.0 and the Git tag created will be v1.0.0.

The minor option to the publish command tells apm to increment the second digit of the version before publishing so the published version will be 0.1.0 and the Git tag created will be v0.1.0.

The patch option to the publish command tells apm to increment the third digit of the version before publishing so the published version will be 0.0.1 and the Git tag created will be v0.0.1.

Use major when you make a huge change, like a rewrite, or a large change to the functionality or interface. Use minor when adding or removing a feature. Use patch when you make a small change like a bug fix that does not add or remove features.

Further Reading