feat: Initial commit

Author: GodderE2D

.env.example

@@ -0,0 +1,2 @@
+# PostgreSQL database URL for development
+QUICKPOSTGRES_DEV_POSTGRES_URL=postgresql://postgres:<password>@localhost:5432/postgres

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2017,
+    sourceType: "module",
+  },
+  plugins: ["@typescript-eslint", "prefer-arrow"],
+  rules: {
+    "no-var": "error",
+    "sort-imports": "error",
+    "prefer-arrow-callback": "error",
+    "no-warning-comments": "warn",
+    "prefer-arrow/prefer-arrow-functions": "error",
+    "@typescript-eslint/no-explicit-any": "off",
+  },
+};

.github/workflows/publish-dev.yml

@@ -0,0 +1,37 @@
+name: NPM Publish (Dev)
+on:
+  push:
+    branches:
+      - main
+jobs:
+  npm-publish-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Node 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run final tests
+        # npm run test is excluded here intentionally
+        run: npm run eslint && npm run prettier
+
+      - name: Deprecate old versions
+        run: npm deprecate quickpostgres@"~$(jq --raw-output '.version' package.json)" "no longer supported" || true
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish
+        run: |
+          npm version --git-tag-version=false $(jq --raw-output '.version' package.json).$(date +%s).$(git rev-parse --short HEAD)
+          npm publish --tag dev || true
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: NPM Publish (Release)
+on:
+  release:
+    types: [pubished]
+jobs:
+  npm-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Install Node 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
+      - run: git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+      - run: git config --global user.name "github-actions"
+
+      - name: Run final tests
+        # npm run test is excluded here intentionally
+        run: npm run eslint && npm run prettier
+
+      - name: Version package
+        run: npm version ${{ github.event.release.tag_name }}
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push version changes to GitHub
+        run: 'git push -m "chore(Release): bump version to ${{ github.event.release.tag_name }} for release"'
+        env:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  lint:
+    name: ESLint & Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Node 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Run Prettier
+        run: npm run prettier
+
+      - name: Run Tests
+        run: npm run test
+        env:
+          QUICKPOSTGRES_DEV_POSTGRES_URL: ${{ secrets.QUICKPOSTGRES_DEV_POSTGRES_URL }}

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+*.log
+*.logs
+dist
+.env

.prettierignore

@@ -0,0 +1 @@
+node_modules

.prettierrc

@@ -0,0 +1 @@
+{}

README.md

@@ -1,2 +1,83 @@
-# quickpostgres
- An easy, beginner-friendly PostgreSQL database wrapper similar to quick.db.
+# [Quickpostgres](https://npmjs.com/package/quickpostgres)
+
+An easy, beginner-friendly [PostgreSQL](https://www.postgresql.org/) database wrapper similar to [quick.db](https://github.com/lorencerri/quick.db).
+
+## Installation
+
+<!-- You can easily install quickpostgres using your preferred package manager.
+
+```bash
+npm install quickpostgres
+# or
+yarn add quickpostgres
+# or
+pnpm add quickpostgres
+``` -->
+
+Not yet published.
+
+## Requirements
+
+- Node.js 14 or above
+- A PostgreSQL database
+
+## Usage
+
+Quickpostgres has similar (if not almost identical) syntax to [quick.db](https://github.com/lorencerri/quick.db). You can refer to their [documentation](https://quickdb.js.org/) if you are getting stuck.
+
+> Note: Quickpostgres is built on top of promises, meaning you need to resolve them first using `.then()` or `await` to get their returned data.
+
+```js
+// Import quickpostgres
+const { Client } = require("quickpostgres");
+
+// Create a new client using the default values on localhost
+const dbUrl = "postgresql://postgres:<password>@localhost:5432/postgres";
+const db = new Client(dbUrl);
+
+(async () => {
+  // Connect to your client
+  await db.connect();
+
+  // Setting an object in the database:
+  await db.set("userInfo", { difficulty: "Easy" });
+  // => { difficulty: "Easy" }
+
+  // Pushing an element to an array (that doesn't exist yet) in an object:
+  await db.push("userInfo.items", "Sword");
+  // => { difficulty: "Easy", items: ["Sword"] }
+
+  // Adding to a number (that doesn"t exist yet) in an object:
+  await db.add("userInfo.balance", 500);
+  // => { difficulty: "Easy", items: ["Sword"], balance: 500 }
+
+  // Repeating previous examples:
+  await db.push("userInfo.items", "Watch");
+  // => { difficulty: "Easy", items: ["Sword", "Watch"], balance: 500 }
+  await db.add("userInfo.balance", 500);
+  // => { difficulty: "Easy", items: ["Sword", "Watch"], balance: 1000 }
+
+  // Fetching individual properties
+  await db.get("userInfo.balance"); // => 1000
+  await db.get("userInfo.items"); // ["Sword", "Watch"]
+
+  // End the database connection
+  await db.end();
+})();
+```
+
+## Support
+
+For now, please use [GitHub discussions](https://github.com/GodderE2D/quickpostgres/discussions) if you need any support.
+
+I may consider opening a Discord support server soon, but this is not guranteed.
+
+## Contributing
+
+If you spot a bug or you have a feature request, please open a [GitHub issue](https://github.com/GodderE2D/quickpostgres/issues), or if you'd like to write some code, you can open a [pull request](https://github.com/GodderE2D/quickpostgres/pulls).
+
+If you spot a security vulnerability, please [contact me](mailto:[email protected]).
+
+## License
+
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)