Skip to content

Commit

Permalink
chore: fix markdown lint check (#3430)
Browse files Browse the repository at this point in the history
  • Loading branch information
Torres-ssf authored Dec 2, 2024
1 parent ef94263 commit cb3a31a
Show file tree
Hide file tree
Showing 11 changed files with 265 additions and 1,252 deletions.
4 changes: 4 additions & 0 deletions .changeset/khaki-berries-divide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

chore: fix markdown lint check
2 changes: 1 addition & 1 deletion .github/workflows/code-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ jobs:
- name: Lint
run: pnpm lint

- name: Lint markdown files
- name: Check markdown files links
run: pnpm lint:md-links
4 changes: 1 addition & 3 deletions .knip.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@
"lsof",
"memfs",
"open",
"textlint",
"textlint-rule-no-dead-link",
"@elasticpath/textlint-rule-no-dead-relative-link",
"markdown-link-check",
"ts-generator",
"webdriverio",
"syncpack"
Expand Down
19 changes: 0 additions & 19 deletions .textlintrc.json

This file was deleted.

27 changes: 13 additions & 14 deletions apps/docs-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,16 @@

# Modules

- [abi-coder](./modules/_fuel_ts_abi_coder.html)
- [abi-typegen](./modules/_fuel_ts_abi_typegen.html)
- [account](./modules/_fuel_ts_account.html)
- [address](./modules/_fuel_ts_address.html)
- [crypto](./modules/_fuel_ts_crypto.html)
- [errors](./modules/_fuel_ts_errors.html)
- [hasher](./modules/_fuel_ts_hasher.html)
- [interfaces](./modules/_fuel_ts_interfaces.html)
- [math](./modules/_fuel_ts_math.html)
- [predicate](./modules/_fuel_ts_predicate.html)
- [program](./modules/_fuel_ts_program.html)
- [script](./modules/_fuel_ts_script.html)
- [transactions](./modules/_fuel_ts_transactions.html)
- [utils](./modules/_fuel_ts_utils.html)
- [abi-coder](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_abi_coder.html)
- [abi-typegen](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_abi_typegen.html)
- [account](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_account.html)
- [address](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_address.html)
- [crypto](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_crypto.html)
- [errors](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_errors.html)
- [hasher](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_hasher.html)
- [interfaces](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_interfaces.html)
- [math](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_math.html)
- [program](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_program.html)
- [script](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_script.html)
- [transactions](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_transactions.html)
- [utils](https://fuels-ts-docs-api.vercel.app/modules/_fuel_ts_utils.html)
4 changes: 2 additions & 2 deletions apps/docs/src/guide/contracts/managing-deployed-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ To interact with a deployed contract using the SDK without redeploying it, you o

## Contract ID

The `contractId` property from the [`Contract`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_program.Contract.html) class is of type [`AbstractAddress`](https:https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_interfaces.AbstractAddress.html), an abstract class that is exclusively extended by the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class.
The `contractId` property from the [`Contract`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_program.Contract.html) class is of type [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html), an abstract class that is exclusively extended by the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class.

The [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class wraps all methods from the [`AbstractAddress`](https:https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_interfaces.AbstractAddress.html) class and adds a single property: `bech32Address`. This property is a string encoded in [`Bech32`](../types/bech32.md) format, recognizable by the human-readable prefix `fuel` followed by the separator `1`.
The [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class wraps all methods from the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class and adds a single property: `bech32Address`. This property is a string encoded in [`Bech32`](../types/bech32.md) format, recognizable by the human-readable prefix `fuel` followed by the separator `1`.

> [!NOTE] Note
> `Bech32` addresses like `fuel1..` are now deprecated; please switch to B256 format, for more details see [here](https://docs.fuel.network/docs/specs/abi/argument-encoding/#b256).
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/guide/types/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ In Sway, the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_a

## `AbstractAddress` Class

The SDK defines the [AbstractAddress](https:https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_interfaces.AbstractAddress.html) class, which provides a set of utility functions for easy manipulation and conversion between address formats.
The SDK defines the [AbstractAddress](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class, which provides a set of utility functions for easy manipulation and conversion between address formats.

<<< @/../../../packages/interfaces/src/index.ts#address-1{ts:line-numbers}

## Address Class

Besides conforming to the interface of the [`AbstractAddress`](https:https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_interfaces.AbstractAddress.html), the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class also defines one property; `bech32Address`, which is of the [`Bech32`](./bech32.md) type.
Besides conforming to the interface of the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html), the [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) class also defines one property; `bech32Address`, which is of the [`Bech32`](./bech32.md) type.

<<< @/../../../packages/address/src/address.ts#address-2{ts:line-numbers}

## Creating an Address

Thanks to the utility functions provided by the [`AbstractAddress`](https:https://fuels-ts-docs-api.vercel.app/interfaces/_fuel_ts_interfaces.AbstractAddress.html) class, there are several ways to create an [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) instance:
Thanks to the utility functions provided by the [`AbstractAddress`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_interfaces.AbstractAddress.html) class, there are several ways to create an [`Address`](https://fuels-ts-docs-api.vercel.app/classes/_fuel_ts_address.Address.html) instance:

### From a `Bech32` Address

Expand Down
12 changes: 12 additions & 0 deletions link-check.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"aliveStatusCodes": [200, 206],
"timeout": "10s",
"retryOn429": true,
"retryCount": 2,
"fallbackRetryDelay": "5s",
"ignorePatterns": [
{
"pattern": "^http://localhost:3000"
}
]
}
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@
"@changesets/read": "^0.6.1",
"@changesets/types": "^6.0.0",
"@codspeed/vitest-plugin": "^3.1.1",
"@elasticpath/textlint-rule-no-dead-relative-link": "^1.1.1",
"@fuel-ts/utils": "workspace:*",
"@internal/forc": "workspace:*",
"@internal/fuel-core": "workspace:*",
Expand Down Expand Up @@ -111,16 +110,15 @@
"eslint-plugin-tsdoc": "^0.3.0",
"glob": "^10.4.5",
"knip": "^5.30.6",
"markdown-link-check": "3.12.2",
"memfs": "^4.14.0",
"nodemon": "^3.1.7",
"npm-run-all": "^4.1.5",
"nyc": "^17.1.0",
"open": "^10.1.0",
"prettier": "^3.3.3",
"rimraf": "^5.0.10",
"textlint": "^14.2.1",
"syncpack": "12.3.3",
"textlint-rule-no-dead-link": "^5.2.0",
"ts-generator": "^0.1.1",
"tsup": "^6.7.0",
"tsx": "^4.19.1",
Expand Down
Loading

0 comments on commit cb3a31a

Please sign in to comment.