tsarch

TSArch

An architecture unit test framework for Typescript

Usage

npm install --save-dev tsarch

import {TSArch} from 'tsarch'
import 'tsarch/jest/ArchMatchers'

describe('Architecture', () => {
  
  it('defines that all files in dog folder should be called ...Dog.ts', async () => {
    
    const project = await TSArch.parseTypescriptProject('./src')

    const rule = TSArch.defineThat()
      .files()
      .withPathMatching(/.*dog.*/)
      .should()
      .matchName(/.+.Dog\.ts($|\n)/)

        expect(project).toMatchArchRule(rule)

  })
  
})

NPM scripts

• npm t: Run test suite
• npm start: Run npm run build in watch mode
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run linting and generate coverage
• npm run build: Generate bundles and typings, create docs
• npm run lint: Lints code
• npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Resources

• Write a library using TypeScript library starter by @alexjoverm
• 📺 Create a TypeScript Library using typescript-library-starter by @alexjoverm
• Introducing TypeScript Library Starter Lite by @tonysneed

Credits

Typescript Library Starter

Made with :heart: by @alexjoverm and all these wonderful contributors (emoji key):

Ciro 💻 🔧	Marius Schulz 📖	Alexander Odell 📖	Ryan Ham 💻	Chi 💻 🔧 📖	Matt Mazzola 💻 🔧	Sergii Lischuk 💻
Steve Lee 🔧	Flavio Corpa 💻	Dom 🔧	Alex Coles 📖	David Khourshid 🔧	Aarón García Hervás 📖	Jonathan Hart 💻
Sanjiv Lobo 📖	Stefan Aleksovski 💻	dev.peerapong 💻	Aaron Groome 📖	Aaron Reisman 💻	kid-sk 📖	Andrea Gottardi 📖
Yogendra Sharma 📖	Rayan Salhab 💻

This project follows the all-contributors specification. Contributions of any kind are welcome!