sprout-ai · soiluong · Apr 30, 2024 · May 1, 2024
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+client/dist
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+node_modules
+lib
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,3 @@
+{
+  "semi": false
+}
diff --git a/README.md b/README.md
@@ -1 +1,54 @@
-# simple-script-loading
+<img height="80" width="304" alt="Sprout.ai Engineering logo" src="https://github.com/sprout-ai/simple-script-loading/assets/10632532/cb7ff795-30cd-4a14-840d-7fb3c7591594" />
+
+# Simple Script Loading
+
+A simple code and script loading.
+
+## Installation
+
+```bash
+npm install @sproutai/simple-script-loading
+```
+
+## Usage
+
+### Loading an external script
+
+By default, supplying a URL to `src` will add <script> tag to the document's head.
+
+```js
+import simpleScriptLoading from "@sproutai/simple-script-loading"
+
+simpleScriptLoading({
+  id: "script-id",
+  src: "https://example.com/script.js"
+}).then((node) => {
+    // returns the script node
+    console.log(node)
+    console.log("script loaded")
+}).catch((error) => {
+    console.error(error)
+})
+```
+
+### Inserting a script tag with JavaScript code
+
+```js
+import simpleScriptLoading from "@sproutai/simple-script-loading"
+
+simpleScriptLoading({
+  id: "script-id",
+  code: "console.log('Hello, World!')"
+})
+```
+
+### Options
+
+```js
+const options = {
+  attrs: {}, // object, attributes to add to the script tag
+  code: undefined, // string, JavaScript code to insert
+  src: '', // string, URL of the script to load
+  body: false, // boolean, insert the script tag in the body
+}
+```
diff --git a/client/app.ts b/client/app.ts
@@ -0,0 +1,11 @@
+import simpleScriptLoading from "../src"
+
+declare global {
+  interface Window {
+    simpleScriptLoading: typeof simpleScriptLoading
+  }
+}
+
+window.simpleScriptLoading = simpleScriptLoading
+
+export {}
diff --git a/client/index.html b/client/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Simple Script Loading</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="app.ts"></script>
+  </body>
+</html>
diff --git a/client/test.js b/client/test.js
@@ -0,0 +1,5 @@
+function foo() {
+  return "bar"
+}
+
+window.foo = foo