Skip to content

1337z/lisher

Repository files navigation

(Pub)lisher πŸš€

Build Status Issues Forks Stars License

Simple package publisher/releaser for your projects with live output!


Features | Installation | Usage | Preview (outdated) | License


⭐ Features

Preview

Publish your module to NPM, GIT and VSCE with a single command.
You can choose where you want your module to be published.
Lisher will detect task managers as grunt and will ask you to run them before publishing!
You forgot to commit your changes? Don't worry, lisher will notify you and if you want you can also set the commit message in lisher itself for an even faster publication.

Publish providers

  • GIT
  • NPM (Node Package Manager)
  • VSCE (Visual Studio Code Extension [Marketplace])
  • Want more? Send an issue or pull request :)

Detections

  • Detect GIT repository
    • Detect unstaged changes
    • Commit unstaged changes (we will ask you first)
  • Detect NPM module
  • Detect VS Code extension
  • Detect Gruntfile
  • Want more? Send an issue or pull request :)

πŸ“¦ Install

$ npm i -g lisher

πŸ“‹ Usage

Simply run this command in your project directory. It will start the publish wizard ✨

$ lisher

Task managers

Grunt

If lisher detects a Gruntfile, it will ask you to run Grunt for you before publishing the module. If you select Yes (standard selection) lisher will run Grunt for you.

Publish to a git repository

If you have uncommited files, it's good to commit them before publishing the project. Lisher will ask you to do so if you haven't already.
Notice: When you commit your changes via the lisher interface you won't be able to set a commit message body for the sake of fast publishing.

  1. First of all start Lisher
$ lisher
  1. Select GIT
  2. Follow the instructions given by the terminal

Publish to NPM

If you have uncommited files, it's good to commit them before publishing the project. Lisher will ask you to do so if you haven't already.
Notice: When you commit your changes via the lisher interface you won't be able to set a commit message body for the sake of fast publishing.

  1. First of all start Lisher
$ lisher
  1. Select NPM
  2. Follow the instructions given by the terminal

Publish to the Visual Studio Code Marketplace

If you have uncommited files, it's good to commit them before publishing the project. Lisher will ask you to do so if you haven't already.
Notice: When you commit your changes via the lisher interface you won't be able to set a commit message body for the sake of fast publishing.

  1. First of all start Lisher
$ lisher
  1. Select VSCE
  2. Follow the instructions given by the terminal

🎬 Preview

Outdated!

GIT

GIT

Preview GIT

GIT with dirty working directory

Preview GIT dirty workdir

Grunt

Grunt task manager

Preview Grunt

NPM

NPM & GIT

Preview NPM

VSCE

VSCE & GIT

Preview VSCE

License

MIT License

Copyright (c) 2018-2019 MarvinJWendt

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.