Version Packages

CHANGELOG.md

@@ -1,5 +1,41 @@
 # @gadgetinc/ggt
 
+## 0.3.4
+
+### Patch Changes
+
+- 628c24f: Bump @sentry/node from 7.80.1 to 7.81.0
+- 82536a8: Bump @sentry/node from 7.79.0 to 7.80.0
+- ae25c76: Bump @sentry/node from 7.75.1 to 7.76.0
+- dbbbc96: Bump @sentry/node from 7.81.1 to 7.82.0
+- f9385ea: Bump ignore from 5.2.4 to 5.3.0
+- 041cfe4: Bump fs-extra from 11.1.1 to 11.2.0
+- 197bec8: Bump serialize-error from 11.0.2 to 11.0.3
+- 0a555c0: Bump @sentry/node from 7.82.0 to 7.84.0
+- 29c6ed0: Bump @sentry/node from 7.80.0 to 7.80.1
+- bdc646d: Bump @sentry/node from 7.76.0 to 7.77.0
+- 4b67530: Bump @inquirer/select from 1.3.0 to 1.3.1
+- 188e22f: Bump @sentry/node from 7.77.0 to 7.79.0
+- 770beb1: We made some improvements to our debug logs!
+
+  Previously, we were using the `debug` package to log messages. This was good at first, but now that we're adding more features to `ggt` we need more control over our logs. We want to be able to output structured logs, control the verbosity, and output them as JSON so that we can pipe them to another tool or parse them in a script.
+
+  To accomplish this, we've added 2 new flags:
+
+  - `-v, --verbose` to output structured logs
+
+    This replaces the `--debug` flag, which was a boolean flag that would print out all logs. This new flag is a counter, so you can use it multiple times to increase the verbosity of the logs. Currently, there are 3 levels of verbosity:
+
+    - `-v` = INFO
+    - `-vv` = DEBUG
+    - `-vvv` = TRACE
+
+  - `--json` to print out logs in JSON format
+
+    This is useful if you want to pipe the logs to another tool, or if you want to parse the logs in a script.
+
+- d69f01f: Bump @sentry/node from 7.81.0 to 7.81.1
+
 ## 0.3.3
 
 ### Patch Changes

README.md

