Skip to content

Latest commit

 

History

History
139 lines (99 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

139 lines (99 loc) · 3.03 KB
Raw

Development Degu

Prerequisites

npm install --global typescript
npm install --global simplehttpserver # Optional, to preview docs
npm install --global typedoc
npm install --global surge # Optional, for publishing docs and examples

Installation

npm install

Common Development Commands

npm run dev

    The main dev command which basically build the project.

npm run dev-with-test
    Run the project with tests.

npm run test
npm run test -- --watch
    Run ava unit testing

npm run lint
    Lint project.
npm run fix
    Auto fix lint issues.

npm run start
    Run the examples folder on localhost.

npm run build
npm run build -- --watch
    Build the project.  Compiles src folders into the release /lib folder

npm version patch
npm publish
   Publish a new version to npm.


// Docs
npm run doc
  Build typedocs.  Builds into the /doc folder.

npm run doc-server
  Run a local srever to view the docs.

npm run publish-doc
  Publishes the docs to surge.io.
  Manually Run:$ surge --domain degu.surge.sh --project $PWD/docs/

npm run coverage
  Runs coverage report

npm run publish-coverage
  Publishes the docs to surge.io.
  Manually Run:$ surge --domain degu-coverage.surge.sh --project $PWD/coverage/

// Quick publish
npm run publish
  Build docs, run test and coverage and publish all

Development Practices / Guidelines

When writing a class

  • create an example in /examples. The example should focus on just using that class and the rest should be vanilla JS if possible. this is because when someone is trying to learn a library, it's really hard if the examples use a lot of methods and classes that are unfamiliar. The exception would be for advanced examples.

Use release-please style commit messages, e.g.

  • feat: add some new feature
  • chore: update docs
  • refactor: move some file into another place

Testing with Ava

Tests use wonderful ava.

For typescript use for ava check out this

For general info on writing tests

Project Structure

/docs      --> Project Docs
/examples  --> Examples
/lib       --> Compiled Degu JS lib
/src       --> Source files (typescript)
/webpack   --> Webpack configuration to run the local example project.

Npm Linking

See this article for more

Linking

$ cd ~/degu  # To to whereever this git repo is cloned to
$ npm link

Navigate to your project
$ npm link @blinkk/degu

Unlinking

The order is important here.

Navigate to your project
$ npm unlink --no-save @blinkk/degu

$ cd ~/degu  # To to whereever this git repo is cloned to
$ npm unlink

Examples runnning on server

Examples can be run on a servrer using node server which is an express app. See server.js.

npm install
npm rebuild node-sass  # Sometimes need on linux
node server