Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.17 KB

README.md

File metadata and controls

109 lines (81 loc) · 3.17 KB
Raw

Exemplar JS

Developer Guide

Prerequisites

  • git
  • node >=16
  • npm >=8

Getting Started

npx degit git@github.com:AlexJeffcott/exemplar-js.git#main exemplar-js
cd exemplar-js
npm i
npx lerna bootstrap
npm run in-all-packages -- setup
npm run in-all-packages -- start
npm run in-all-packages -- test
npm run in-all-packages -- test:cov
npm run in-all-packages -- start:dev

Creating a new package

mkdir PACKAGE_NAME && cd $_
npm set-script setup "printf \"NODE_ENV=DEVELOPMENT\" >.env"
npm set-script start "echo \"Add a start script for PACKAGE_NAME\""
npm set-script test "echo \"Add a test script for PACKAGE_NAME\""
npm set-script test:cov "echo \"Add a test:cov script for PACKAGE_NAME\""
npm set-script start:dev "echo \"Add a start:dev script for PACKAGE_NAME\""

How the project was made

Prerequisites

  • git
  • github cli
  • node >=16
  • npm >=8

Bootstrapping

brew update && brew upgrade gh
mkdir exemplar-js && cd $_
git init -b main
printf "# Exemplar- JS\n\n\`\`\`shell\nbrew update && brew upgrade gh\nmkdir exemplar-js && cd \$_\ngit init\nnpm init -y\n\`\`\`" > README.md
npm init -y
git add .
git commit -m "initial commit"
gh repo create exemplar-js --source=. --private --disable-issues --disable-wiki --push

It's a mono-repo

More can be found out at lerna docs

npm i -D lerna
printf "{\"packages\": [\"tsc-only-node\"],\"version\": \"0.0.0\"}" > lerna.json
npx prettier --write lerna.json

Setting up git hooks with quality tooling

More can be found out at husky docs and commitlint docs

npm i -D husky @commitlint/cli @commitlint/config-conventional
npx husky-init && npm install
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
npx husky add .husky/pre-commit "npx lerna run lint"
npx husky add .husky/pre-commit "npx lerna run test"

N.B. You'll need to remove the line npm test from .husky/pre-commit

To uninstall git hook stuff

npm uninstall husky @commitlint/cli @commitlint/config-conventional && git config --unset core.hooksPath

Enable CI with testing

mkdir -p .github/workflows
printf "# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node" > .github/workflows/workflow.yml

Using GitHub Actions, we can configure automatic testing via .yml files under .github/workflows.

Further reading

https://2ality.com/2019/10/hybrid-npm-packages.html https://www.sensedeep.com/blog/posts/2021/how-to-create-single-source-npm-module.html

Interesting gotchas

  1. if you install "@types/react-router-dom": "^5.3.3",, then you will get tsc errors due to a typing conflict. Simply remove the package.
  2. you should include vite.config.js (not .ts) in the include array in tsconfig.json for eslint, but it should not be parsed as typescript as this creates problems with vite's own typing dependencies.

update deps

npx npm-check-updates -u