Merge branch 'main' into proto-download

cosmology-tech · May 8, 2024 · 7f4c30a · 7f4c30a
2 parents 998f352 + 382bac0
commit 7f4c30a
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -302,7 +302,7 @@ telescope({
 | `prototypes.includes.protos`              | include a set of proto files when transpilation. (if a proto both meet include and exclude, it'll be excluded)                 | `undefined`|
 | `prototypes.excluded.packages`            | exclude a set of packages from transpilation                    | `undefined`|
 | `prototypes.excluded.protos`              | try to exclude a set of proto files from transpilation. if files inside the list are dependencies to other files, they'll be still transpiled.                 | `undefined`|
-| `prototypes.excluded.hardProtos`              | exclude a set of proto files from transpilation. Files in this list will be excluded no mater it's dependency to other files or not.                 | `undefined`|
+| `prototypes.excluded.hardProtos`              | exclude a set of proto files from transpilation. Files in this list will be excluded no matter it is a dependency to other files or not.                 | `undefined`|
 | `prototypes.fieldDefaultIsOptional`       | boolean value representing default optionality of field         | `false`    |
 | `prototypes.useOptionalNullable`          | use `(gogoproto.nullable)` values in determining optionality    | `true`     |
 | `prototypes.allowUndefinedTypes`          | boolean value allowing `Type`s to be `undefined`                | `false`    |
@@ -603,8 +603,8 @@ For querying data via REST endpoints, you can use LCD Clients. For a better deve
 ```ts
 const options: TelescopeOptions = {
     lcdClients: {
-        enabled: true;
-    }
+        enabled: true,
+    },
 };
 ```
 

diff --git a/docs/helpers.md b/docs/helpers.md
@@ -2,7 +2,7 @@
 
 # Common helpers or utils
 
-when generating code, sometimes we need to import helpers, utils or packages. In that case, using addUtil method in context when building ast is recommend, since we only add utils as needed without worrying repetitive import:
+when generating code, sometimes we need to import helpers, utils or packages. In that case, using addUtil method in context when building ast is recommended, since we only add utils as needed without worrying about repetitive import:
 
 ```
 context.addUtil('useQuery');
@@ -46,7 +46,7 @@ export const UTILS = {
 If we have to import from the helper files created by ourselves, we can continue reading sections below.
 
 ## 1 create helper contents
-In this example, content of a common helper will be created and exported under folder apackages/telescope/src/helpers
+In this example, content of a common helper will be created and exported under folder packages/telescope/src/helpers
 ```js
 export const useEndpoint = defineStore('endpoint', {
 
@@ -93,4 +93,4 @@ export const UTIL_HELPERS = [
 ];
 ```
 
-[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
+[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
diff --git a/docs/migration.md b/docs/migration.md
@@ -4,7 +4,7 @@
 
 ### deprecated aminoEncoding.useRecursiveV2encoding
 
-If `aminoEncoding.useRecursiveV2encoding: false` is used in your config, and want to keep it(not recommemded). It's changed into `aminoEncoding.useLegacyInlineEncoding: true`.
+If `aminoEncoding.useRecursiveV2encoding: false` is used in your config, and want to keep it(not recommended). It's changed into `aminoEncoding.useLegacyInlineEncoding: true`.
 
 We have removed the `useRecursiveV2encoding` option, then Telescope will use `useLegacyInlineEncoding: false` as default value. And the new version of the logic of this part will be applied.
 
@@ -26,7 +26,7 @@ If it's wanted to be kept off, please set explicitly:
 
 the default value of `prototypes.typingsFormat.customTypes.useCosmosSDKDec` has been changed into true for decimal fields to be properly decoded using Decimal.fromAtomics.
 
-Even though it's not recommemded, if it's wanted to be kept off, please set explicitly:
+Even though it's not recommended, if it's wanted to be kept off, please set explicitly:
 
 ```
     prototypes: {
@@ -40,7 +40,7 @@ Even though it's not recommemded, if it's wanted to be kept off, please set expl
 
 ### BigInt
 
-The default value of `prototypes.typingsFormat.num64` has been changed into 'bigint' for bettern handling int64 fields.
+The default value of `prototypes.typingsFormat.num64` has been changed into 'bigint' for better handling int64 fields.
 
 If it's wanted to be kept to be 'long', please set explicitly:
 

diff --git a/docs/tests.md b/docs/tests.md
@@ -2,7 +2,7 @@
 
 # Tests
 
-`cd` into a package and run the tests, for exmaple:
+`cd` into a package and run the tests, for example:
 
 ```
 cd ./packages/ast
@@ -32,4 +32,4 @@ cd ./packages/telescope
 yarn test:watch
 ```
 
-[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
+[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
diff --git a/docs/working-with-asts.md b/docs/working-with-asts.md
@@ -32,7 +32,7 @@ yarn test:ast
 code ./scripts/test-output.json
 ```
 
-We use the npm module `ast-stringify` to strip out unneccesary props, and generate a JSON for reference.
+We use the npm module `ast-stringify` to strip out unnecessary props, and generate a JSON for reference.
 
 You will see a `File` and `Program`... only concern yourself with the `body[]`:
 
@@ -138,4 +138,4 @@ export const createNewGenerator = () => {
 NOTE, see our docs on [creating new generators](https://github.com/cosmology-tech/telescope/blob/main/docs/creating-new-generators.md) which shows how to create and run a test.
 
 
-[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
+[< back](https://github.com/cosmology-tech/telescope/blob/main/docs/README.md)
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/telescope/README.md b/packages/telescope/README.md
@@ -302,7 +302,7 @@ telescope({
 | `prototypes.includes.protos`              | include a set of proto files when transpilation. (if a proto both meet include and exclude, it'll be excluded)                 | `undefined`|
 | `prototypes.excluded.packages`            | exclude a set of packages from transpilation                    | `undefined`|
 | `prototypes.excluded.protos`              | try to exclude a set of proto files from transpilation. if files inside the list are dependencies to other files, they'll be still transpiled.                 | `undefined`|
-| `prototypes.excluded.hardProtos`              | exclude a set of proto files from transpilation. Files in this list will be excluded no mater it's dependency to other files or not.                 | `undefined`|
+| `prototypes.excluded.hardProtos`              | exclude a set of proto files from transpilation. Files in this list will be excluded no matter it is a dependency to other files or not.                 | `undefined`|
 | `prototypes.fieldDefaultIsOptional`       | boolean value representing default optionality of field         | `false`    |
 | `prototypes.useOptionalNullable`          | use `(gogoproto.nullable)` values in determining optionality    | `true`     |
 | `prototypes.allowUndefinedTypes`          | boolean value allowing `Type`s to be `undefined`                | `false`    |
@@ -603,8 +603,8 @@ For querying data via REST endpoints, you can use LCD Clients. For a better deve
 ```ts
 const options: TelescopeOptions = {
     lcdClients: {
-        enabled: true;
-    }
+        enabled: true,
+    },
 };
 ```