@spicemod/creator 0.0.22 → 0.0.23

package/dist/templates/custom-app/ts/react/src/app.tsx

@@ -0,0 +1,23 @@
+import styles from "@/css/app.module.scss";
+import { useState } from "react";
+import "@/app.css";
+
+const App: React.FC = () => {
+  const [count, setCount] = useState(0);
+
+  const onButtonClick = () => {
+    setCount((prevCount) => prevCount + 1);
+  };
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.title}>{"My Custom App!"}</div>
+      <button className={styles.button} onClick={onButtonClick}>
+        {"Count up"}
+      </button>
+      <div className={styles.counter}>{count}</div>
+    </div>
+  );
+};
+
+export default App;

package/dist/templates/custom-app/ts/react/src/components/Onboarding.tsx

@@ -0,0 +1,105 @@
+import { useState } from "react";
+
+interface OnboardingProps {
+  config: {
+    projectName: string;
+    framework: string;
+    language: string;
+    packageManager: string;
+    linter: string;
+  };
+}
+
+const Onboarding: React.FC<OnboardingProps> = ({ config }) => {
+  const [isVisible, setIsVisible] = useState(true);
+  const [isFading, setIsFading] = useState(false);
+
+  const handleDismiss = () => {
+    setIsFading(true);
+    setTimeout(() => setIsVisible(false), 250);
+  };
+
+  if (!isVisible) return null;
+
+  return (
+    <div
+      className={`onboarding-overlay ${isFading ? "fade-out" : ""}`}
+      onClick={handleDismiss}
+    >
+      <div className="onboarding-card" onClick={(e) => e.stopPropagation()}>
+        <button
+          className="close-icon-btn"
+          onClick={handleDismiss}
+          aria-label="Close"
+        >
+          <svg width="12" height="12" viewBox="0 0 12 12" fill="none">
+            <path
+              d="M1 1L11 11M1 11L11 1"
+              stroke="currentColor"
+              strokeWidth="2"
+              strokeLinecap="round"
+            />
+          </svg>
+        </button>
+
+        <div className="status-badge">🚀 {config.projectName} Ready</div>
+
+        <div className="config-grid">
+          <span className="label">Framework</span>
+          <span className="value">{config.framework}</span>
+
+          <span className="label">Language</span>
+          <span className="value">{config.language}</span>
+
+          <span className="label">Manager</span>
+          <span className="value">{config.packageManager}</span>
+
+          <span className="label">Linter</span>
+          <span className="value">{config.linter}</span>
+        </div>
+
+        <div className="footer-tip">
+          Next Step: Edit <code>src/app.tsx</code>
+        </div>
+
+        <div className="onboarding-actions">
+          <button
+            className="get-started-btn"
+            onClick={() => openLink("{{get-started-link}}")}
+          >
+            Get Started
+          </button>
+          <button
+            className="get-started-btn"
+            onClick={() => {
+              Spicetify.Platform.History.push("{{project-url}}");
+              handleDismiss();
+            }}
+          >
+            Go to Custom App
+          </button>
+          <button
+            className="discord-btn"
+            onClick={() => openLink("{{discord-link}}")}
+          >
+            Join Discord
+          </button>
+          <button className="dismiss-btn" onClick={handleDismiss}>
+            Dismiss
+          </button>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default Onboarding;
+
+function openLink(url: string, newTab = true) {
+  if (!url) return;
+  if (newTab) {
+    window.open(url, "_blank", "noopener,noreferrer");
+  } else {
+    window.location.href = url;
+  }
+}

package/dist/templates/custom-app/ts/react/src/extension/index.tsx

@@ -0,0 +1,27 @@
+import "@/extension/app.css";
+import { createRoot } from "react-dom/client";
+// you can use aliases too ! (just add them to tsconfig.json)
+import Onboarding from "@/components/Onboarding";
+
+const config = {
+  projectName: "{{project-name}}",
+  framework: "{{framework}}",
+  language: "{{language}}",
+  packageManager: "{{package-manager}}",
+  linter: "{{linter}}",
+};
+
+function main() {
+  // Create a container for the React application
+  // We append this to document.body to ensure it sits above the Spotify UI
+  const container = document.createElement("div");
+  container.id = "spicetify-onboarding-root";
+  document.body.appendChild(container);
+
+  const root = createRoot(container);
+
+  // Render the Onboarding UI
+  root.render(<Onboarding config={config} />);
+}
+
+main();

package/dist/templates/extension/js/vanilla/src/components/Onboarding.js

@@ -0,0 +1,71 @@
+export function initOnboarding(config) {
+  const overlay = document.createElement("div");
+  overlay.className = "onboarding-overlay";
+
+  overlay.innerHTML = `
+    <div class="onboarding-card">
+      <button class="close-icon-btn" aria-label="Close" id="close-x">
+        <svg width="12" height="12" viewBox="0 0 12 12" fill="none">
+          <path d="M1 1L11 11M1 11L11 1" stroke="currentColor" stroke-width="2" stroke-linecap="round"/>
+        </svg>
+      </button>
+
+      <div>
+        <span class="status-dot"></span>
+        🚀 ${config.projectName} Ready
+      </div>
+
+      <div class="config-grid">
+        <span class="label">Framework</span>
+        <span class="value">${config.framework}</span>
+
+        <span class="label">Language</span>
+        <span class="value">${config.language}</span>
+
+        <span class="label">Manager</span>
+        <span class="value">${config.packageManager}</span>
+
+        <span class="label">Linter</span>
+        <span class="value">${config.linter}</span>
+      </div>
+
+      <div class="footer-tip">
+        Next Step: Edit <code>src/app.tsx</code>
+      </div>
+      <div class="onboarding-actions">
+      <button class="dismiss-btn" id="dismiss-btn">Dismiss</button>
+      <button class="discord-btn" id="discord-btn">Join Discord</button>
+      <button class="get-started-btn" id="get-started-btn">Get Started</button>
+      </div>
+    </div>
+  `;
+
+  const dismiss = () => {
+    overlay.classList.add("fade-out");
+    overlay.addEventListener("transitionend", () => overlay.remove(), {
+      once: true,
+    });
+  };
+
+  overlay.addEventListener("click", (e) => {
+    if (e.target === overlay) dismiss();
+  });
+
+  function openLink(url, newTab = true) {
+    if (!url) return;
+    if (newTab) {
+      window.open(url, "_blank", "noopener,noreferrer");
+    } else {
+      window.location.href = url;
+    }
+  }
+
+  const getStarted = () => openLink("{{get-started-link}}");
+  const openDiscord = () => openLink("{{discord-link}}");
+  overlay.querySelector("#close-x")?.addEventListener("click", dismiss);
+  overlay.querySelector("#dismiss-btn")?.addEventListener("click", dismiss);
+  overlay.querySelector("#discord-btn")?.addEventListener("click", openDiscord);
+  overlay.querySelector("#get-started-btn")?.addEventListener("click", getStarted);
+
+  document.body.prepend(overlay);
+}

package/dist/templates/extension/shared/DOT-gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# build files
+/dist
+
+# production
+/build
+.spicetify/
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

package/dist/templates/extension/shared/DOT-oxlintrc.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": null,
+  "categories": {},
+  "rules": {
+    "no-await-in-loop": "error",
+    "unicorn/prefer-array-find": "error",
+    "unicorn/prefer-array-flat-map": "error",
+    "unicorn/prefer-set-has": "error"
+  },
+  "settings": {
+    "jsx-a11y": {
+      "polymorphicPropName": null,
+      "components": {},
+      "attributes": {}
+    },
+    "react": {
+      "formComponents": [],
+      "linkComponents": [],
+      "version": null,
+      "componentWrapperFunctions": []
+    },
+    "jsdoc": {
+      "ignorePrivate": false,
+      "ignoreInternal": false,
+      "ignoreReplacesDocs": true,
+      "overrideReplacesDocs": true,
+      "augmentsExtendsReplacesDocs": false,
+      "implementsReplacesDocs": false,
+      "exemptDestructuredRootsFromChecks": false,
+      "tagNamePreference": {}
+    }
+  },
+  "globals": {},
+  "ignorePatterns": ["dist/**"]
+}

package/dist/templates/extension/shared/spice.config.js

@@ -1,4 +1,4 @@
-import { defineConfig } from "@spicetify/creator/client";
+import { defineConfig } from "@spicetify/creator";
 
 // Learn more: {{config-reference-link}}
 export default defineConfig({

package/dist/templates/extension/shared/spice.config.ts

@@ -1,4 +1,4 @@
-import { defineConfig } from "@spicetify/creator/client";
+import { defineConfig } from "@spicetify/creator";
 
 // Learn more: {{config-reference-link}}
 export default defineConfig({

package/dist/templates/liveReload.js

@@ -63,7 +63,6 @@
   const script = document.createElement("script");
   script.id = JS_ID;
   script.src = SERVER + JS_PATH;
-  script.type = "module";
   document.body.appendChild(script);
 
   connect();

package/dist/templates/theme/shared/DOT-gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# build files
+/dist
+
+# production
+/build
+.spicetify/
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

package/dist/templates/theme/shared/DOT-oxlintrc.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": null,
+  "categories": {},
+  "rules": {
+    "no-await-in-loop": "error",
+    "unicorn/prefer-array-find": "error",
+    "unicorn/prefer-array-flat-map": "error",
+    "unicorn/prefer-set-has": "error"
+  },
+  "settings": {
+    "jsx-a11y": {
+      "polymorphicPropName": null,
+      "components": {},
+      "attributes": {}
+    },
+    "react": {
+      "formComponents": [],
+      "linkComponents": [],
+      "version": null,
+      "componentWrapperFunctions": []
+    },
+    "jsdoc": {
+      "ignorePrivate": false,
+      "ignoreInternal": false,
+      "ignoreReplacesDocs": true,
+      "overrideReplacesDocs": true,
+      "augmentsExtendsReplacesDocs": false,
+      "implementsReplacesDocs": false,
+      "exemptDestructuredRootsFromChecks": false,
+      "tagNamePreference": {}
+    }
+  },
+  "globals": {},
+  "ignorePatterns": ["dist/**"]
+}

package/dist/templates/theme/shared/spice.config.js

@@ -1,4 +1,4 @@
-import { defineConfig } from "@spicetify/creator/client";
+import { defineConfig } from "@spicetify/creator";
 
 // Learn more: {{config-reference-link}}
 export default defineConfig({

package/dist/templates/theme/shared/spice.config.ts

@@ -1,4 +1,4 @@
-import { defineConfig } from "@spicetify/creator/client";
+import { defineConfig } from "@spicetify/creator";
 
 // Learn more: {{config-reference-link}}
 export default defineConfig({

package/dist/templates/wrapper.js

@@ -1,14 +1,12 @@
 __ESBUILD__HAS_CSS &&
   (async () => {
     try {
-      const css = `{{INJECTED_CSS_HERE}}`;
-      if (css && css.trim().length !== 0) {
-        const style = document.createElement("style");
-        style.setAttribute("data-app", __ESBUILD__APP_ID);
-        style.textContent = css;
-        document.head.appendChild(style);
-      }
-    } catch {}
+      const css = __ESBUILD__INJECTED_CSS;
+      const style = document.createElement("style");
+      style.setAttribute("data-app", __ESBUILD__APP_ID);
+      style.textContent = css;
+      document.head.appendChild(style);
+    } catch { }
   })();
 (async () => {
   const _ID = `${__ESBUILD__APP_SLUG}-${__ESBUILD__APP_TYPE}`;
@@ -16,7 +14,6 @@ __ESBUILD__HAS_CSS &&
   window.SpiceGlobals[_ID] = {
     id: __ESBUILD__APP_ID,
     version: __ESBUILD__APP_VERSION,
-    hash: __ESBUILD__APP_HASH,
   };
   const { id: appId, version: v } = window.SpiceGlobals[_ID];
   const _wait = (p, a = 0) =>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spicemod/creator",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "Easily make Spicetify extensions and themes",
   "keywords": [
     "cli",
@@ -21,12 +21,16 @@
   },
   "files": [
     "dist",
-    "templates"
+    "templates",
+    "client.d.ts"
   ],
   "type": "module",
   "exports": {
+    ".": "./dist/index.mjs",
+    "./client": {
+      "types": "./client.d.ts"
+    },
     "./bin": "./dist/bin.mjs",
-    "./client": "./dist/client/index.mjs",
     "./package.json": "./package.json"
   },
   "scripts": {

package/templates/custom-app/js/react/eslint.config.ts

@@ -0,0 +1,29 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import react from "eslint-plugin-react";
+import css from "@eslint/css";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
+    plugins: { js, react },
+    extends: ["js/recommended"],
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      globals: globals.browser,
+    },
+  },
+  tseslint.configs.recommended,
+  {
+    files: ["**/*.css"],
+    plugins: { css },
+    language: "css/css",
+    extends: ["css/recommended"],
+  },
+]);

package/templates/custom-app/js/react/src/app.jsx

@@ -0,0 +1,22 @@
+import styles from "@/css/app.module.scss";
+import { useState } from "react";
+
+const App = () => {
+  const [count, setCount] = useState(0);
+
+  const onButtonClick = () => {
+    setCount((prevCount) => prevCount + 1);
+  };
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.title}>{"My Custom App!"}</div>
+      <button className={styles.button} onClick={onButtonClick}>
+        {"Count up"}
+      </button>
+      <div className={styles.counter}>{count}</div>
+    </div>
+  );
+};
+
+export default App;

package/templates/custom-app/js/react/src/components/Onboarding.jsx

@@ -0,0 +1,82 @@
+import { useState } from "react";
+
+const Onboarding = ({ config }) => {
+  const [isVisible, setIsVisible] = useState(true);
+  const [isFading, setIsFading] = useState(false);
+
+  const handleDismiss = () => {
+    setIsFading(true);
+    setTimeout(() => setIsVisible(false), 250);
+  };
+
+  if (!isVisible) return null;
+
+  return (
+    <div className={`onboarding-overlay ${isFading ? "fade-out" : ""}`} onClick={handleDismiss}>
+      <div className="onboarding-card" onClick={(e) => e.stopPropagation()}>
+        <button className="close-icon-btn" onClick={handleDismiss} aria-label="Close">
+          <svg width="12" height="12" viewBox="0 0 12 12" fill="none">
+            <path
+              d="M1 1L11 11M1 11L11 1"
+              stroke="currentColor"
+              strokeWidth="2"
+              strokeLinecap="round"
+            />
+          </svg>
+        </button>
+
+        <div className="status-badge">🚀 {config.projectName} Ready</div>
+
+        <div className="config-grid">
+          <span className="label">Framework</span>
+          <span className="value">{config.framework}</span>
+
+          <span className="label">Language</span>
+          <span className="value">{config.language}</span>
+
+          <span className="label">Manager</span>
+          <span className="value">{config.packageManager}</span>
+
+          <span className="label">Linter</span>
+          <span className="value">{config.linter}</span>
+        </div>
+
+        <div className="footer-tip">
+          Next Step: Edit <code>src/app.tsx</code>
+        </div>
+
+        <div className="onboarding-actions">
+          <button className="get-started-btn" onClick={() => openLink("{{get-started-link}}")}>
+            Get Started
+          </button>
+          <button
+            className="get-started-btn"
+            onClick={() => {
+              Spicetify.Platform.History.push("{{project-url}}");
+              handleDismiss();
+            }}
+          >
+            Go to Custom App
+          </button>
+          <button className="discord-btn" onClick={() => openLink("{{discord-link}}")}>
+            Join Discord
+          </button>
+          <button className="dismiss-btn" onClick={handleDismiss}>
+            Dismiss
+          </button>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default Onboarding;
+
+function openLink(url, newTab = true) {
+  if (!url) return;
+  if (newTab) {
+    window.open(url, "_blank", "noopener,noreferrer");
+  } else {
+    window.location.href = url;
+  }
+}

package/templates/custom-app/js/react/src/extension/index.jsx

@@ -0,0 +1,23 @@
+import styles from "@/css/app.module.scss";
+import { useState } from "react";
+import "@/app.css";
+
+const App = () => {
+  const [count, setCount] = useState(0);
+
+  const onButtonClick = () => {
+    setCount((prevCount) => prevCount + 1);
+  };
+
+  return (
+    <div className={styles.container}>
+      <div className={styles.title}>{"My Custom App!"}</div>
+      <button className={styles.button} onClick={onButtonClick}>
+        {"Count up"}
+      </button>
+      <div className={styles.counter}>{count}</div>
+    </div>
+  );
+};
+
+export default App;

package/templates/custom-app/meta.json

@@ -0,0 +1,4 @@
+{
+  "title": "Custom App",
+  "description": "scaffolding for your spicetify custom app"
+}

package/templates/custom-app/shared/DOT-gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# build files
+/dist
+
+# production
+/build
+.spicetify/
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo