@sdkgen/playground 1.6.1 → 2.0.1

package/.ci.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -ex
+
+for folder in browser-runtime csharp-generator fsharp-generator dart-generator kotlin-generator parser swift-generator typescript-generator; do
+  cd ..
+  cd "$folder"
+  npm i
+  npm run build
+  json -I -f package.json -e '
+    this.main = "dist/src/index.js";
+    this.types = "dist/src/index.d.ts";
+  '
+done

package/README.md

@@ -1,2 +1,39 @@
-# @sdkgen/playground
+# Sdkgen Playground
 
+## Getting Started
+
+To run a development server, run the command `npm start`. The app will be available on [`http://localhost:4200/`](http://localhost:4200/) and will automatically reload when changes are made.
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Components
+
+The sdkgen Playground is split in a few components:
+
+- `app.component` is where the base interface lives. It is the entry point of the application and holds the top bar (`tab-nav.component`) and the main content (varies per tab).
+- `console.component` is the component that holds the console, used to show logs and XHR requests from editors.
+- `tab-nav.component` is the top bar. It is responsible for switching between sdkgen APIs.
+- `simple-call.component` is the component that holds the editor for what we call "simple calls", the calls where users don't write code, just the arguments and click the Run button.
+- `tab-editor.component` is the advanced editor component. Here, the user can write code containing function calls to a sdkgen API and run it.
+- `type-details.component` is the component that holds the details of a type. It receives a type through Material Dialog's DATA interface and shows information about it (e.g. its properties).
+- `tab-home.component` is the home tab. It is the default tab and shows the list of sdkgen functions and their documentation.
+
+## Other files
+
+- `filter.pipe` is the pipe that filters the list of sdkgen functions.
+- `responsive.service` is the service that observes the screen width and lets the app know if it is in mobile or desktop mode.
+- `sdkgen.docs` holds the documentation for sdkgen's primitive types.
+- `sdkgen.service` contains code generation methods.
+- `utils/code-execution.ts` is the runtime code needed by advanced editor component to integrate the code being ran with our interface.
+
+## Code style and further help
+
+This code respects [Cubos' ESLint rules](https://git.cubos.io/cubos/eslint). You can find the overriden rules in the `.eslintrc.json` file.
+
+For further help, check out:
+
+- [Angular Documentation](https://angular.io/docs)
+- [Angular Material Documentation](https://material.angular.io/components/categories)
+- [sdkgen Documentation](https://sdkgen.github.io/)

package/angular.json

@@ -0,0 +1,133 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "npm"
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "sdkgen-playground": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "inlineTemplate": false,
+          "inlineStyle": false,
+          "style": "scss",
+          "skipTests": true
+        },
+        "@schematics/angular:class": {
+          "skipTests": true
+        },
+        "@schematics/angular:directive": {
+          "skipTests": true
+        },
+        "@schematics/angular:guard": {
+          "skipTests": true
+        },
+        "@schematics/angular:interceptor": {
+          "skipTests": true
+        },
+        "@schematics/angular:pipe": {
+          "skipTests": true
+        },
+        "@schematics/angular:service": {
+          "skipTests": true
+        },
+        "@schematics/angular:application": {
+          "strict": true
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "aot": true,
+            "allowedCommonJsDependencies": [
+              "@sdkgen/browser-runtime",
+              "@sdkgen/csharp-generator",
+              "@sdkgen/dart-generator",
+              "@sdkgen/kotlin-generator",
+              "@sdkgen/parser",
+              "@sdkgen/swift-generator",
+              "@sdkgen/typescript-generator"
+            ],
+            "outputPath": "dist",
+            "index": "src/index.html",
+            "main": "src/main.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              { "glob": "**/*", "input": "node_modules/monaco-editor/min/vs", "output": "assets/vs" },
+              "src/favicon.ico",
+              "src/assets"
+            ],
+            "styles": [
+              "src/styles.scss"
+            ],
+            "stylePreprocessorOptions": {
+              "includePaths": [
+                "src/"
+              ]
+            },
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1.5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "buildOptimizer": false,
+              "optimization": false,
+              "vendorChunk": true,
+              "extractLicenses": false,
+              "sourceMap": true,
+              "namedChunks": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "browserTarget": "sdkgen-playground:build:production"
+            },
+            "development": {
+              "browserTarget": "sdkgen-playground:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "sdkgen-playground:build"
+          }
+        }
+      }
+    }
+  },
+  "defaultProject": "sdkgen-playground"
+}