docs: migrate `guide/types` snippets #3340

Torres-ssf · 2024-10-16T13:26:28Z

Closes Migrate snippets from guide/types #2955

Checklist

All changes are covered by tests (or not applicable)
All changes are documented (or not applicable)
I reviewed the entire PR myself (preferably, on GH UI)
I described all Breaking Changes (or there's none)

maschad

Great work on this @Torres-ssf

apps/docs-snippets2/scripts/wrap-snippets.ts

Torres-ssf · 2024-10-22T01:37:22Z

Nice one @Torres-ssf 🥇

Should we have tests around the snippets?

@petertonysmith94 Every doc snippet file will have a corresponding test generated for it.

github-actions · 2024-10-22T17:13:04Z

Coverage Report:

Lines	Branches	Functions	Statements
73.57%(-2.35%)	70.24%(+0.2%)	74.66%(-0.37%)	73.81%(-2.24%)

Changed Files:

Ok	File (✨=New File)	Lines	Branches	Functions	Statements
🔴	✨ apps/docs-snippets2/src/typegend/contracts/BytecodeInput.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/BytecodeInputFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoAssetId.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoAssetIdFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoBytes.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoBytesFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoEmployeeDataVector.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoEmployeeDataVectorFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoEnum.ts	80% (+80%)	100% (+100%)	66.66% (+66.66%)	91.66% (+91.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoEnumFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoEvmAddress.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoEvmAddressFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoRawSlice.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoRawSliceFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoStdString.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoStdStringFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/EchoValues.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/EchoValuesFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/InputOutputTypes.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/InputOutputTypesFactory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/typegend/contracts/SumOptionU8.ts	66.66% (+66.66%)	100% (+100%)	0% (+0%)	66.66% (+66.66%)
✅	✨ apps/docs-snippets2/src/typegend/contracts/SumOptionU8Factory.ts	100% (+100%)	100% (+100%)	100% (+100%)	100% (+100%)
🔴	✨ apps/docs-snippets2/src/types/arrays.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bech32.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bytes.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/raw-slice.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/std-string.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/string.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/structs.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/tuples.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/vectors.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/creating-an-address.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/from-a-b256.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/from-a-public-key.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/utilities-function-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/utilities-function-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/address/utilities-function-3.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/asset-id/intro.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/asset-id/using-an-asset-id-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/asset-id/using-an-asset-id-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bits256/converting-between-b256-uint8.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bits256/generating-random-b256.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bits256/support-from-address-class.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bits512/b512-in-the-sdk.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bits512/echoing-a-b512.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bytes32/converting-between-byte.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/bytes32/generating-random-bytes32.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-an-invalid-enum-case.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-an-invalid-enum-type.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-an-invalid-enum-value.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-enums-of-enums-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-enums-of-enums-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/enums/using-sway-enums.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/evm-address/creating-an-evm.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/evm-address/intro.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/evm-address/using-an-evm-address-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/evm-address/using-an-evm-address-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/native-parameters/address.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/native-parameters/asset-id.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/native-parameters/contract-id.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/native-parameters/identity-address.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/native-parameters/identity-contract.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/numbers/for-u64-and-u256-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/numbers/for-u64-and-u256-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/numbers/for-u64-and-u256-3.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/numbers/for-u8-u16-and-u32-1.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/numbers/for-u8-u16-and-u32-2.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/options/example-option-u8.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)
🔴	✨ apps/docs-snippets2/src/types/options/overview-of-option.ts	0% (+0%)	100% (+100%)	100% (+100%)	0% (+0%)

Torres-ssf added 30 commits September 30, 2024 10:26

migrate address snippets

d95bc93

update address doc page

1e109f1

remove old address code snippets

f781285

add echo-values sway project to new doc snippets dir

9f66948

migrate arrays snippets

5adc8f8

update arrays doc page

9a8826c

migrate echo asset id Sway project to new code snippets dir

fd87062

remove old arrays code snippets

9c3b4b1

migrate asset id code snippets

0b5bd23

update asset id docs

bac17ee

remove old asset id code snippets

8ede634

migrate bits256 code snippets

d7c909e

update bits256 doc page

05774ff

remove old bits256 code snippets

6b28adb

migrate bits512 code snippets

95672be

update bits512 doc page

44e1724

remove old bits512 code snippets

93b554b

migrate echo bytes Sway project to new code snippets dir

f6d584b

migrate bytes code snippets

5a01706

update bytes doc page

78afcc6

remove old bytes code snippets

7f4ea64

migrate bytes32 code snippets

77c3c1e

update bytes32 doc page

30ac49c

remove old bytes32 code snippets

02d580f

migrate echo enum Sway project to new code snippets dir

22643f5

update new code snippets dir main Forc toml

1d923e9

migrate enums code snippets

f9ee576

update enums doc page

7ab826f

remove enums doc page

edeedb5

linting some snippets

85ae53f

vercel bot deployed to Preview – fuels-template October 21, 2024 19:01 View deployment

vercel bot deployed to Preview – ts-docs October 21, 2024 19:01 View deployment

maschad previously approved these changes Oct 21, 2024

View reviewed changes

Torres-ssf commented Oct 22, 2024

View reviewed changes

apps/docs-snippets2/scripts/wrap-snippets.ts Outdated Show resolved Hide resolved

Torres-ssf dismissed maschad’s stale review via d8e7b19 October 22, 2024 01:35

Update apps/docs-snippets2/scripts/wrap-snippets.ts

d8e7b19

Torres-ssf requested review from arboleya and maschad October 22, 2024 01:36

vercel bot deployed to Preview – fuels-template October 22, 2024 01:39 View deployment

vercel bot deployed to Preview – ts-docs October 22, 2024 01:39 View deployment

petertonysmith94 previously approved these changes Oct 22, 2024

View reviewed changes

Merge branch 'master' into st/docs/migrate-types-snippets

c5ecd35

Torres-ssf dismissed petertonysmith94’s stale review via c5ecd35 October 22, 2024 11:12

Torres-ssf requested a review from petertonysmith94 October 22, 2024 11:12

vercel bot deployed to Preview – ts-docs October 22, 2024 11:17 View deployment

vercel bot deployed to Preview – fuels-template October 22, 2024 11:17 View deployment

petertonysmith94 approved these changes Oct 22, 2024

View reviewed changes

Merge branch 'master' into st/docs/migrate-types-snippets

88b95e9

vercel bot deployed to Preview – fuels-template October 22, 2024 13:20 View deployment

vercel bot deployed to Preview – ts-docs October 22, 2024 13:21 View deployment

trigger CI

f2bb76d

vercel bot deployed to Preview – fuels-template October 22, 2024 16:56 View deployment

vercel bot deployed to Preview – ts-docs October 22, 2024 16:58 View deployment

arboleya approved these changes Oct 22, 2024

View reviewed changes

Torres-ssf enabled auto-merge (squash) October 22, 2024 18:34

nedsalk approved these changes Oct 23, 2024

View reviewed changes

Torres-ssf merged commit 88d7535 into master Oct 23, 2024
24 checks passed

Torres-ssf deleted the st/docs/migrate-types-snippets branch October 23, 2024 10:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: migrate `guide/types` snippets #3340

docs: migrate `guide/types` snippets #3340

Torres-ssf commented Oct 16, 2024 •

edited

Loading

maschad left a comment

Torres-ssf commented Oct 22, 2024 •

edited

Loading

github-actions bot commented Oct 22, 2024

docs: migrate guide/types snippets #3340

docs: migrate guide/types snippets #3340

Conversation

Torres-ssf commented Oct 16, 2024 • edited Loading

Checklist

maschad left a comment

Choose a reason for hiding this comment

Torres-ssf commented Oct 22, 2024 • edited Loading

github-actions bot commented Oct 22, 2024

docs: migrate `guide/types` snippets #3340

docs: migrate `guide/types` snippets #3340

Torres-ssf commented Oct 16, 2024 •

edited

Loading

Torres-ssf commented Oct 22, 2024 •

edited

Loading