@ohos-ports/vite-plugin-relay 2.1.0-beta.0

package/LICENSE

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

@@ -0,0 +1,101 @@
+<h1 align="center">Vite Plugin Relay</h1>
+
+<div align="center">
+  
+  [![NPM](https://img.shields.io/npm/v/vite-plugin-relay)](https://www.npmjs.com/package/vite-plugin-relay)
+  [![CI workflow](https://github.com/oscartbeaumont/vite-plugin-relay/actions/workflows/ci.yml/badge.svg)](https://github.com/oscartbeaumont/vite-plugin-relay/actions)
+
+</div>
+
+<div align="center">
+    Add relay support to your <a href="https://vitejs.dev">Vite</a> projects.
+</div>
+
+<br />
+
+❤️ Special thanks to:
+
+- [@Brendonovich](https://github.com/Brendonovich) for general help
+- [@kesne](https://github.com/kesne) for adding [pnpm](https://pnpm.io) support
+- [@tobias-tengler](https://github.com/tobias-tengler) for adding Vite 3 support
+
+I **do not** actively use this project anymore, however, it will still receive periodic updates.
+
+## Usage
+
+Follow Relay's guide on [how to add Relay to your project](https://relay.dev/docs/getting-started/installation-and-setup/).
+
+> ⚠️ Note: Install `babel-plugin-relay` (>= 13.0.1) as devDependencies as instructed, but skip its configuration. `vite-plugin-relay` will invoke the babel plugin for you!
+
+Add `vite-plugin-relay` to your `devDependencies`:
+
+```bash
+yarn add vite-plugin-relay -D
+```
+
+Add `vite-plugin-relay` to your Vite configuration (`vite.config.ts` or `vite.config.js`):
+
+```typescript
+import { defineConfig } from "vite";
+import relay from "vite-plugin-relay";
+
+export default defineConfig({
+  plugins: [..., relay],
+});
+```
+
+Configure `relay-compiler` to output artifacts with `export default` syntax, by setting `eagerEsModules` to `true`:
+
+```json
+{
+  "relay": {
+    "src": "./src",
+    "schema": "./src/schema.graphql",
+    "language": "typescript",
+    "eagerEsModules": true,
+    "exclude": ["**/node_modules/**", "**/__mocks__/**", "**/__generated__/**"]
+  }
+}
+```
+
+Now your project is setup to use Relay with Vite!
+
+## How this plugin works
+
+Under the hood we are invoking the official `babel-plugin-relay`. This ensures that our plugin and `babel-plugin-relay` do not get out of sync over time and also reduces the maintainance costs of this project.
+
+Since v13 `babel-plugin-relay` automatically gets its configuration from either the `package.json`, `relay.config.js` or `relay.config.json`, so our plugin also doesn't have to expose a configuration API.
+
+## Common Issues
+
+### `Uncaught ReferenceError: global is not defined`
+
+If you experience this error in your browser console when using the plugin add the following define to your `index.html` file before importing your Javascript:
+
+```html
+<script>
+  let global = globalThis;
+</script>
+```
+
+## Server Side Rendering
+
+If you are planning to use this plugin with server side rendering you may need to define `window`. You could do this by putting the following snippet in your [`entry-server.js`](https://vitejs.dev/guide/ssr.html#source-structure) file.
+
+```js
+if (typeof (window as any).global === 'undefined') {
+  (window as any).global = globalThis;
+}
+```
+
+## Contributing
+
+```
+git clone ...
+pnpm i
+# If you have never run Playwright run `npx playwright install` to setup your system.
+cd examples/vite-3
+pnpm dev
+
+pnpm format # Do this before doing a commit
+```

package/dist/plugin.cjs

@@ -0,0 +1,82 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = function(target, all) {
+    for(var name in all)__defProp(target, name, {
+        get: all[name],
+        enumerable: true
+    });
+};
+var __copyProps = function(to, from, except, desc) {
+    if (from && typeof from === "object" || typeof from === "function") {
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            var _loop = function() {
+                var key = _step.value;
+                if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+                    get: function() {
+                        return from[key];
+                    },
+                    enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+                });
+            };
+            for(var _iterator = __getOwnPropNames(from)[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true)_loop();
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+    }
+    return to;
+};
+var __toCommonJS = function(mod) {
+    return __copyProps(__defProp({}, "__esModule", {
+        value: true
+    }), mod);
+};
+// src/plugin.ts
+var plugin_exports = {};
+__export(plugin_exports, {
+    default: function() {
+        return plugin_default;
+    }
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_core = require("@babel/core");
+var plugin_default = {
+    name: "vite:relay",
+    transform: function transform(src, id) {
+        if (/.(t|j)sx?/.test(id) && src.includes("graphql`")) {
+            var out = (0, import_core.transformSync)(src, {
+                plugins: [
+                    [
+                        "babel-plugin-relay"
+                    ]
+                ],
+                code: true,
+                filename: id,
+                sourceMaps: true
+            });
+            if (!(out === null || out === void 0 ? void 0 : out.code)) {
+                throw new Error("vite-plugin-relay: Failed to transform ".concat(id));
+            }
+            var code = out.code;
+            var map = out.map;
+            return {
+                code: code,
+                map: map
+            };
+        }
+    }
+};

package/dist/plugin.d.cts

@@ -0,0 +1,5 @@
+import { PluginOption } from '@ohos-ports/vite';
+
+declare const _default: PluginOption;
+
+export { _default as default };

package/dist/plugin.d.ts

@@ -0,0 +1,5 @@
+import { PluginOption } from '@ohos-ports/vite';
+
+declare const _default: PluginOption;
+
+export { _default as default };

package/dist/plugin.js

@@ -0,0 +1,27 @@
+// src/plugin.ts
+import { transformSync } from "@babel/core";
+var plugin_default = {
+  name: "vite:relay",
+  transform(src, id) {
+    if (/.(t|j)sx?/.test(id) && src.includes("graphql`")) {
+      const out = transformSync(src, {
+        plugins: [["babel-plugin-relay"]],
+        code: true,
+        filename: id,
+        sourceMaps: true
+      });
+      if (!out?.code) {
+        throw new Error(`vite-plugin-relay: Failed to transform ${id}`);
+      }
+      const code = out.code;
+      const map = out.map;
+      return {
+        code,
+        map
+      };
+    }
+  }
+};
+export {
+  plugin_default as default
+};

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@ohos-ports/vite-plugin-relay",
+  "version": "2.1.0-beta.0",
+  "description": "A vite plugin for relay",
+  "author": {
+    "name": "Oscar Beaumont",
+    "email": "oscar@otbeaumont.me"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/vite-plugin-relay/2.1.0"
+  },
+  "keywords": [
+    "graphql",
+    "relay",
+    "typescript",
+    "graphql-relay",
+    "vite",
+    "vite-plugin",
+    "vite-plugin-relay"
+  ],
+  "type": "module",
+  "main": "dist/plugin.cjs",
+  "module": "dist/plugin.js",
+  "types": "dist/plugin.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/plugin.cjs",
+      "import": "./dist/plugin.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/plugin.ts --dts --clean --format cjs,esm --no-splitting --env.NODE_ENV production",
+    "dev": "tsup src/plugin.ts --dts --clean --format cjs,esm --no-splitting --watch",
+    "test": "pnpm -r --parallel --filter=!vite-plugin-relay exec pnpm test",
+    "lint": "prettier --check . && eslint src/** examples/latest/src/**",
+    "format": "prettier --write . && eslint src/** examples/latest/src/** --fix"
+  },
+  "peerDependencies": {
+    "babel-plugin-relay": ">=14.1.0",
+    "@ohos-ports/vite": "^8.3.0-beta.0"
+  },
+  "dependencies": {
+    "@babel/core": "^7.23.5"
+  },
+  "devDependencies": {
+    "@ohos-ports/swc-core": "^1.16.2-beta.0",
+    "@types/babel__core": "^7.20.5",
+    "@types/node": "^20.10.4",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "husky": "^8.0.3",
+    "prettier": "^3.1.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "@ohos-ports/vite": "^8.3.0-beta.0"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  }
+}