Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.85 KB
Raw

Contributing to Pandino

CMDs

# Install deps:
npm i

# Format code:
npm run format

# Build all packages (excluding example project):
npm run build

# Build single package, e.g.:
npm run build --workspace @pandino/pandino

Key Architectural Decisions

  • Pandino is built on top of TypeScript, and TS support will always be a given for all first party packages
  • Supported platforms are: Browsers and NodeJS
  • Service decoupling is achieved via interfacing, which means that cross-bundle service references do not require class imports which results in super-lean bundles.
  • Testing is paramount, but from a coverage perspective, reaching 100% coverage is not a goal. The actual goal is reaching confidence
  • "Extra" Bundles may or may not contain tests, depending on how complicated they are
  • Some necessary initialization parameters such as the BundleImporter and ManifestFetcher will always rely on platform specific standard solutions, e.g.: native import / require and native fetch depending on platform.
  • Similarly to OSGi, Pandino it self is a Bundle as well, just like any other building block
  • Configurability of the Pandino instance is paramount

Notes

Tree-shaking

Do not export enums, messes up tree-shaking, use types instead!

Testing

In order for IDEs to be able to provide proper breakpoints and debugging support, JEST needs a dedicated tsconfig.test.json file in every project.

The reason for this is that in bundle outputs we usually do not provide source-maps, but IDEs rely on them.

Sources

Temporary scripts

npx conventional-changelog-cli -p angular -i CHANGELOG.md -s -r 0