docs: adr-0001 nodeps + ci check (#19)

* docs: adr-0001 nodeps + ci check

* ci: add check
This commit is contained in:
Marc 2023-04-13 21:40:30 -04:00
parent cf98db4d39
commit cab7505672
Signed by: marc
GPG key ID: 048E042F22B5DC79
3 changed files with 33 additions and 0 deletions

View file

@ -6,6 +6,13 @@ on:
branches: [main] branches: [main]
jobs: jobs:
adr-0001-depcheck:
name: No-dependencies check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: . ./script/check-deps
dependencies: dependencies:
runs-on: ubuntu-latest runs-on: ubuntu-latest

View file

@ -0,0 +1,16 @@
# ADR 1 - No production dependencies
---
# Decision
The project should have no production dependencies that users need to install for core functionality to work.
Some optional peer dependencies are acceptable (i.e. the project installing `womm` might need to install `typescript` to support Typescript tests, etc.). These should not be bundled with `womm`.
Development dependencies should be kept to a minimum and each one present should be thoroughly justified.
# Rationale
The NodeJS ecosystem is too trigger-happy with `npm install` and `yarn add`. Even basic applications quickly end up requiring tens of packages to be shipped to users. A lot of those packages being maintained (or not) by the community, this means that ensuring that the downstream dependency of a project can quickly become a major concern.
The best way to ensure that things are becoming stale is to depend on less, and depending on nothing than the standard library is best.

10
script/check-deps Normal file
View file

@ -0,0 +1,10 @@
#!/usr/bin/bash
# This check enforces ADR 0001 - the project should not have dependencies.
DEPENDENCIES=$(cat package.json | jq .dependencies -cr)
if [[ $DEPENDENCIES != "null" ]]; then
echo "This project should have no dependencies."
exit 1;
fi