Skip to main content
Module

x/mandarinets/docs/style_guide.md

Mandarine.TS is a typescript, decorator-driven framework that allows you to create server-side applications. Mandarine.TS provides a range of built-in solutions such as Dependency Injection, Components, ORM and more. Under its umbrella, Mandarine.TS has 4 modules: Core, Data, Security and MVC, these modules will offer you the requirements to build a Mandarine-powered application.
mandarineorg/mandarinets
Latest
File

MandarineTS Style Guide

Table of contents

Every file related to the functionality of Mandarine must have the following copyright header

// Copyright 2020-2020 The Mandarine.TS Framework authors. All rights reserved. MIT license.

If the code originates elsewhere such as a third-party module or piece of code, ensure that the file has proper copyright headers. We only allow MIT licensed code.

Use Camel case

Example: Use myFile.ts instead of my-file.ts or my_file.ts.

Use dashes for folders

Example: Use my-folder instead of my_folder or myFolder

Add tests for new features

For testing, use Orange testing framework.
Each module should contain tests that verify all the functionalities are properly working. If a module is missing its testing files, it will be rejected.

TODO comments

TODO comments should usually include an issue or the author’s github username in parentheses. Example:

// TODO(andreespirela): Add tests.
// TODO(#123): Support Windows.
// FIXME(#349): Sometimes panics.

Follow the coding standards

Make sure your files are located in their proper folders, example: a file related to the MVC core must not be inside the main core folder.

Be aware of the amount of LOC

  • Do not ever extra code something, if you are writing an utility function, make sure it exists inside Mandarine or deno/std.
  • Functionalities of module like Decorators must be written in a proxy to be able to test it.

Typescript

Interfaces & Enums

Interfaces & Enums must be located under their core namespace. If you are writing an interface related to the main-core module, then it should be located inside Mandarine.ns.ts