Code Monkey home page Code Monkey logo

insomnia-plugin-git-integration's Introduction

Git integration for Insomnia

⚠️ THIS PLUGIN DOES NOT WORK WITH INSOMNIA VERSION 8 OR HIGHER

Since Insomnia version 8 all data is saved in the cloud and cannot be accessed by this plugin. Use version 2023.5.8 of Insomnia or Insomnium, if you still want to use this Plugin.

I would recommend switching to another API-Client like Bruno.


Insomnia plugin for exporting and importing insomnia Projects into Git repositories.

⚠️ This plugin accesses Insomnia data directly. It is recommended to back up Insomnia data before using it. Insomnia may introduce changes that break this Plugins functionality. If you have problems after an Update, please create a new issue.

Features

  • Export and import Insomnia projects
  • Manage projects with git, without leaving Insomnia (Pull, Push, Commit)

Requirements

  • git must be installed
  • Credentials must be setup for pushing and pulling

How to use

Setup with existing project

  • This plugin does not work with the default Insomnia project, you must create a other project.
  • Open the collection overview of the existing project.
  • Click the plus on the top right and in the dropdown choose Configure project

  • In the dialog, you can now choose a folder to where your project data should be saved
  • You can init a git repository in the choosen folder or manualy create/use one from a parent folder.
    • The git repository is fully optional. You can just this plugin for importing and exporting your project data

Import project from git

  • Click on the git symbol in the left sidebar

  • Choose a folder with the plugins project.json file
  • The project will be importet and Insomnia will restart

New buttons refence

This plugins injects new Buttons into the Insomnia ui.

  • Top left in project overview:
    • git-Button allowes to open a folder with an project.json from an exported project and import it into Insomnia
  • Create dropdown
    • Export Project export the project and all its workspaces into the configured folder
    • Import Project import data from configured folder, Insomnia will restart for this
    • Configure project Open a dialog to configure the project.
    • Commit changes exports the project data and commits it
    • Push push all commits to the current remote branch
    • Fetch fetch new commits from the remote repository
    • Pull pull new commits from current remote branch
  • Inside the workspace dropdown
    • Export workspace to Git export just this workspace into the configured folder
    • Import workspace from Git import just this workspace from the configured folder

TODO

  • UI for resolving merge conflicts

Development

Requirements

  • nodejs
  • yarn

Clone the repostitory and add the path to the additional plugin path (Settings > General > Additional Plugin Path)

Use yarn run watch to auto rebuild the project when changes are made.

Use npx eslint src --ext .ts,.tsx --fix to execute eslint

insomnia-plugin-git-integration's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

insomnia-plugin-git-integration's Issues

Configuration

Hey, after installing the plugin I can't seem to find the configure project button. I do see the git button. In the top right 'Create' menu I only see request collections/design document/Import/Git Clone.

Error installing Plugin through Insomina UI

On Insomnia v2023.2.2 when trying to install the plugin through the plugin manager I receive the following error:
image

I have tried to install the plugin manually, but seem to be running into different issues there. Any and all help would great!

Thank you!

Support for gitignore

Hi

would it be possible to add a gitignore functionality , in my case for environment, as I don't want all my password and other secure data shared

also maybe a way in environments to set fields as secure and replace the value with "****" before the commit

Thanks

UI does not work anymore on 2023.5.7

Describe the bug

Hello!

Looks like Insomnia changed a couple of things in the last update which means the plugin can't find the references to inject the UI anymore.

Console errors

No :(

No new 'Create' UI buttons

Describe the bug
Just installed the plugin on the latest Version: Insomnia 2023.2.2 and no UI buttons are appearing in 'Create' dropdown.

image

[Feature request] Auto export/import option

Hi, thanks for creating the integration.

Personally, I like your approach more than the one that comes with the project. :)

As someone who mainly handles git related operations in the terminal, it would be great to have an auto export/import option, so diffs will automatically show up when changes are made, or reflected on Insomnia when branches changed.

There are definitely questions about how to handle conflicts but that can be a separate discussion.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.