simple-github-gist-api 2.0.5 → 2.0.9

package/LICENSE

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

package/README.md

@@ -1,65 +1,20 @@
 # Simple Github Gist API
 
-<p>
-<img alt="npm" src="https://img.shields.io/npm/dt/simple-github-gist-api">
-<a href="https://www.npmjs.com/package/simple-github-gist-api">
-  <img alt="npm" src="https://img.shields.io/npm/v/simple-github-gist-api">
-</a>
-</p>
-
-> This documentation is for v2 of the lib. v2 has a few breaking changes.
-> 
-> You can find the v1 documentation in the `docs` directory (On Github).
+[![npm (scoped)](https://img.shields.io/npm/v/simple-github-gist-api)](https://www.npmjs.com/package/simple-github-gist-api)
+[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/simple-github-gist-api)](https://img.shields.io/bundlephobia/minzip/simple-github-gist-api)
+[![npm](https://img.shields.io/npm/dt/simple-github-gist-api)](https://img.shields.io/npm/dt/simple-github-gist-api)
+[![GitHub](https://img.shields.io/github/license/vighnesh153/simple-github-gist-api)](https://github.com/vighnesh153/simple-github-gist-api/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/vighnesh153/simple-github-gist-api)](https://github.com/vighnesh153/simple-github-gist-api/issues)
 
 Use this promise based API to 
 store data on your github gists without the 
 need to make those tedious HTTP requests.
 
-> Note: Github Gist's API work on commit-id basis. If you save anything, 
-> it is a new commit and the commit-id changes. So, when you save, 
-> don't do that simultaneously. 
-> 
-> For instance, assume you are using this in your API. 
-> And you have an endpoint `/create-file`.
-> 
-> Think multiple people making request at the same time:
-```
-/create-file?name=1.json
-/create-file?name=2.json
-/create-file?name=3.json
-...
-```
-
-> If this happens at the same time, then we cannot guarantee that the 
-> all the files will be saved. Maybe when creating both 2.json and 3.json,
-> we are making use of the same commit-id. Both will work but 1 will over-write 
-> the other commit.
-> 
-> But if you do:
-
-```ts
-const file1 = gist.createFile('1.json', "{}")
-const file2 = gist.createFile('2.json', "{}")
-const file3 = gist.createFile('3.json', "{}")
-
-await file1.save();
-await file2.save();
-await file3.save();
-```
-> 
-> this will work as the latest commit-id will be fetched when 
-> saving the next file.  
-> 
-> Or
-```ts
-gist.save();
-```
-> this will work as well because all the changes will go in a single commit.
-
+> Note: This documentation is for v2 of the lib. v2 has a few breaking changes. You can find the v1 documentation in the `docs` directory (On Github).
 
 ## Installation
 
-```
+```sh
 npm i -S simple-github-gist-api
 ```
 
@@ -174,6 +129,42 @@ await gist.save();
 ```
 > Only files that have un-saved changes will be saved.
 
+### Gotchas
+
+Github Gist's API work on commit-id basis. If you save anything, 
+it is a new commit and the commit-id changes. So, when you save, 
+don't do that simultaneously. 
+
+For instance, assume you have an endpoint `/create-file`. And if multiple people making request at the same time:
+```
+/create-file?name=1.json
+/create-file?name=2.json
+/create-file?name=3.json
+...
+```
+
+then we cannot guarantee that the 
+all the files will be saved. When creating `2.json` and `3.json`, there is a possibility 
+that we make use of the same commit-id at HEAD. Both will work but 1 will over-write 
+the other commit.
+ 
+But if you do the following, it will work as the latest commit-id will be fetched when 
+saving each file.
+```ts
+const file1 = gist.createFile('1.json', "{}")
+const file2 = gist.createFile('2.json', "{}")
+const file3 = gist.createFile('3.json', "{}")
+
+await file1.save();
+await file2.save();
+await file3.save();
+```
+
+Or even this will work as well because all the changes will be pushed in a single commit.
+```ts
+gist.save();
+```
+
 ### Sample
 ```ts
 import GithubGist from "./src";

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "simple-github-gist-api",
-  "version": "2.0.5",
+  "version": "2.0.9",
   "description": "A way to store data on Github Gist.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest --config jestconfig.json",
-    "build": "rm -rf dist/ && tsc",
-    "prepublish": "npm run build",
-    "postpublish": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags"
+    "prepare": "husky install",
+    "cleanup": "rimraf dist",
+    "build:pre-requisite": "npm run test",
+    "build:declaration": "tsc",
+    "build": "npm run cleanup && npm run build:pre-requisite && npm-run-all build:*",
+    "test:watch": "jest --watch",
+    "prettier:fix": "prettier -w ./src/**/*.ts -w ./src/**/*.tsx --no-error-on-unmatched-pattern true",
+    "lint:fix": "eslint --fix ./src/**/*.ts --fix ./src/**/*.tsx --no-error-on-unmatched-pattern true",
+    "git:rebase": "git fetch && git rebase origin/master",
+    "release": "npm run git:rebase && npm run build && standard-version && git push --follow-tags && npm publish --access=public",
+    "lint": "eslint src/*"
   },
   "files": [
     "dist/**/*"
@@ -32,12 +40,31 @@
   },
   "homepage": "https://github.com/vighnesh153/simple-github-gist-api#readme",
   "devDependencies": {
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
     "@types/jest": "^27.0.2",
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-config-node": "^4.1.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "husky": "^7.0.4",
     "jest": "^27.3.0",
+    "lint-staged": "^12.1.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^18.0.1",
+    "standard-version": "^9.3.2",
     "ts-jest": "^27.0.7",
     "typescript": "^4.4.4"
   },
   "dependencies": {
-    "axios": "^0.23.0"
+    "axios": "^0.24.0"
   }
 }