Add documentation

Author: DannyFeliz

.gitignore

@@ -0,0 +1,119 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage
+# (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env*.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# End of https://www.toptal.com/developers/gitignore/api/node

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Danny Feliz
+
+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.

README.md

@@ -0,0 +1,39 @@
+# open-pr
+
+open-pr is a CLI that allows you to open the URL to create a pull request pointing to the base branch in Github.
+
+## Installation
+
+Use npm or yarn to install open-pr.
+
+```bash
+# npm
+npm install @dannyfeliz/open-pr --global
+
+# yarn
+yarn add @dannyfeliz/open-pr --global
+```
+
+## Usage
+
+```
+// in the terminal in your project folder
+open-pr
+```
+
+It will open an URL to create a new pull request pointing to the base branch.
+
+e.g.
+if you have the `linux` project and you're working in a cool feature like `my-cool-feature` and the project origin url is `[email protected]:torvalds/linux.git` if you run `open-pr` it will open this URL
+
+```bash
+https://github.com/torvalds/linux/compare/my-cool-feature?expand=1
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

open-pr.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+const util = require('util');
+const exec = util.promisify(require('child_process').exec);
+const gitRemoteOriginUrl = require('git-remote-origin-url');
+const open = require('open');
+
+async function generateLink() {
+  try {
+    const { stdout, stderr } = await exec('git rev-parse --abbrev-ref HEAD');
+    if (stderr) {
+      throw stderr;
+    }
+
+    const branchName = stdout.trim();
+    const remoteOriginUrl = await gitRemoteOriginUrl();
+    const newPullRequestUrl = `https://${remoteOriginUrl.replace("git@", "").replace(":", "/").replace(/\.git$/, "")}/pull/new/${branchName}`;
+
+    await open(newPullRequestUrl);
+  } catch (error) {
+    throw error;
+  }
+}
+
+generateLink();

package-lock.json

@@ -1,12 +1,23 @@
 {
-  "name": "open-pr",
+  "name": "@dannyfeliz/open-pr",
   "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
+  "description": "Allow to open the URL to create a pull request pointing to the base branch",
+  "keywords": [
+    "github",
+    "git",
+    "create pull request",
+    "create pr",
+    "open pr",
+    "pr",
+    "pull request"
+  ],
   "author": "Danny Feliz <[email protected]>",
-  "license": "ISC"
+  "license": "MIT",
+  "dependencies": {
+    "git-remote-origin-url": "^3.1.0",
+    "open": "^7.4.0"
+  },
+  "bin": {
+    "open-pr": "./script.js"
+  }
 }