Skip to content

[Map] Document workspace:* issue with npm install and file:vendor/symfony/ux-*-map/assets #2982

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

Closed
wants to merge 1 commit into from
Closed

[Map] Document workspace:* issue with npm install and file:vendor/symfony/ux-*-map/assets #2982

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
27 changes: 23 additions & 4 deletions src/Map/src/Bridge/Google/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,36 @@ Install the bridge using Composer and Symfony Flex:
composer require symfony/ux-google-map
```

If you're using WebpackEncore, install your assets and restart Encore (not
needed if you're using AssetMapper):
If you're using WebpackEncore, install your assets with a JavaScript packages manager that supports `workspace:` protocol
like [pnpm](https://pnpm.io/) or [Yarn](https://yarnpkg.com/), and restart Encore (not needed if you're using AssetMapper):

```shell
npm install --force
npm run watch
# with pnpm
pnpm install --force
pnpm run watch

# or with Yarn
yarn install --force
yarn run watch
```

> [!NOTE]
> Alternatively, [@symfony/ux-google-map package](https://www.npmjs.com/package/@symfony/ux-google-map) can be used to install the JavaScript assets without requiring PHP.

> [!IMPORTANT]
> **Q: Why can't I use `npm` to install dependency from `vendor:symfony/ux-google-map`? What is `workspace:` protocol?**
>
> Internally, UX Google Map uses the [pnpm's workspace feature](https://pnpm.io/workspaces) to reference `@symfony/ux-map` package as a **development** dependency.
>
> When running `npm install` with `"@symfony/ux-google-map": "file:vendor/symfony/ux-google-map/assets"` in your `package.json`, npm is not smart enough to ignore the `devDependencies` section from `vendor/symfony/ux-google-map/assets/package.json` file, leading to the following error:
> ```
> npm error code EUNSUPPORTEDPROTOCOL
> npm error Unsupported URL Type "workspace:": workspace:*
> ```
> To fix this, we can recommend you to use a better JavaScript package manager like [pnpm](https://pnpm.io/) or [Yarn](https://yarnpkg.com/), which supports `workspace` protocol.
>
> Related issues: https://github.com/symfony/ux/issues/2737, https://github.com/symfony/ux/issues/2951

## DSN example

```dotenv
Expand Down
27 changes: 23 additions & 4 deletions src/Map/src/Bridge/Leaflet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,36 @@ Install the bridge using Composer and Symfony Flex:
composer require symfony/ux-leaflet-map
```

If you're using WebpackEncore, install your assets and restart Encore (not
needed if you're using AssetMapper):
If you're using WebpackEncore, install your assets with a JavaScript packages manager that supports `workspace:` protocol
like [pnpm](https://pnpm.io/) or [Yarn](https://yarnpkg.com/), and restart Encore (not needed if you're using AssetMapper):

```shell
npm install --force
npm run watch
# with pnpm
pnpm install --force
pnpm run watch

# or with Yarn
yarn install --force
yarn run watch
```

> [!NOTE]
> Alternatively, [@symfony/ux-leaflet-map package](https://www.npmjs.com/package/@symfony/ux-leaflet-map) can be used to install the JavaScript assets without requiring PHP.

> [!IMPORTANT]
> **Q: Why can't I use `npm` to install dependency from `vendor:symfony/ux-leaflet-map`? What is `workspace:` protocol?**
>
> Internally, UX Leaflet Map uses the [pnpm's workspace feature](https://pnpm.io/workspaces) to reference `@symfony/ux-map` package as a **development** dependency.
>
> When running `npm install` with `"@symfony/ux-leaflet-map": "file:vendor/symfony/ux-leaflet-map/assets"` in your `package.json`, npm is not smart enough to ignore the `devDependencies` section from `vendor/symfony/ux-leaflet-map/assets/package.json` file, leading to the following error:
> ```
> npm error code EUNSUPPORTEDPROTOCOL
> npm error Unsupported URL Type "workspace:": workspace:*
> ```
> To fix this, we can recommend you to use a better JavaScript package manager like [pnpm](https://pnpm.io/) or [Yarn](https://yarnpkg.com/), which supports `workspace` protocol.
>
> Related issues: https://github.com/symfony/ux/issues/2737, https://github.com/symfony/ux/issues/2951

## DSN example

```dotenv
Expand Down