Skip to content

Commit

Permalink
List image package type
Browse files Browse the repository at this point in the history
  • Loading branch information
wkillerud authored Oct 16, 2024
1 parent e2a109c commit 99463ed
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/dependencies/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,19 @@ In the Managing dependencies section you'll learn how to:

## Eik package types

It's worth mentioning at this stage that Eik differentiates between three types of packages:
It's worth mentioning at this stage that Eik differentiates between these types of packages:

- `npm`
- `map`
- `package`
- `image`

You'll see this distinction in [`eik.json`](/docs/reference/eik-json/) and in the URL where your package gets published. Each package type has its own namespace. This is to avoid accidental naming collisions between, say, the `npm` module `lit` and the import map `lit`.

Application code should be published to the `package` namespace. This is also the default, if no other type is configured in `eik.json`.

Long-lived static assets like images should be in an `image` package, separate from frequently-changing application code.

## Naming and versioning packages

Packages published to Eik should follow the [npm module naming convention](https://github.com/npm/validate-npm-package-name) and [Semantic Versioning](https://semver.org/). This applies to all namespaces, although semantic versioning is less relevant for application code.
Expand Down

0 comments on commit 99463ed

Please sign in to comment.