@hst/hst-design-system-wc v1.0.5
hst-design-system-wc
The HST Web Components library. This is an output from the HST Design System.
Getting Started
This will walk you through the essentials of getting up and running with a development environment.
Prerequisites
- Node
- NPM
- An IDE like Visual Studio Code
Internal Tools
- Parcel - Used to bundle assets
- Jasmine & Karma - Unit Testing
- PlayWright - EndToEnd Testing
- StoryBook - Documentation
Common Tasks
- npm install - Installs all require node packages to get you up and running.
- npm run start - Builds the packages and starts StoryBook.
- npm run clean - Deletes folders used for internal build tool caching.
- npm run e2e - Runs EndToEnd tests using PlayWright
- npm run test - Runs Jasmine Unit tests.
NPM Workspaces
Workspaces is a generic term that refers to the set of features in the npm cli that provides support to managing multiple packages from your local files system from within a singular top-level, root package.
This set of features makes up for a much more streamlined workflow handling linked packages from the local file system. Automating the linking process as part of npm install and avoiding manually having to use npm link in order to add references to packages that should be symlinked into the current node_modules folder.
We also refer to these packages being auto-symlinked during npm install as a single workspace, meaning it's a nested package within the current local file system that is explicitly defined in the package.json workspaces configuration.