Skip to content

Latest commit

 

History

History
132 lines (92 loc) · 4.11 KB

DEVELOPERS.md

File metadata and controls

132 lines (92 loc) · 4.11 KB
Raw

Building and Testing this project

This document describes how to set up your development environment to build and test this project. It also explains the basic mechanics of using git and node

See the contribution guidelines if you'd like to contribute to this project.

Prerequisite Software

Before you can build and test this project, you must install and configure the following products on your development machine:

Project organisation

The project is organised into the following folder structure:

  • / - Project-level configuration (linting rules, CI, docs, license)
  • fixtures/ - Files used during tests to simulate running the plugin inside Serverless Framework
  • src/ - The source code and test specifications

Installing

# Install the dependencies & devDependencies
npm install

Running Tests

# Run unit tests
npm test

# Run unit tests in watch mode
npm run test:watch

# Run tests and see the coverage report
npm run test:reportlist

Testing with another project

Use npm link to symlink this local package into your global NPM registry on your computer. It will then be available for use within other NPM projects:

# In this project root:
npm link
# > /.nvm/versions/node/v10.17.0/lib/node_modules/oaat -> /mydev/serverless/oaat

# Change to the project directory that wants to test this package
cd ../my-project

# Create a local symlink to oaat
npm link oaat
# > Symlinking "/mydev/my-project/node_modules"
# >     --> "/.nvm/versions/node/v10.17.0/lib/node_modules/oaat"

Formatting your source code

This project uses eslint and prettier to format the source code. If the source code is not properly formatted, the CI will fail and the PR cannot be merged.

You can automatically format your code by running:

  • npm run lint: format all source code

A better way is to set up your IDE to format the changed file on each file save.

WebStorm / IntelliJ

  1. Open Preferences > Languages & Frameworks > JavaScript > Prettier
  2. Find the field named "Prettier Package"
  3. Add <PATH_TO_YOUR_WORKSPACE>/<project-root>/packages/web-app/node_modules/prettier

Linting/Verifying your Source Code

You can check that your code is properly formatted and adheres to coding style:

# Check that the code is formatted and following the coding style:
npm run verify

# Fix any auto-fixable errors
npm run lint

Semantic Release Setup

This section is include for informational purposes only.

This repo uses semantic-release to manage software versions and packaging. There is a one-time setup-step required - WHICH HAS ALREADY BEEN DONE, which creates a GitHub personal access token, an NPM token, and connects them to Travis CI.

One time setup:

cd oaat
npx semantic-release-cli setup

? What is your npm registry? https://registry.npmjs.org/
? What is your npm username? u_glow
? What is your npm password? [hidden]
? What is your GitHub username? uglow
? What is your GitHub password? [hidden]
? What is your GitHub two-factor authentication code? 
? What CI are you using? Travis CI