chore: rename to react-gtk

ncpa0cpl · ncpa0cpl · commit a8da0d287d21 · 2024-12-12T15:09:54.000+01:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,7 +10,7 @@
       "url": "./node_modules/git-hook-tasks/dist/config/json-schema.json"
     },
     {
-      "fileMatch": ["react-gnome.config.json"],
+      "fileMatch": ["react-gtk.config.json"],
       "url": "./dist/config-schema.json"
     },
     {
@@ -38,4 +38,4 @@
   "[json]": {
     "editor.defaultFormatter": "dprint.dprint"
   }
-}
+}
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# react-gnome
+# react-gtk
 
 ## Getting Started
 
 1. Install the required dependencies
 ```bash
-yarn add @reactgjs/react-gnome @reactgjs/renderer
+yarn add @reactgjs/react-gtk @reactgjs/renderer
 ```
 
 2. Install the optional dependencies
@@ -19,9 +19,9 @@ yarn add -D gjs-esm-types ts-node @swc/core
 3. Initiate the project
 Run the init command:
 ```bash
-yarn react-gnome init
+yarn react-gtk init
 ```
-then open `react-gnome.config.mjs` file, change the app name and optionally adjust the project settings.
+then open `react-gtk.config.mjs` file, change the app name and optionally adjust the project settings.
 
 4. Start coding
 The entry file will be located in `src/start.jsx`.
@@ -30,23 +30,23 @@ The entry file will be located in `src/start.jsx`.
 ## Running in dev mode
 
 ```bash
-yarn react-gnome start -m development -w
+yarn react-gtk start -m development -w
 ```
 This command will start the project in development mode and watch for changes.
 
 
 ## Building the project
 
 ```bash
-yarn react-gnome build
+yarn react-gtk build
 ```
 This command will create a bundle file as well as other files meson needs to build the project. And then package it into a tarball file.
 
 ```bash
-yarn react-gnome bundle
+yarn react-gtk bundle
 ```
 This command will create a standalone bundle file.
 
 ## Documentation
 
-Check out more of the ReactGnome features [here](./docs)
+Check out more of the React GTK features [here](./docs)
diff --git a/bin/react-gnome.cjs b/bin/react-gnome.cjs
diff --git a/bin/react-gnome.js b/bin/react-gnome.js
diff --git a/bin/react-gnome.mjs b/bin/react-gnome.mjs
diff --git a/bin/react-gtk.cjs b/bin/react-gtk.cjs
@@ -0,0 +1,2 @@
+const { start } = require("@reactgjs/react-gtk/cli");
+start();
diff --git a/bin/react-gtk.js b/bin/react-gtk.js
@@ -0,0 +1,2 @@
+const { start } = require("@reactgjs/react-gtk/cli");
+start();
diff --git a/bin/react-gtk.mjs b/bin/react-gtk.mjs
@@ -0,0 +1,2 @@
+import { start } from "@reactgjs/react-gtk/cli";
+start();
diff --git a/bin/react-gtk.sh b/bin/react-gtk.sh
@@ -11,33 +11,33 @@ if which ts-node >/dev/null 2>&1; then
 
     if "$HAS_SWC" == true; then
         if [ "$PKG_JSON_MODULE" = "commonjs" ]; then
-            ts-node --swc "$HERE"/react-gnome.cjs "$@"
+            ts-node --swc "$HERE"/react-gtk.cjs "$@"
         else
             if [ "$PKG_JSON_MODULE" = "module" ]; then
-                ts-node-esm --swc "$HERE"/react-gnome.mjs "$@"
+                ts-node-esm --swc "$HERE"/react-gtk.mjs "$@"
             else
-                ts-node --swc "$HERE"/react-gnome.js "$@"
+                ts-node --swc "$HERE"/react-gtk.js "$@"
             fi
         fi
     else
         if [ "$PKG_JSON_MODULE" = "commonjs" ]; then
-            ts-node -T "$HERE"/react-gnome.cjs "$@"
+            ts-node -T "$HERE"/react-gtk.cjs "$@"
         else
             if [ "$PKG_JSON_MODULE" = "module" ]; then
-                ts-node-esm -T "$HERE"/react-gnome.mjs "$@"
+                ts-node-esm -T "$HERE"/react-gtk.mjs "$@"
             else
-                ts-node -T "$HERE"/react-gnome.js "$@"
+                ts-node -T "$HERE"/react-gtk.js "$@"
             fi
         fi
     fi
 else
     if [ "$PKG_JSON_MODULE" = "commonjs" ]; then
