Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 1.76 KB

README.md

File metadata and controls

45 lines (37 loc) · 1.76 KB
Raw

preact-es2020-template

A skeleton for un-bundled preact projects.

Install

this command will do an npm install for you

npm run setup

Build

npm run build

Watch

npm run watch

Serve

npm run serve

Vendor

use after updating dependencies in build/ventor.ts

npm run vendor

No bundler, pure ES2020 modules loaded directly into the browser. This doesn't use any special loaders, bundlers, file servers, etc. Hosting is done via a static file server, you could use any static file server you want, but I chose http-server for this template because it is small and simple.

The one caveat with this project is the vendoring of dependencies. To add a runtime dependency:

  1. open build/vendor.ts
  2. create an entry in the array at the top
  3. specify the dependency package name (the thing you would put in the TS import statement)
  4. specify the path within the package that should be copied (the whole folder will be vendored recursively, usually this is a dist or out folder)
  5. specify the path to the index file (relative to the copied folder from previous step) for the package (usually index.js or package-name.js or package-name.min.js)
  6. from the root directory of this project run npm run vendor

This will generate the runtime import map and embed it into your index.html file so the browser can turn import { ... } from 'my-package' into a fetch of ./vendor/my-package/dist/index-file.js. If you have transitive dependencies, you will need ot add additional lines for each of them. If a package is importad with a nested path like import '@namespace/package/path/to/thing' you will need to include a packageToVendor property in the line item that specifies @namespace/package as well.