Add playground to sparrowql (#41)

* add playground to sparrowql

* fix ci

* add support to aliases

* delete unused example

* Fixed comments from reviews

* Renamed salon to restaurant in example2

---------

Co-authored-by: Volodymyr Zakhovaiko <[email protected]>

.eslintignore

@@ -1,3 +1,4 @@
 coverage
 node_modules
 lib
+/playground

.github/workflows/CI.yml

@@ -29,6 +29,8 @@ jobs:
           mongodb-version: ${{ matrix.mongodb-version }}
       - name: Install dependencies
         run: npm i -g npm@8 --no-audit && npm ci --no-audit
+      - name: Install dependencies in playground
+        run: cd playground && npm ci --no-audit
       - name: Lint
         run: npm run lint
       - name: Test
@@ -37,4 +39,14 @@ jobs:
         uses: codecov/[email protected]
         with:
           fail_ci_if_error: true
-
+      - name: Build docs
+        run: cd playground && npm run build
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.node-version == '20.x'
+      - name: Deploy docs
+        uses: peaceiris/[email protected]
+        with:
+          allow_empty_commit: true
+          force_orphan: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./playground/dist
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.node-version == '20.x'

package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "coverage": "jest --coverage",
-    "lint": "npm run lint:code && npm run lint:types",
+    "lint": "npm run lint:code && npm run lint:types && cd playground && npm run lint",
     "lint:code": "eslint --cache --cache-location node_modules/.cache/eslint --cache-strategy content --ext js,ts .",
     "lint:types": "tsc --build tsconfig.global.json",
     "build": "tsc --build tsconfig.build.json",

playground/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

playground/.eslintignore

@@ -0,0 +1,5 @@
+/.idea
+/coverage
+
+/node_modules
+/dist

playground/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es2020": true
+  },
+  "extends": [
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "warnOnUnsupportedTypeScriptVersion": false
+  },
+  "plugins": [
+    "react-refresh"
+  ],
+  "rules": {
+    "react-refresh/only-export-components": [
+      "warn",
+      {
+        "allowConstantExport": true
+      }
+    ]
+  }
+}

playground/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

playground/.prettierrc.cjs

@@ -0,0 +1,3 @@
+const settings = require('eslint-config-vazco/default.json');
+
+module.exports = settings.rules['prettier/prettier'][1];