-        node "$HERE"/react-gnome.cjs "$@"
+        node "$HERE"/react-gtk.cjs "$@"
     else
         if [ "$PKG_JSON_MODULE" = "module" ]; then
-            node "$HERE"/react-gnome.mjs "$@"
+            node "$HERE"/react-gtk.mjs "$@"
         else
-            node "$HERE"/react-gnome.js "$@"
+            node "$HERE"/react-gtk.js "$@"
         fi
     fi
 fi
diff --git a/docs/environment-vars.md b/docs/environment-vars.md
@@ -13,7 +13,7 @@ console.log(env.appName); // 'Example App'
 Setting the environment variables in the config:
 
 ```tsx
-import type { BuildConfig } from "@reactgjs/react-gnome";
+import type { BuildConfig } from "@reactgjs/react-gtk";
 
 export default () => {
   const config: BuildConfig = {
diff --git a/docs/polyfills.md b/docs/polyfills.md
@@ -1,6 +1,6 @@
 # Polyfills
 
-React Gnome has a set of polyfills that can be enabled in the config file.
+React GTK has a set of polyfills that can be enabled in the config file.
 
 ## Global Polyfills
 
@@ -28,7 +28,7 @@ None of the Node.js core modules are available in GJS environments, but can be a
 
 
 ```tsx
