Skip to content

Commit

Permalink
docs: clarify how devDependencies should be used for NPM packages
Browse files Browse the repository at this point in the history
  • Loading branch information
bradenmacdonald committed Jul 25, 2024
1 parent 4c81b5c commit c2bc4a8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions oeps/best-practices/oep-0067-bp-tools-and-technology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,16 @@ Frontend Technology Selection
don't unintentionally increase the size of our JavaScript bundles, we utilize BundleWatch
for automated bundle size monitoring.

#. **Development dependencies should be separated into devDependencies**

**Rationale**: To keep installation and deployment of our MFEs as fast as
possible, the "dependencies" field in ``package.json`` should reference only
the packages needed to build the bundle of the MFE (this includes webpack via
frontend-build, as well as any dependencies used in the actual MFE/React
code). Any dependencies used only for testing, linting, formatting, or other
development tasks should be put into "devDependencies" (e.g. Jest, eslint,
TypeScript, ``@types/`` packages, etc.).

Backend Technology Selection
============================

Expand Down

0 comments on commit c2bc4a8

Please sign in to comment.