.. image:: https://raw.githubusercontent.com/activist-org/ts-backend-check/main/.github/resources/TSBackendCheckGitHubBanner.png :width: 100% :align: center :target: https://github.com/activist-org/ts-backend-check |rtd| |ci_static_analysis| |ci_pytest| |issues| |language| |pypi| |pypistatus| |license| |coc| |matrix| .. |rtd| image:: https://img.shields.io/readthedocs/ts-backend-check.svg?label=%20&logo=read-the-docs&logoColor=ffffff :target: http://ts-backend-check.readthedocs.io/en/latest/ .. |ci_static_analysis| image:: https://img.shields.io/github/actions/workflow/status/activist-org/ts-backend-check/ci_static_analysis.yaml?branch=main&label=%20&logo=ruff&logoColor=ffffff :target: https://github.com/activist-org/ts-backend-check/actions/workflows/ci_static_analysis.yaml .. |ci_pytest| image:: https://img.shields.io/github/actions/workflow/status/activist-org/ts-backend-check/ci_pytest.yaml?branch=main&label=%20&logo=pytest&logoColor=ffffff :target: https://github.com/activist-org/ts-backend-check/actions/workflows/ci_pytest.yaml .. |issues| image:: https://img.shields.io/github/issues/activist-org/ts-backend-check?label=%20&logo=github :target: https://github.com/activist-org/ts-backend-check/issues .. |language| image:: https://img.shields.io/badge/Python%203-306998.svg?logo=python&logoColor=ffffff :target: https://github.com/activist-org/ts-backend-check/blob/main/CONTRIBUTING.md .. |pypi| image:: https://img.shields.io/pypi/v/ts-backend-check.svg?label=%20&color=4B8BBE :target: https://pypi.org/project/ts-backend-check/ .. |pypistatus| image:: https://img.shields.io/pypi/status/ts-backend-check.svg?label=%20 :target: https://pypi.org/project/ts-backend-check/ .. |license| image:: https://img.shields.io/github/license/activist-org/ts-backend-check.svg?label=%20 :target: https://github.com/activist-org/ts-backend-check/blob/main/LICENSE.txt .. |coc| image:: https://img.shields.io/badge/Contributor%20Covenant-ff69b4.svg :target: https://github.com/activist-org/ts-backend-check/blob/main/.github/CODE_OF_CONDUCT.md .. |matrix| image:: https://img.shields.io/badge/Matrix-000000.svg?logo=matrix&logoColor=ffffff :target: https://matrix.to/#/#activist_community:matrix.org ======== Contents ======== * `About ts-backend-check`_ * `Installation`_ * `How It Works`_ * `Configuration`_ * `Contributing`_ ====================== About ts-backend-check ====================== ``ts-backend-check`` (``tsbc``) is a Python package for checking TypeScript types against their corresponding backend models to assure that all fields have been accounted for. Developed by the `activist community `_, this package helps keep frontend and backend development teams in sync. The package supports Django-based backends. ============ Installation ============ Users ----- You can install ``ts-backend-check`` using `uv `_ (recommended) or `pip `_. uv ^^ (Recommended - fast, Rust-based installer) .. code-block:: bash uv pip install ts-backend-check pip ^^^ .. code-block:: bash pip install ts-backend-check Development Build ----------------- You can install the latest development build using uv, pip, or by cloning the repository. Clone the Repository (Development Build) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash git clone https://github.com/activist-org/ts-backend-check.git # or ideally your fork cd ts-backend-check uv (Development Build) ^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash uv sync --all-groups # install all dependencies source .venv/bin/activate # activate venv (macOS/Linux) # .venv\Scripts\activate # activate venv (Windows) pip (Development Build) ^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash python -m venv .venv # create virtual environment source .venv/bin/activate # activate venv (macOS/Linux) # .venv\Scripts\activate # activate venv (Windows) pip install -e . `Back to top. <#top>`_ ============ How It Works ============ Commands -------- These are some example commands: **Show Help and Available Commands** .. code-block:: bash # You can use either ts-backend-check or tsbc to access the CLI. # ts-backend-check --help tsbc --help **Generate a Configuration File** .. code-block:: bash # ts-backend-check --generate-config-file tsbc -gcf **Generate the Test Project** .. code-block:: bash # ts-backend-check includes a test project for testing the functionalities. # ts-backend-check --generate-test-project tsbc -gtp **Check a TypeScript Interface Against a Backend Model** .. code-block:: bash # ts-backend-check --identifier tsbc -i **Check All Models and Interfaces** .. code-block:: bash # ts-backend-check --all tsbc -a Example Outputs --------------- These are some example outputs for passed and failed checks. Passed Check ^^^^^^^^^^^^ .. code-block:: text ts-backend-check -i valid_model ✅ Success: All backend models are synced with their corresponding TypeScript interfaces for the provided 'valid_model' files. Failed Check ^^^^^^^^^^^^ .. code-block:: text ts-backend-check -i invalid_model ❌ ts-backend-check error: There are inconsistencies between the provided 'invalid_model' backend models and TypeScript interfaces. Please see the output below for details. Field 'description' (camelCase: 'description') from model 'EventModel' is missing in the TypeScript interfaces. Expected to find this field in the frontend interfaces: Event, EventExtended To ignore this field, add the following comment to the TypeScript file (in order based on the model fields): '// ts-backend-check: ignore description' Field 'participants' (camelCase: 'participants') from model 'EventModel' doesn't match the TypeScript interfaces based on blank to optional agreement. Please check 'src/ts_backend_check/test_project/backend/models.py' and the corresponding files in 'ts_interface_paths' to make sure that all 'blank=True' fields are optional (?) in the TypeScript interfaces file. No matching TypeScript interface found for the model 'UserModel'. Please name your TypeScript interfaces the same as the corresponding backend models. You can also use the 'backend_to_ts_model_name_conversions' option within the configuration file. The key is the backend model name and the value is a list of the corresponding interfaces. This option is also how you can break larger backend models into multiple interfaces that extend one another. Please fix the 3 errors above to continue the sync of the backend models of src/ts_backend_check/test_project/backend/models.py and the corresponding TypeScript interfaces. `Back to top. <#top>`_ ============= Configuration ============= YAML File --------- You can configure ``ts-backend-check`` using the ``.ts-backend.check.yaml`` (or ``.yml``) configuration file. For an example, see the `configuration file for this repository `_ that we use in testing. This example describes the structure of an entry in this file: .. code-block:: yaml model_identifier: # an identifier you define that you want to pass to the CLI backend_model_path: path/to/a/models.py ts_interface_paths: - path/to/the/corresponding/model_interfaces.ts - path/to/another/corresponding/model_interfaces.ts check_blank_model_fields: true # whether to assert that fields that can be blank must also be optional backend_to_ts_model_name_conversions: # used if the frontend name is not the backend name BackendModel: - Interface - InterfaceExtended pre-commit ---------- This is an example of a `prek `_ or `pre-commit `_ hook: .. code-block:: yaml - repo: local hooks: - id: run-ts-backend-check name: run ts-backend-check key-value checks files: ^src-dir/ entry: uv run ts-backend-check -a language: python pass_filenames: false GitHub Action ------------- This is an example YAML file for a GitHub Action to check your backend models and TypeScript interface files on pull requests and commits: .. code-block:: yaml name: ci_ts_backend_check on: workflow_dispatch: pull_request: branches: - main types: - opened - reopened - synchronize push: branches: - main jobs: ts_backend_check: runs-on: ubuntu-latest steps: - name: Checkout Project uses: actions/checkout@v6 - name: Setup Python uses: actions/setup-python@v6 with: python-version: "3.12" - name: Install uv uses: astral-sh/setup-uv@v7 - name: Install Dependencies run: uv sync --frozen --all-groups - name: Execute All ts-backend-check Key-Value Checks run: | uv run ts-backend-check -a `Back to top. <#top>`_ ============ Contributing ============ See the `contribution guidelines `_ before contributing. You can help by: * 🐞 Reporting bugs. * ✨ Working with us on new features. * 📝 Improving the documentation. We track work that is in progress or may be implemented in the the `issues `_ and `projects `_. Contact the Team ---------------- .. image:: https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/MatrixLogoGrey.png :width: 175 :alt: Public Matrix Chat :target: https://matrix.to/#/#activist_community:matrix.org :align: right activist uses `Matrix `_ for team communication. `Join us in our public chat rooms `_ to share ideas, ask questions or just say hi to the team. We recommend using the `Element `_ client and `Element X `_ for a mobile app. Contributors ------------ Thanks to all our amazing `contributors `_! ❤️ .. image:: https://contrib.rocks/image?repo=activist-org/ts-backend-check :target: https://github.com/activist-org/ts-backend-check/graphs/contributors `Back to top. <#top>`_ Contents ======== .. toctree:: :maxdepth: 2 ts_backend_check/index Development =========== .. toctree:: :maxdepth: 2 notes Project Indices =============== * :ref:`genindex`