-import type { BuildConfig } from "@reactgjs/react-gnome";
+import type { BuildConfig } from "@reactgjs/react-gtk";
 
 export default () => {
   const config: BuildConfig = {
@@ -61,11 +61,11 @@ export default () => {
 
 ## Custom Polyfills
 
-If a node module or a global you need is not available among the polyfills provided by React Gnome,
+If a node module or a global you need is not available among the polyfills provided by React GTK,
 you can simply add them through the `customPolyfills` option in the config file.
 
 ```tsx
-import type { BuildConfig } from "@reactgjs/react-gnome";
+import type { BuildConfig } from "@reactgjs/react-gtk";
 
 export default () => {
   const config: BuildConfig = {
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "@reactgjs/react-gnome",
+  "name": "@reactgjs/react-gtk",
   "version": "1.0.0",
   "bin": {
-    "react-gnome": "./bin/react-gnome.sh"
+    "react-gtk": "./bin/react-gtk.sh"
   },
   "main": "./dist/legacy/index.js",
   "types": "./dist/types/index.d.ts",
@@ -41,7 +41,7 @@
   },
   "keywords": [],
   "repository": {
-    "url": "https://github.com/react-gjs/react-gnome"
+    "url": "https://github.com/react-gjs/react-gtk"
   },
   "description": "",
   "license": "MIT",
diff --git a/src/add-config-schema.ts b/src/add-config-schema.ts
@@ -29,7 +29,7 @@ export const findProjectRoot = async () => {
   }
 };
 
-export const CONFIG_FILE_NAME = "react-gnome.config.json";
+export const CONFIG_FILE_NAME = "react-gtk.config.json";
 
 export const addConfigSchema = async () => {
   const cwd = await findProjectRoot();
diff --git a/src/cli.ts b/src/cli.ts
@@ -5,7 +5,7 @@ import { InitProgram } from "./programs/init-program";
 import { StartProgram } from "./programs/start-program";
 
 const program = configure((main) => {
-  main.setName("react-gnome");
+  main.setName("react-gtk");
   main.setDescription("Build GTK apps with React.");
 
   main.command("bundle", (cmd) => {
@@ -49,15 +49,11 @@ const program = configure((main) => {
 
 /**
  * Invokes the CLI program.
- * 
+ *
  * if `command` or `args` are not provided, `process.argv` will be used.
  */
-export async function start(
-  command?: string,
-  args?: Record<string, any>,
-) {
+export async function start(command?: string, args?: Record<string, any>) {
   program.run(command, args);
 }
 
 export { BuildProgram, BundleProgram, InitProgram, StartProgram };
-
diff --git a/src/config/config-schema.ts b/src/config/config-schema.ts
@@ -149,7 +149,7 @@ ConfigSchema.recordOf.treeShake.type.setDescription(
 );
 
 ConfigSchema.recordOf.esbuildPlugins.type.setDescription(
-  "Esbuild plugins.\nPlugins can only be added via a JavaScript config file. If you are using a JSON config file and want to add a plugin, you will need to create a `react-gnome.config.js` file and use that instead.",
+  "Esbuild plugins.\nPlugins can only be added via a JavaScript config file. If you are using a JSON config file and want to add a plugin, you will need to create a `react-gtk.config.js` file and use that instead.",
 );
 
 ConfigSchema.recordOf.giVersions.type.setDescription(
@@ -257,7 +257,7 @@ polyfills.recordOf.node.type.recordOf.os.type.setDescription(
 const { customPolyfills } = ConfigSchema.recordOf;
 
 customPolyfills.type.setDescription(
-  "Custom polyfills that should be included in the generated bundle.\n\nThis is useful for polyfills that are not included in the polyfills provided by react-gnome.",
+  "Custom polyfills that should be included in the generated bundle.\n\nThis is useful for polyfills that are not included in the polyfills provided by react-gtk.",
 );
 
 customPolyfills.type.arrayOf[0].recordOf.filepath.setDescription(
diff --git a/src/config/eval-js-config/eval-js-config.cjs.ts b/src/config/eval-js-config/eval-js-config.cjs.ts
@@ -11,7 +11,7 @@ export const evalJsConfigFile = async (
   const ext = path.extname(config);
   if (ext === ".mjs" || ext === ".mts") {
     throw new Error(
-      `Invalid config file: react-gnome CLI is running in CommonJS mode and can accept only configs in CommonJS module format. To run react-gnome in ESM mode, set the 'type' field in your package.json to 'module'.`,
+      `Invalid config file: react-gtk CLI is running in CommonJS mode and can accept only configs in CommonJS module format. To run react-gtk in ESM mode, set the 'type' field in your package.json to 'module'.`,
     );
   }
 
diff --git a/src/config/eval-js-config/eval-js-config.esm.ts b/src/config/eval-js-config/eval-js-config.esm.ts
@@ -6,7 +6,7 @@ export const evalJsConfigFile = async (
   const ext = path.extname(config);
   if (ext === ".cjs" || ext === ".cts") {
     throw new Error(
-      `Invalid config file: react-gnome CLI is running in ESM mode and can only accept configs in ESModule format. To run react-gnome in CommonJS mode, set the 'type' field in your package.json to 'commonjs'.`,
+      `Invalid config file: react-gtk CLI is running in ESM mode and can only accept configs in ESModule format. To run react-gtk in CommonJS mode, set the 'type' field in your package.json to 'commonjs'.`,
     );
   }
 
diff --git a/src/esbuild-plugins/import-polyfills/import-polyfills.ts b/src/esbuild-plugins/import-polyfills/import-polyfills.ts
@@ -3,7 +3,7 @@ import path from "path";
 import type { Program } from "../../programs/base";
 import { createNodePolyfillMap } from "./create-node-polyfill-map";
 
-export const POLYFILL_IMPORT_NS = "react-gnome-polyfills";
+export const POLYFILL_IMPORT_NS = "react-gtk-polyfills";
 
 const NodePolyfills = createNodePolyfillMap([
   {
@@ -35,7 +35,7 @@ const NodePolyfills = createNodePolyfillMap([
 
 export const importPolyfillsPlugin = (program: Program) => {
   return {
-    name: "react-gnome-import-polyfills-esbuild-plugin",
+    name: "react-gtk-import-polyfills-esbuild-plugin",
     setup(build: esbuild.PluginBuild) {
       NodePolyfills.addResolvers(program, build);
 
diff --git a/src/esbuild-plugins/react-gtk/default-gi-imports.ts b/src/esbuild-plugins/react-gtk/default-gi-imports.ts
diff --git a/src/esbuild-plugins/react-gtk/react-gtk-plugin.ts b/src/esbuild-plugins/react-gtk/react-gtk-plugin.ts
@@ -23,20 +23,20 @@ class ExternalImport {
   }
 }
 
-export type GnomePluginOptions = {
+export type ReactGtkEsbuildPluginOptions = {
   giRequirements?: [string, string | undefined][];
 };
 
-export const reactGnomePlugin = (
+export const reactGtkPlugin = (
   program: Program,
-  options: GnomePluginOptions,
+  options: ReactGtkEsbuildPluginOptions,
 ) => {
   const externalPackages = new Set(program.config.externalPackages ?? []);
   externalPackages.add("system");
   externalPackages.add("gettext");
 
   return {
-    name: "react-gnome-esbuild-plugin",
+    name: "react-gtk-esbuild-plugin",
     setup(build: esbuild.PluginBuild) {
       const gi = new GiImports(program.config.giVersions);
       const externalImports: ExternalImport[] = [];
@@ -104,7 +104,7 @@ export const reactGnomePlugin = (
                 const resource = ${JSON.stringify(resource.resourceString)};
 
                 if(applicationCss) {
-                  applicationCss.addStyles({ 
+                  applicationCss.addStyles({
                     resource: resource.substring("resource://".length),
                   });
                 }
diff --git a/src/esbuild-plugins/start-app/start-app-plugin.ts b/src/esbuild-plugins/start-app/start-app-plugin.ts
@@ -27,7 +27,7 @@ export const startAppPlugin = (params: {
   let cleanup: () => any = () => {};
 
   return {
-    name: "react-gnome-start-app-esbuild-plugin",
+    name: "react-gtk-start-app-esbuild-plugin",
     setup(build: esbuild.PluginBuild) {
       build.onEnd(async () => {
         await cleanup();
diff --git a/src/esbuild-plugins/watch-logger/watch-logger-plugin.ts b/src/esbuild-plugins/watch-logger/watch-logger-plugin.ts
@@ -4,7 +4,7 @@ import { html, Output } from "termx-markup";
 export const watchLoggerPlugin = () => {
   let isFirstBuild = true;
   return {
-    name: "react-gnome-watch-logger-esbuild-plugin",
+    name: "react-gtk-watch-logger-esbuild-plugin",
     setup(build: esbuild.PluginBuild) {
       build.onStart(() => {
         if (!isFirstBuild) {
diff --git a/src/get-dirpath/get-dirpath.ts b/src/get-dirpath/get-dirpath.ts
@@ -1,5 +1,5 @@
 /**
  * Gets the directory path for this scripts package. (ex.
- * `/home/user/Documents/App/node_modules/react-gnome`)
+ * `/home/user/Documents/App/node_modules/react-gtk`)
  */
 export declare const getDirPath: () => string;
diff --git a/src/init-project/config-file-js.ts b/src/init-project/config-file-js.ts
@@ -1,7 +1,7 @@
 export const getJsProjectConfigFile = () =>
   /* ts */ `
 export default () => {
-  /** @type {import("@reactgjs/react-gnome").BuildConfig} */
+  /** @type {import("@reactgjs/react-gtk").BuildConfig} */
   const config = {
     applicationName: "SampleApp",
     applicationVersion: "1.0.0",
diff --git a/src/init-project/config-file-ts.ts b/src/init-project/config-file-ts.ts
@@ -1,6 +1,6 @@
 export const getTsProjectConfigFile = () =>
   /* ts */ `
-import { BuildConfig } from "@reactgjs/react-gnome";
+import { BuildConfig } from "@reactgjs/react-gtk";
 
 export default () => {
   const config: BuildConfig = {
diff --git a/src/init-project/entry-file-js.ts b/src/init-project/entry-file-js.ts
@@ -7,18 +7,18 @@ import {
   Span,
   Window,
 } from "@reactgjs/renderer";
-import "@reactgjs/react-gnome";
+import "@reactgjs/react-gtk";
 import env from "gapp:env";
 
 new Renderer({ appId: env.appId }).start(
     <Window
       minWidth={800}
       minHeight={600}
-      quitOnClose 
-      title="Sample React Gnome App"
+      quitOnClose
+      title="Sample React GTK App"
     >
         <Markup>
-          <Span fontSize={32}>Sample React Gnome App</Span>
+          <Span fontSize={32}>Sample React GTK App</Span>
         </Markup>
     </Window>,
 );
diff --git a/src/init-project/entry-file-ts.ts b/src/init-project/entry-file-ts.ts
diff --git a/src/packaging/templates/in-file.ts b/src/packaging/templates/in-file.ts
diff --git a/src/programs/init-program.ts b/src/programs/init-program.ts
diff --git a/src/utils/get-plugins.ts b/src/utils/get-plugins.ts
diff --git a/src/utils/read-config.ts b/src/utils/read-config.ts

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"url": "./node_modules/git-hook-tasks/dist/config/json-schema.json"`
`11`	`11`	`},`
`12`	`12`	`{`
`13`		`- "fileMatch": ["react-gnome.config.json"],`
	`13`	`+ "fileMatch": ["react-gtk.config.json"],`
`14`	`14`	`"url": "./dist/config-schema.json"`
`15`	`15`	`},`
`16`	`16`	`{`
`@@ -38,4 +38,4 @@`
`38`	`38`	`"[json]": {`
`39`	`39`	`"editor.defaultFormatter": "dprint.dprint"`
`40`	`40`	`}`
`41`		`-}`
	`41`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const { start } = require("@reactgjs/react-gtk/cli");`
	`2`	`+start();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import { start } from "@reactgjs/react-gtk/cli";`
	`2`	`+start();`