An open API service indexing awesome lists of open source software.

https://github.com/edwinhern/ts-data-structures

A personal project to learn and implement various data structures in TypeScript by creating classes and writing test files to validate them.
https://github.com/edwinhern/ts-data-structures

data-structures learning prettier typescript vitest vitest-ts

Last synced: 9 months ago
JSON representation

A personal project to learn and implement various data structures in TypeScript by creating classes and writing test files to validate them.

Awesome Lists containing this project

README

          

# ๐Ÿ“š Data Structures in TypeScript

[![Check Style](https://github.com/edwinhern/ts-data-structures/actions/workflows/check-style.yml/badge.svg?branch=main)](https://github.com/edwinhern/ts-data-structures/actions/workflows/check-style.yml)
[![Test](https://github.com/edwinhern/ts-data-structures/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/edwinhern/ts-data-structures/actions/workflows/test.yml)

๐ŸŽ‰ Welcome to the documentation for the Data Structures in TypeScript project.

This project is my personal learning journey to implement various data structures in TypeScript by creating classes for each data structure and writing test files to validate them.

## โšก Tech Stack

Here's what powers this project:

- โš™๏ธ [TypeScript](https://www.typescriptlang.org/) - JavaScript with syntax for types.
- ๐Ÿงช [Vitest](https://vitest.dev/) - A Vite-native unit test framework.
- ๐ŸŽจ [Prettier](https://prettier.io/) - An opinionated code formatter.

## ๐ŸŒŸ Useful Links

Enhance your development workflow with these tools:

- ๐Ÿ“˜ [TypeScript Documentation](https://www.typescriptlang.org/docs/)
- ๐Ÿ“š [Vitest Documentation](https://vitest.dev/guide/)
- ๐Ÿ–Œ๏ธ [Prettier Documentation](https://prettier.io/docs/en/index.html)

## ๐Ÿ“œ Scripts

The following npm scripts are available:

- ๐Ÿงน `npm run clean`: Removes the coverage directory.
- ๐ŸŽจ `npm run format`: Formats the code using Prettier.
- ๐Ÿ” `npm run format:check`: Checks if the code is formatted according to Prettier rules.
- ๐Ÿงช `npm run test`: Runs all tests once using Vitest.
- ๐Ÿ•ต๏ธโ€โ™‚๏ธ `npm run test:dev`: Runs tests in watch mode for development using Vitest.
- ๐Ÿ“Š `npm run test:cov`: Runs tests with coverage report using Vitest.