Skip to content
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

Update documentation to replace jsconfig.json with tsconfig.json for Volto Version 17 #901

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −5
Open

Update documentation to replace jsconfig.json with tsconfig.json for Volto Version 17 #901

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
570bb91
Update documentation to replace jsconfig.json with tsconfig.json for …
aniket7r Dec 10, 2024
46f353e
Merge branch 'main' into issue_815
aniket7r Dec 15, 2024
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
10 changes: 5 additions & 5 deletions docs/voltoaddons/01-addon-basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Use `@plone-collective/volto-datatable-tutorial` as the package name. After the
scaffolding of the add-on completes, you can check the created files in
`src/addons/volto-datatable-tutorial`.

Back to the project, you can edit `jsconfig.json` and add your add-on:
Back to the project, you can edit `tsconfig.json` and add your add-on:

```json
{
Expand All @@ -123,16 +123,16 @@ Back to the project, you can edit `jsconfig.json` and add your add-on:
```

```{note}
The `jsconfig.json` file is needed by Volto to identify development
The `tsconfig.json` file is needed by Volto to identify development
packages. You are not strictly limited to Volto add-ons in its use, you
could, for example, use this to make it easier to debug third-party
JavaScript packages that are shipped transpiled.
JavaScript packages that are shipped transpiled. Projects using Volto versions before 17 should still refer to `jsconfig.json`.
```

### (Optional) Use mrs-developer to sync add-on to GitHub

You can also immediately push the package to GitHub, then use `[mrs-developer]`
to manage the package and `jsconfig.json` changes.
to manage the package and `tsconfig.json` changes.

Install mrs-developer as a development dependency by running:

Expand All @@ -155,7 +155,7 @@ to your names and repository location):
```

Then run `yarn develop`, which will bring the package in `src/addons` and
adjust `jsconfig.json`.
adjust `tsconfig.json`.

### Add the add-on as workspace

Expand Down
Loading