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

eslint-plugin-clean-architecture

v0.1.0

Published

Enforce layering your code following Jason Taylor's Clean Architecture.

Downloads

9

Readme

eslint-plugin-clean-architecture

Enforce layering your code following Jason Taylor's Clean Architecture.

Taylor, J. 2020. Clean Architecture Diagram

There are four configurations available:

  • plugin:clean-architecture/strict
  • plugin:clean-architecture/strictWithNumbers
  • plugin:clean-architecture/loose
  • plugin:clean-architecture/looseWithNumbers

Strict configurations follow Jason Taylor's clean architecture exactly as he presented it.

Numbered configurations prefix each layer with "1-", "2-", etc. This helps organise the layers visually to match the way they are stacked logically.

Loose configurations allow the presentation layer to reference the infrastructure layer. This is handy for bootstrapping your dependencies, factories, etc.

Installation

npm i -D eslint-plugin-clean-architecture

Usage

// .eslintrc.js

module.exports = {
  extends: ["plugin:clean-architecture/strict"],
};

You will only be able to import code from layer X to layer Y if layer X depends on layer Y. Any other layer-to-layer import will yield a linting error.

For example:

// application/business-logic.js

import { apiMethod } from "../presentation/api";
// error: Do not import presentation code into the application layer

Folder structure

plugin:clean-architecture/strict

layered-code
| presentation
| infrastructure
| application
| domain

plugin:clean-architecture/strictWithNumbers

layered-code
| 1-presentation
| 1-infrastructure
| 2-application
| 3-domain

Note that the presentation layer is prefixed with "0-" for looseWithNumbers but "1-" for strictWithNumbers.

plugin:clean-architecture/loose

layered-code
| presentation
| infrastructure
| application
| domain

plugin:clean-architecture/looseWithNumbers

layered-code
| 0-presentation
| 1-infrastructure
| 2-application
| 3-domain

Note that the presentation layer is prefixed with "0-" for looseWithNumbers but "1-" for strictWithNumbers.

EslintPluginBuilder

This plugin is built on top of my eslint plugin builder for layered architectures. You can use that library to enforce lint rules for any layer names you like, in case you're not a fan of clean architecture.