Skip to content

fix(docs): restore jsligo keywords #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
timothymcmackin wants to merge 1 commit into
base: rinderknecht@new_jsligo
Choose a base branch
from
Open

fix(docs): restore jsligo keywords #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions gitlab-pages/docs/intro/upgrade-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,7 @@ const test = (() => {

Escaping keywords is no longer supported; keywords cannot be used as variable names or object fields, even if you prefix the names with the `@` symbol.
For example, you can add an underscore as a suffix, creating variables with names such as `return_` or `entry_`.
See [Keywords](../syntax/keywords).

## Decorators

Expand Down
52 changes: 48 additions & 4 deletions gitlab-pages/docs/syntax/keywords.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,68 @@ title: Keywords

import Syntax from '@theme/Syntax';

_Keywords_ are reserved words that cannot be used as names in declarations.
In some cases you can escape keywords to use them as variables or record fields.
_Keywords_ are reserved words that cannot be used as names in declarations such as variables and record fields.

<Syntax syntax="cameligo">

## Escaping keywords

Keywords cannot be used as variables or record fields. If you need to
use a keyword as a variable, you can prefix it with `@`, like so:
If you need to use a keyword as a variable name, you can prefix it with `@`, as in this example:

```cameligo group=keywords
let @from = ("tz1fakefakefakefakefakefakefakcphLA5" : address)
```

</Syntax>

<Syntax syntax="jsligo">

Unlike in previous versions of JsLIGO, you cannot start variable names with an `@` symbol and therefore you cannot escape keywords by putting an `@` symbol in front of their names.
You can modify the keywords in other ways, such as adding an underscore to the end.

</Syntax>

## List of keywords

<Syntax syntax="jsligo">

JsLIGO's keywords are the following:

- `as`
- `break`
- `case`
- `const`
- `continue`
- `contract_of`
- `default`
- `do`
- `else`
- `export`
- `false`
- `for`
- `from`
- `function`
- `if`
- `implements`
- `import`
- `interface`
- `let`
- `match`
- `namespace`
- `of`
- `parameter_of`
- `return`
- `switch`
- `true`
- `type`
- `when`
- `while`

JslIGO may allow you to create and use variables with these names in some cases, but for some uses the compiler fails to compile contracts that use variables with these names.
Therefore, do not use variables with these names even if the contract appears to work.

</Syntax>

<Syntax syntax="cameligo">
CameLIGO's keywords are the following:
<ul>
Expand Down