Skip to content

Latest commit

 

History

History
165 lines (124 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

165 lines (124 loc) · 3.32 KB
Raw

Contributing

Dependencies

Lists projects dependencies and the versions.

npm --version  # Dependency management
node --version # Testing and implementation
bash --version | head -n 1 # For usage examples

# Examples on how to use server
curl --version | head -n 1 | cut -f -2 -d ' '
9.8.0
v20.5.1
GNU bash, version 5.0.17(1)-release (x86_64-pc-linux-gnu)
curl 7.68.0

Other:

Development

First clone the project and then run npm link.

npm ci
npm link
furver --version

You should now be able to run the bin scripts and tests.

Tests

npm t -- -R classic

# or with code coverage
# npx c8 npm t

> furver@1.2.1 test
> tap -j 1 *.test.mjs --no-cov -R classic

cli.test.mjs .......................................... 4/4 5s
client.test.mjs ..................................... 16/16
curry.test.mjs ........................................ 4/4
debounce.test.mjs ..................................... 3/3
http.test.mjs ....................................... 10/10
lisp.test.mjs ....................................... 14/14
promises.test.mjs ................................... 10/10
total ............................................... 61/61

  61 passing (7s)

  ok

Formatting

npx standard

Client Bundle

set -euo pipefail

# Install dependencies without storing them in the package.json
npm install --no-save rollup \
  @rollup/plugin-babel \
  @rollup/plugin-commonjs \
  @rollup/plugin-terser \
  @rollup/plugin-node-resolve

# Uses the .babelrc and the rollup.config.mjs configs
npx rollup -c

git add ./client.min.js

added 32 packages, removed 22 packages, and audited 404 packages in 6s

39 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

Documentation

set -euo pipefail

# Install dependencies for the examples.
npm install ramda --no-save > /dev/null

# Spawn a server to demonstrate examples.
export PORT=8999
npx furver server ./example/api.mjs&

# And spawn one for the getting-started examples
npx furver server ./example/getting-started.mjs --port 5000&

# Could use pinging instead to wait for the server to start.
sleep 4

for mz in *.mz ;do
  test "$mz" = "CONTRIBUTING.mz" && continue
  name="${mz%.*}"
  md="${name}.md"
  echo "Generating docs for: $mz > $md"
  rm "$md" || true
  markatzea "$mz" | tee "$md" 1>&2
  chmod -x "$md"
done

# Add a TOC
npx markdown-toc -i README.md
npx markdown-toc -i client.md
npx markdown-toc -i lisp.md
npx markdown-toc -i server.md

# Remove tmp files created in the mz files.
rm -v .tmp.*

# Stop the server
pkill furver
Generating docs for: client.mz > client.md
Generating docs for: http.mz > http.md
Generating docs for: lisp.mz > lisp.md
Generating docs for: README.mz > README.md
Generating docs for: server.mz > server.md
removed '.tmp.client.example.mjs'
removed '.tmp.client.mjs'
removed '.tmp.getting.mjs'
removed '.tmp.lisp_exec.mjs'
removed '.tmp.lisp_fn.mjs'
removed '.tmp.lisp_import.mjs'
removed '.tmp.lisp_let.mjs'
removed '.tmp.lisp_ref.mjs'

Changelog

The changelog is generated using the useful auto-changelog project.

npx auto-changelog -p