Go to GitHub project page or GitHub issues for the milestone and TODO items we are used for tracking upcoming features and bug fixes.
Visual Studio Code is the best editor for TypeScript. Install and configure following plugins and configurations before starting development.
To maintain a consistent coding style, we use TSLint to find potential bugs. All developers should follow the same tslint.json defined in project.
prettier is a tool helping automatically clean up our TypeScript codes. Recommend to open "FormatOnSave" feature of Visual Studio Code.
This is useful for generating JSDoc for TypeScript codes.
Used to automatically sort TypeScript import statements.
Every Azure Storage REST APIs maps to one handler method. Handler methods throwing NotImplementedError should be implemented.
Every handler will talk to persistence layer directly. We make implements of persistency layer abstract by creating interfaces. LokiBlobDataStore is one of the implementation based on Loki database used by Azurite V3.
In the root of the repository, we have provided pre-defined debugging scripts. This makes it easy to debug in Visual Studio Code with simple F5 click for debug configuration "Azurite Blob Service".
Or manually follow following steps to build and run:
npm install
npm run blobSelect and start Visual Studio Code debug configuration "Run Extension".
For every newly implemented REST API and handler, there should be at least coverage from 1 unit / integration test case.
We also provide a predefined Visual Studio Code debug configuration "Current Mocha", allowing you to execute mocha tests within the currently opended file.
Or manually execute all test cases:
npm install
npm run testMake sure test cases are added for the changes you made. And send a PR to dev branch for Azurite V3 or later development, dev-legacy branch for Azurite V2.