@@ -33,6 +33,7 @@
   - [`ggt login`](#ggt-login)
   - [`ggt logout`](#ggt-logout)
   - [`ggt whoami`](#ggt-whoami)
+  - [`ggt version`](#ggt-version)
 
 ## Intro
 
@@ -55,24 +56,23 @@ $ npm install -g @gadgetinc/ggt
 $ ggt
 The command-line interface for Gadget
 
-VERSION
-  ggt/0.3.3 linux-x64 node-v16.20.2
-
 USAGE
-  $ ggt [COMMAND]
+  ggt [COMMAND]
+
+COMMANDS
+  sync           Sync your Gadget application's source code
+  list           List your apps
+  login          Log in to your account
+  logout         Log out of your account
+  whoami         Print the currently logged in account
+  version        Print the version of ggt
 
 FLAGS
   -h, --help     Print command's usage
-  -v, --version  Print version
-      --debug    Print debug output
+  -v, --verbose  Print verbose output
+      --json     Print output as JSON
 
-COMMANDS
-  sync    Sync your Gadget application's source code to and
-          from your local filesystem.
-  list    List your apps.
-  login   Log in to your account.
-  logout  Log out of your account.
-  whoami  Print the currently logged in account.
+For more information on a specific command, use 'ggt [COMMAND] --help'
 ```
 
 ## Commands
@@ -84,78 +84,69 @@ Sync your Gadget application's source code to and from
 your local filesystem.
 
 USAGE
-  $ ggt sync [DIRECTORY] [--app <name>]
+  ggt sync [DIRECTORY] [--app=<name>]
 
 ARGUMENTS
-  DIRECTORY  [default: .] The directory to sync files to.
-
-             If the directory doesn't exist, it will be created.
+  DIRECTORY         The directory to sync files to (default: ".")
 
 FLAGS
-  -a, --app=<name>  The Gadget application to sync files to.
-
-  --force           Whether to sync even if we can't determine
-                    the state of your local files relative to
-                    your remote ones.
+  -a, --app=<name>  The Gadget application to sync files to
+      --force       Sync regardless of local file state
 
 DESCRIPTION
-  Sync provides the ability to sync your Gadget application's source
-  code to and from your local filesystem.
+  Sync allows you to synchronize your Gadget application's source
+  code with your local filesystem.
 
   While ggt sync is running, local file changes are immediately
-  reflected within Gadget, while files that are changed remotely are
+  reflected within Gadget, while files that are changed in Gadget are
   immediately saved to your local filesystem.
 
-  Use cases for this include:
-    • Developing locally with your own editor like VSCode
-    • Storing your source code in a Git repository like GitHub
+  Ideal for:
+    • Local development with editors like VSCode
+    • Storing source code in a Git repository like GitHub
 
-  Sync includes the concept of a .ignore file. This file may
-  contain a list of files and directories that won't be received or
-  sent to Gadget when syncing. The format of this file is identical
-  to the one used by Git (https://git-scm.com/docs/gitignore).
+  Sync looks for a ".ignore" file to exclude certain files/directories
+  from being synced. The format is identical to Git's.
 
-  The following files and directories are always ignored:
+  These files are always ignored:
     • .DS_Store
     • .gadget
     • .git
     • node_modules
 
   Note:
-    • If you have separate development and production environments,
-      ggt sync will only sync with your development environment
-    • Gadget applications only support installing dependencies
-      with Yarn 1 (https://classic.yarnpkg.com/lang/en/)
-    • Since file changes are immediately reflected in Gadget,
-      avoid the following while ggt sync is running:
-        • Deleting all your files
-        • Moving all your files to a different directory
+    • Sync only works with your development environment
+    • Avoid deleting/moving all your files while sync is running
+    • Gadget only supports Yarn v1 for dependency installation
 
-EXAMPLES
-  $ ggt sync --app my-app ~/gadget/my-app
+EXAMPLE
+  $ ggt sync ~/gadget/example --app example
+
+    App         example
+    Editor      https://example.gadget.app/edit
+    Playground  https://example.gadget.app/api/graphql/playground
+    Docs        https://docs.gadget.dev/api/example
 
-  App         my-app
-  Editor      https://my-app.gadget.app/edit
-  Playground  https://my-app.gadget.app/api/graphql/playground
-  Docs        https://docs.gadget.dev/api/my-app
+    Endpoints
+      • https://example.gadget.app
+      • https://example--development.gadget.app
 
-  Endpoints
-    • https://my-app.gadget.app
-    • https://my-app--development.gadget.app
+    Watching for file changes... Press Ctrl+C to stop
 
-  Watching for file changes... Press Ctrl+C to stop
+    → Sent 09:06:25 AM
+    routes/GET-hello.js  + create
 
-  Received 12:00:00 PM
-  ← routes/GET.js (changed)
-  ← user/signUp/signIn.js (changed)
-  2 files in total. 2 changed, 0 deleted.
+    → Sent 09:06:49 AM
+    routes/GET-hello.js  ± update
 
-  Sent 12:00:03 PM
-  → routes/GET.ts (changed)
-  1 file in total. 1 changed, 0 deleted.
+    ← Received 09:06:54 AM
+    routes/GET-hello.js  ± update
 
-  ^C Stopping... (press Ctrl+C again to force)
-  Goodbye!
+    ← Received 09:06:56 AM
+    routes/GET-hello.js  - delete
+    ^C Stopping... press Ctrl+C again to force
+
+    Goodbye!
 ```
 
 ### `ggt list`
@@ -164,15 +155,15 @@ EXAMPLES
 List the apps available to the currently logged in user.
 
 USAGE
-  $ ggt list
+  ggt list
 
 EXAMPLE
   $ ggt list
-  Slug    Domain
-  ─────── ──────────────────
-  my-app  my-app.gadget.app
-  example example.gadget.app
-  test    test.gadget.app
+    Slug    Domain
+    ─────── ──────────────────
+    my-app  my-app.gadget.app
+    example example.gadget.app
+    test    test.gadget.app
 ```
 
 ### `ggt login`
@@ -181,15 +172,15 @@ EXAMPLE
 Log in to your account.
 
 USAGE
-  $ ggt login
+  ggt login
 
 EXAMPLES
   $ ggt login
-  We've opened Gadget's login page using your default browser.
+    We've opened Gadget's login page using your default browser.
 
-  Please log in and then return to this terminal.
+    Please log in and then return to this terminal.
 
-  Hello, Jane Doe (jane@example.com)
+    Hello, Jane Doe (jane@example.com)
 ```
 
 ### `ggt logout`
@@ -198,22 +189,35 @@ EXAMPLES
 Log out of your account.
 
 USAGE
-  $ ggt logout
+  ggt logout
 
 EXAMPLES
   $ ggt logout
-  Goodbye
+    Goodbye
 ```
 
 ### `ggt whoami`
 
 ```
-Show the name and email address of the currently logged in user.
+Show the name and email address of the currently logged in user
 
 USAGE
-  $ ggt whoami
+  ggt whoami
 
 EXAMPLES
   $ ggt whoami
-  You are logged in as Jane Doe (jane@example.com)
+    You are logged in as Jane Doe (jane@example.com)
+```
+
+### `ggt version`
+
+```
+Print the version of ggt
+
+USAGE
+  ggt version
+
+EXAMPLES
+  $ ggt version
+    0.3.4
 ```