Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Latest commit

 

History

History
44 lines (31 loc) · 1.79 KB

DEVELOPING.md

File metadata and controls

44 lines (31 loc) · 1.79 KB
Raw

Developer's Guide

We use Visual Studio Code for developing LoopBack and recommend the same to our users.

VSCode setup

Install the following extensions:

Development workflow

Visual Studio Code

  1. Start the build task (Cmd+Shift+B) to run TypeScript compiler in the background, watching and recompiling files as you change them. Compilation errors will be shown in the VSCode's "PROBLEMS" window.

  2. Execute "Run Rest Task" from the Command Palette (Cmd+Shift+P) to re-run the test suite and lint the code for both programming and style errors. Linting errors will be shown in VSCode's "PROBLEMS" window. Failed tests are printed to terminal output only.

Other editors/IDEs

  1. Open a new terminal window/tab and start the continuous build process via npm run build:watch. It will run TypeScript compiler in watch mode, recompiling files as you change them. Any compilation errors will be printed to the terminal.

  2. In your main terminal window/tab, run npm run test:dev to re-run the test suite and lint the code for both programming and style errors. You should run this command manually whenever you have new changes to test. Test failures and linter errors will be printed to the terminal.

Use NestJS CLI for sake of consistency:

  1. Creating new provider - Things like repository, etc
    1. nest g modules/module-name/provider-name use --no-spec if you do not want to write unit test for it
    2. Now code in that created file
  2. Creating new interceptor:
    1. nest g interceptor modules/module-name/interceptor-name use --no-spec if you do not want to write unit test for it