.. include:: /Includes.rst.txt
.. index:: pair: Coding guidelines; TypeScript
.. _cgl-typescript:

============================
TypeScript coding guidelines
============================

`Excel Micro TypeScript Style Guide for TypeScript
<https://github.com/excelmicro/typescript>`__ should be used throughout the
TYPO3 Core for TypeScript files.

Directories and file names
==========================

* TypeScript files should have the file ending :file:`.ts`

* TypeScript files are located under :file:`<extension>/Resources/Private/TypeScript/`


Format
======

* Use spaces, not TABs.

* Indent with 2 spaces.

.. seealso::

   `Excel Micro : Whitespace <https://github.com/excelmicro/typescript#whitespace>`__

More information
================

* See :ref:`cgl-ide` in this manual for information about setting up your Editor / IDE to adhere to
  the coding guidelines.