diff --git a/.changeset/211705f38a5db710e0ddf268f3676301e9a98705.md b/.changeset/211705f38a5db710e0ddf268f3676301e9a98705.md deleted file mode 100644 index 9a95d3674..000000000 --- a/.changeset/211705f38a5db710e0ddf268f3676301e9a98705.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.80.1 to 7.81.0 diff --git a/.changeset/3b54860cb2dd4cdb865f69696697a5cb2a004199.md b/.changeset/3b54860cb2dd4cdb865f69696697a5cb2a004199.md deleted file mode 100644 index c6f5e31cc..000000000 --- a/.changeset/3b54860cb2dd4cdb865f69696697a5cb2a004199.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.79.0 to 7.80.0 diff --git a/.changeset/43d91bc1729b3d1788cba24ec56c98441777a588.md b/.changeset/43d91bc1729b3d1788cba24ec56c98441777a588.md deleted file mode 100644 index f3382aa0d..000000000 --- a/.changeset/43d91bc1729b3d1788cba24ec56c98441777a588.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.75.1 to 7.76.0 diff --git a/.changeset/4934fd59ef514a44e290e3b3cb46e6886271cd32.md b/.changeset/4934fd59ef514a44e290e3b3cb46e6886271cd32.md deleted file mode 100644 index 491e20995..000000000 --- a/.changeset/4934fd59ef514a44e290e3b3cb46e6886271cd32.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.81.1 to 7.82.0 diff --git a/.changeset/5a90467a676c8afeed319552f4cf4040a07c4dc7.md b/.changeset/5a90467a676c8afeed319552f4cf4040a07c4dc7.md deleted file mode 100644 index 5c3aaaed3..000000000 --- a/.changeset/5a90467a676c8afeed319552f4cf4040a07c4dc7.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump ignore from 5.2.4 to 5.3.0 diff --git a/.changeset/91c0b2f5f02f8926e7ad0879a357cda9ba9e2afe.md b/.changeset/91c0b2f5f02f8926e7ad0879a357cda9ba9e2afe.md deleted file mode 100644 index bc40cf937..000000000 --- a/.changeset/91c0b2f5f02f8926e7ad0879a357cda9ba9e2afe.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump serialize-error from 11.0.2 to 11.0.3 diff --git a/.changeset/b95cf5eff226c4ee6e17379af591ff8a15296fb8.md b/.changeset/b95cf5eff226c4ee6e17379af591ff8a15296fb8.md deleted file mode 100644 index 0f6e06bd7..000000000 --- a/.changeset/b95cf5eff226c4ee6e17379af591ff8a15296fb8.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.80.0 to 7.80.1 diff --git a/.changeset/c0ecee3cd91ec024d70edb376eabac6afaa2cbcf.md b/.changeset/c0ecee3cd91ec024d70edb376eabac6afaa2cbcf.md deleted file mode 100644 index ac7b8534a..000000000 --- a/.changeset/c0ecee3cd91ec024d70edb376eabac6afaa2cbcf.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.76.0 to 7.77.0 diff --git a/.changeset/ce13ab1a497c81f6bb9ff9a2dfa5cf9bea146266.md b/.changeset/ce13ab1a497c81f6bb9ff9a2dfa5cf9bea146266.md deleted file mode 100644 index 5d72d1623..000000000 --- a/.changeset/ce13ab1a497c81f6bb9ff9a2dfa5cf9bea146266.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.77.0 to 7.79.0 diff --git a/.changeset/cyan-dolphins-brush.md b/.changeset/cyan-dolphins-brush.md deleted file mode 100644 index 1f3c10e75..000000000 --- a/.changeset/cyan-dolphins-brush.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -"ggt": patch ---- - -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. diff --git a/.changeset/fe982bda616bb44daa05ce189df3905b13d42951.md b/.changeset/fe982bda616bb44daa05ce189df3905b13d42951.md deleted file mode 100644 index 36e62a7aa..000000000 --- a/.changeset/fe982bda616bb44daa05ce189df3905b13d42951.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"ggt": patch ---- - -Bump @sentry/node from 7.81.0 to 7.81.1 diff --git a/CHANGELOG.md b/CHANGELOG.md index 0181a5fc6..210e8bdb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,38 @@ # @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 +- 197bec8: Bump serialize-error from 11.0.2 to 11.0.3 +- 29c6ed0: Bump @sentry/node from 7.80.0 to 7.80.1 +- bdc646d: Bump @sentry/node from 7.76.0 to 7.77.0 +- 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 diff --git a/README.md b/README.md index 260e0e689..fc0987b33 100644 --- a/README.md +++ b/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 ] + ggt sync [DIRECTORY] [--app=] 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= 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= 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 ``` diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index 3d82038b0..6e5851b1c 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -1,12 +1,12 @@ { "name": "ggt", - "version": "0.3.3", + "version": "0.3.4", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "ggt", - "version": "0.3.3", + "version": "0.3.4", "license": "MIT", "dependencies": { "@inquirer/confirm": "^2.0.14", diff --git a/package.json b/package.json index 13e6b1af0..991980b8a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ggt", - "version": "0.3.3", + "version": "0.3.4", "description": "The command-line interface for Gadget", "homepage": "https://github.com/gadget-inc/ggt", "bugs": "https://github.com/gadget-inc/ggt/issues",