npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-arch-unit

v0.3.0

Published

Unit test your typescript architecture. Inspired by ArchUnit.

Downloads

10

Readme

ts-arch-unit

Unit test your typescript architecture. Inspired by ArchUnit.

Explore all available methods on https://amaro0.github.io/ts-arch-unit/.

Should work with any test runner.

Examples with mocha

describe('example tests', () => {
  it('command handlers should not depend on concrete classes', () => {
    classes()
      .that()
      .haveMatchingName(/CommandHandler/)
      .should()
      .not()
      .depend()
      .onAnyConcreteImplementation();
  });

  it('services directory should have propely named files', () => {
    files()
      .that()
      .resideInADirectory('services')
      .should()
      .haveMatchingName(/[A-Za-z]+Service.ts/);
  });

  it('controllers should not depend on repositories', () => {
    files()
      .that()
      .resideInADirectory('controllers')
      .should()
      .not()
      .dependOnFiles()
      .that()
      .resideInADirectory('repositories');
  });
});

Installation

npm install --save-dev ts-arch-unit

How to use

To use ts-arch-unit you have to place .tsarchunitrc config file in your project. Right now the only option is root describing folder of your ts source files

Example .tsarchunitrc file

{
  "root": "src"
}

How to write queries

There are few general rules that might help you write powerful queries without issues:

  • Query has to be started by selecting proper entity. Right now you can start query by using classes() or files().
  • Most query methods work in two modes, filter or assert mode. Filter mode is enabled by default just after starting query. Assert mode is toggled AFTER running .should(). That means you can write classes().that().haveMatchingName(/CommandHandler/).and().resideInDirectory('core') to select classes that will be asserted and then by appending .should().implementInterface('ICommand').and().haveMatchingMethod('handle').
  • After running .should() there is no possibility for entering filter mode in the same query. Write new query instead.
  • ALL methods are affected by .not() both in filter and assert mode. Negation is canceled after one method. That means you can write queries like:
    • classes().that().haveMatchingName(/Repository/).should().not().resideInADirectory('core');
    • classes().that().not().haveMatchingName(/Repository/).should().not().resideInADirectory('repositories');.
  • Right now only methods that are not working in assert mode are for exceptions excluding( e.g. excludedByMatchingName).

That's all. The rest is your imagination and endless chaining of available methods :>


API is not stable and might be changed in future releases.