@granite-js/cli 0.0.1 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @granite-js/cli
 
+## 0.1.1
+
+### Patch Changes
+
+- d675415: Improve scaffolding to provide a better showcase UI
+- 10a5f3f: empty
+- Updated dependencies [d675415]
+- Updated dependencies [10a5f3f]
+  - @granite-js/plugin-core@0.1.1
+  - @granite-js/mpack@0.1.1
+  - @granite-js/utils@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+- 561a3ed: fix: docs deadlink
+
+### Patch Changes
+
+- Updated dependencies [561a3ed]
+  - @granite-js/mpack@0.1.0
+  - @granite-js/plugin-core@0.1.0
+  - @granite-js/utils@0.1.0
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/index.d.cts

@@ -110,6 +110,55 @@ interface GraniteConfigResponse extends z.infer<typeof graniteConfigSchema> {
         };
     };
 }
+/**
+ * @public
+ * @category Configuration
+ * @name defineConfig
+ * @description
+ * Configures your Granite application by defining key settings in `granite.config.ts`.
+ *
+ * The configuration lets you specify:
+ * - How users will access your app through a URL scheme (e.g. `granite://`)
+ * - Your app's unique name that appears in the URL (e.g. `granite://my-service`)
+ * - Build settings for bundlers like ESBuild and Metro
+ * - Code transformation settings through Babel
+ * - Additional functionality through Granite plugins
+ *
+ * @param config - Configuration options
+ * @param config.appName - Your app's unique identifier
+ * @param config.scheme - URL scheme for launching your app (e.g. 'granite')
+ * @param config.plugins - Granite plugins to enhance functionality
+ * @param config.outdir - Where to output build files (defaults to 'dist')
+ * @param config.entryFile - Your app's entry point (defaults to './src/_app.tsx')
+ * @param config.cwd - Working directory for build process (defaults to process.cwd())
+ * @param config.mpack - Fine-tune mpack bundler behavior
+ * @param config.babel - Customize Babel transpilation
+ * @param config.esbuild - Adjust ESBuild bundling
+ * @param config.metro - Configure Metro bundler settings
+ * @returns The processed configuration
+ *
+ * @example
+ * Here's a basic configuration that:
+ * - Makes your app accessible via the `granite://` scheme
+ * - Names your service "my-app" so it's reachable at `granite://my-app`
+ * - Uses the Hermes plugin to optimize JavaScript bundles into bytecode
+ *
+ * ```ts
+ * import { defineConfig } from '@granite-js/react-native/config';
+ * import { hermes } from '@granite-js/plugin-hermes';
+ *
+ * export default defineConfig({
+ *   // The name of your microservice
+ *   appName: 'my-app',
+ *   // The URL scheme for deep linking
+ *   scheme: 'granite',
+ *   // Entry file path
+ *   entryFile: 'index.ts',
+ *   // Array of plugins to use
+ *   plugins: [hermes()],
+ * });
+ * ```
+ */
 declare const defineConfig: (config: GraniteConfigInput) => Promise<GraniteConfigResponse>;
 
 declare const loadConfig: () => Promise<GraniteConfigResponse>;

package/dist/index.d.ts

@@ -110,6 +110,55 @@ interface GraniteConfigResponse extends z.infer<typeof graniteConfigSchema> {
         };
     };
 }
+/**
+ * @public
+ * @category Configuration
+ * @name defineConfig
+ * @description
+ * Configures your Granite application by defining key settings in `granite.config.ts`.
+ *
+ * The configuration lets you specify:
+ * - How users will access your app through a URL scheme (e.g. `granite://`)
+ * - Your app's unique name that appears in the URL (e.g. `granite://my-service`)
+ * - Build settings for bundlers like ESBuild and Metro
+ * - Code transformation settings through Babel
+ * - Additional functionality through Granite plugins
+ *
+ * @param config - Configuration options
+ * @param config.appName - Your app's unique identifier
+ * @param config.scheme - URL scheme for launching your app (e.g. 'granite')
+ * @param config.plugins - Granite plugins to enhance functionality
+ * @param config.outdir - Where to output build files (defaults to 'dist')
+ * @param config.entryFile - Your app's entry point (defaults to './src/_app.tsx')
+ * @param config.cwd - Working directory for build process (defaults to process.cwd())
+ * @param config.mpack - Fine-tune mpack bundler behavior
+ * @param config.babel - Customize Babel transpilation
+ * @param config.esbuild - Adjust ESBuild bundling
+ * @param config.metro - Configure Metro bundler settings
+ * @returns The processed configuration
+ *
+ * @example
+ * Here's a basic configuration that:
+ * - Makes your app accessible via the `granite://` scheme
+ * - Names your service "my-app" so it's reachable at `granite://my-app`
+ * - Uses the Hermes plugin to optimize JavaScript bundles into bytecode
+ *
+ * ```ts
+ * import { defineConfig } from '@granite-js/react-native/config';
+ * import { hermes } from '@granite-js/plugin-hermes';
+ *
+ * export default defineConfig({
+ *   // The name of your microservice
+ *   appName: 'my-app',
+ *   // The URL scheme for deep linking
+ *   scheme: 'granite',
+ *   // Entry file path
+ *   entryFile: 'index.ts',
+ *   // Array of plugins to use
+ *   plugins: [hermes()],
+ * });
+ * ```
+ */
 declare const defineConfig: (config: GraniteConfigInput) => Promise<GraniteConfigResponse>;
 
 declare const loadConfig: () => Promise<GraniteConfigResponse>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@granite-js/cli",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "The Granite CLI",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -44,9 +44,9 @@
     "vitest": "^3.0.7"
   },
   "dependencies": {
-    "@granite-js/mpack": "0.0.1",
-    "@granite-js/plugin-core": "0.0.1",
-    "@granite-js/utils": "0.0.1",
+    "@granite-js/mpack": "0.1.1",
+    "@granite-js/plugin-core": "0.1.1",
+    "@granite-js/utils": "0.1.1",
     "@inquirer/prompts": "^7.2.3",
     "@shopify/semaphore": "^3.1.0",
     "chalk": "^4",